Update Remote Logging README to document the detailed filters usage (#51010)

* Update remote logging package readme

* Add changelog

* Update readme

* Update packages/js/remote-logging/README.md

Co-authored-by: Ilyas Foo <foo.ilyas@gmail.com>

* Update readme

---------

Co-authored-by: Ilyas Foo <foo.ilyas@gmail.com>

packages/js/remote-logging/README.md

@@ -2,6 +2,12 @@
 
 A remote logging package for Automattic based projects. This package provides error tracking and logging capabilities, with support for rate limiting, stack trace formatting, and customizable error filtering.
 
+## Installation
+
+```bash
+npm install @woocommerce/remote-logging --save
+```
+
 ## Description
 
 The WooCommerce Remote Logging package offers the following features:
@@ -44,16 +50,42 @@ The WooCommerce Remote Logging package offers the following features:
     }
     ```
 
+## Remote Logging Conditions
+
+Remote logging is subject to the following conditions:
+
+1. **Remote Logging Enabled**: The package checks `window.wcSettings.isRemoteLoggingEnabled` to determine if the feature should be enabled. The value is set via PHP and passed to JS as a boolean. It requires tracks to be enabled and a few other conditions internally. Please see the [RemoteLogger.php](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/Internal/Logging/RemoteLogger.php) for more details.
+
+2. **Non-Development Environment**: It also checks `process.env.NODE_ENV` to ensure logging only occurs in non-development environments.
+
+If either of these conditions are not met (Tracks is not enabled or the environment is development), no logs will be transmitted to the remote server.
+
+## API Reference
+
+- `init(config: RemoteLoggerConfig): void`: Initializes the remote logger with the given configuration.
+- `log(severity: LogSeverity, message: string, extraData?: object): Promise<boolean>`: Logs a message with the specified severity and optional extra data.
+- `captureException(error: Error, extraData?: object): void`: Captures an error and sends it to the remote API.
+
+For more detailed information about types and interfaces, refer to the source code and inline documentation.
+
 ## Customization
 
-You can customize the behavior of the remote logger using WordPress filters:
 
-- `woocommerce_remote_logging_should_send_error`: Control whether an error should be sent to the remote API.
+You can customize the behavior of the remote logger using WordPress filters. Here are the available filters:
-- `woocommerce_remote_logging_error_data`: Modify the error data before sending it to the remote API.
-- `woocommerce_remote_logging_log_endpoint`: Customize the endpoint URL for sending log messages.
-- `woocommerce_remote_logging_js_error_endpoint`: Customize the endpoint URL for sending JavaScript errors.
 
-### Example
+### `woocommerce_remote_logging_should_send_error`
+
+Control whether an error should be sent to the remote API.
+
+**Parameters:**
+
+- `shouldSend` (boolean): The default decision on whether to send the error.
+- `error` (Error): The error object.
+- `stackFrames` (Array): An array of stack frames from the error.
+
+**Return value:** (boolean) Whether the error should be sent.
+
+**Usage example:**
 
 ```js
 import { addFilter } from '@wordpress/hooks';
@@ -63,19 +95,80 @@ addFilter(
   'my-plugin',
   (shouldSend, error, stackFrames) => {
     const containsPluginFrame = stackFrames.some(
-			( frame ) =>
+      (frame) => frame.url && frame.url.includes( /YOUR_PLUGIN_ASSET_PATH/ )
-				frame.url && frame.url.includes( '/my-plugin/' );
     );
-    // Custom logic to determine if the error should be sent
+    // Only send errors that originate from our plugin
     return shouldSend && containsPluginFrame;
   }
 );
 ```
 
-### API Reference
+### `woocommerce_remote_logging_error_data`
 
-- `init(config: RemoteLoggerConfig): void`: Initializes the remote logger with the given configuration.
+Modify the error data before sending it to the remote API.
-- `log(severity: LogSeverity, message: string, extraData?: object): Promise<boolean>`: Logs a message with the specified severity and optional extra data.
-- `captureException(error: Error, extraData?: object): void`: Captures an error and sends it to the remote API.
 
-For more detailed information about types and interfaces, refer to the source code and inline documentation.
+**Parameters:**
+
+- `errorData` (ErrorData): The error data object to be sent.
+
+**Return value:** (ErrorData) The modified error data object.
+
+**Usage example:**
+
+```js
+import { addFilter } from '@wordpress/hooks';
+
+addFilter(
+  'woocommerce_remote_logging_error_data',
+  'my-plugin',
+  (errorData) => {
+    // Custom logic to modify error data
+    errorData.tags = [ ...errorData.tags, 'my-plugin' ];
+    return errorData;
+  }
+);
+```
+
+### `woocommerce_remote_logging_log_endpoint`
+
+Modify the URL of the remote logging API endpoint.
+
+**Parameters:**
+
+- `endpoint` (string): The default endpoint URL.
+
+**Return value:** (string) The modified endpoint URL.
+
+**Usage example:**
+
+```js
+import { addFilter } from '@wordpress/hooks';
+
+addFilter(
+  'woocommerce_remote_logging_log_endpoint',
+  'my-plugin',
+  (endpoint) => 'https://my-custom-endpoint.com/log'
+);
+```
+
+### `woocommerce_remote_logging_js_error_endpoint`
+
+Modify the URL of the remote logging API endpoint for JavaScript errors.
+
+**Parameters:**
+
+- `endpoint` (string): The default endpoint URL for JavaScript errors.
+
+**Return value:** (string) The modified endpoint URL for JavaScript errors.
+
+**Usage example:**
+
+```js
+import { addFilter } from '@wordpress/hooks';
+
+addFilter(
+  'woocommerce_remote_logging_js_error_endpoint',
+  'my-plugin',
+  (endpoint) => 'https://my-custom-endpoint.com/js-error-log'
+);
+```

packages/js/remote-logging/changelog/update-remote-logging-readme

@@ -0,0 +1,4 @@
+Significance: patch
+Type: update
+
+Update README.md to document the filters specs & usage