update advanced config

Author: ysyneu

flashduty/en/2. RUM/2. Applications/3. Advanced Configuration.md

@@ -1,26 +1,26 @@
 ---
 title: "RUM SDK Advanced Configuration"
-description: "This document details how to configure advanced features of the FlashCat RUM SDK."
+description: "This document provides detailed instructions on configuring advanced features of FlashCat RUM SDK."
 date: "2024-05-09T10:00:00+08:00"
 url: "https://docs.flashcat.cloud/en/flashduty/rum/advanced-configuration?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
 ---
 
 ## Overview
 
-FlashDuty Real User Monitoring (RUM) provides various advanced configuration options that allow you to modify the collected data and context according to your needs, supporting the following scenarios:
+FlashDuty Real User Monitoring (RUM) offers various advanced configuration options that allow you to modify collected data and context based on your requirements, supporting the following scenarios:
 
-- **Protect sensitive data**: Mask sensitive data such as personally identifiable information.
+- **Protect sensitive data**: Mask personally identifiable information and other sensitive data.
 - **Associate user sessions**: Link user sessions with internal user identifiers for support and troubleshooting.
-- **Reduce data volume**: Reduce RUM data collection through sampling to optimize costs.
-- **Enhance context**: Add richer context information to data beyond default attributes.
+- **Reduce data volume**: Lower RUM data collection through sampling to optimize costs.
+- **Enhance context**: Add richer contextual information to data beyond default attributes.
 
-The following sections detail how to implement these features.
+The following sections detail how to implement these capabilities.
 
 ## Override Default RUM View Names
 
 The FlashDuty RUM browser SDK automatically generates view events when users visit new pages or when URLs change in single-page applications (SPAs). View names are calculated from the current page URL by default and automatically remove variable IDs (path segments containing numbers). For example, `/dashboard/1234` and `/dashboard/9a` are normalized to `/dashboard/?`.
 
-You can manually track view events by setting the `trackViewsManually` option and specify custom names for views as well as associated services and versions.
+You can manually track view events by setting the `trackViewsManually` option and specify custom names for views along with their associated services and versions.
 
 ### Configure Manual View Tracking
 
@@ -37,7 +37,7 @@ flashcatRum.init({
 });
 ```
 
-After enabling manual tracking, you need to call the `startView` method for each new page or route change (for single-page applications) to start a view. RUM data will begin collecting when the view starts. You can add context to the view and its child events.
+After enabling manual tracking, you need to call the `startView` method on each new page or route change (for single-page applications) to start a view. RUM data will begin collecting when the view starts. You can add context to the view and its child events.
 
 #### Parameter Description
 
@@ -63,10 +63,10 @@ flashcatRum.startView({
 
 ### React Router Integration
 
-For applications using React Router v6, you can override default view names to match route names defined in your React application with these steps:
+For applications using React Router v6, you can override default view names to match route names defined in your React application through the following steps:
 
-1. Set `trackViewsManually` to `true` during initialization (as above).
-2. Start views when routes change using the `useLocation` and `matchRoutes` APIs from `react-router-dom`.
+1. Set `trackViewsManually` to `true` during initialization (as shown above).
+2. Start views on route changes using the `useLocation` and `matchRoutes` APIs from `react-router-dom`.
 
 Here's an example:
 
@@ -119,9 +119,9 @@ flashcatRum.setViewName("Checkout");
 
 ## Enrich and Control RUM Data
 
-The FlashDuty RUM browser SDK automatically captures RUM events and populates their main properties. With the `beforeSend` callback function, you can intercept and modify events before they are sent to FlashDuty, supporting the following operations:
+The FlashDuty RUM browser SDK automatically captures RUM events and populates their main attributes. Through the `beforeSend` callback function, you can intercept and modify events before they are sent to FlashDuty, supporting the following operations:
 
-- **Enrich events**: Add additional context properties.
+- **Enrich events**: Add additional context attributes.
 - **Modify events**: Change event content or mask sensitive information.
 - **Discard events**: Selectively discard specific RUM events.
 
@@ -144,7 +144,7 @@ Different event types correspond to different contexts:
 
 ### Enrich RUM Events
 
-You can add context properties to events through the `beforeSend` callback. For example, add data from response headers to resource events:
+You can add context attributes to events through the `beforeSend` callback. For example, adding data from response headers to resource events:
 
 ```javascript
 flashcatRum.init({
@@ -162,7 +162,7 @@ flashcatRum.init({
 });
 ```
 
-You can also add properties to events through the global context API. Note: Only properties in `event.context` will be recognized by the RUM SDK.
+You can also add attributes to events through the global context API. Note: Only attributes in `event.context` will be recognized by the RUM SDK.
 
 ### Modify RUM Event Content
 
@@ -179,26 +179,26 @@ flashcatRum.init({
 });
 ```
 
-#### Modifiable Properties
+#### Modifiable Attributes
 
-The following properties can be modified through `beforeSend`:
+The following attributes can be modified through `beforeSend`:
 
 - **view.url** (string): Current page URL.
 - **view.referrer** (string): Previous page URL.
 - **view.name** (string): Current view name.
 - **view.performance.lcp.resource_url** (string): Resource URL for Largest Contentful Paint (LCP).
-- **service** (string): Service name of the application.
+- **service** (string): Application service name.
 - **version** (string): Application version.
-- **action.target.name** (string): Element involved in user interaction (only for automatically collected actions).
+- **action.target.name** (string): Element involved in user interaction (for automatically collected actions only).
 - **error.message** (string): Error message.
 - **error.stack** (string): Error stack or supplementary information.
 - **error.resource.url** (string): Resource URL that triggered the error.
 - **resource.url** (string): Resource URL.
 - **long_task.scripts.source_url** (string): Script resource URL for long tasks.
 - **long_task.scripts.invoker** (string): Name of the invoking script.
-- **context** (object): Properties added through global context API, view context API, or manually generated events (such as `addError`, `addAction`).
+- **context** (object): Attributes added through global context API, view context API, or manually generated events (such as `addError`, `addAction`).
 
-Modifications to other properties will be ignored.
+Modifications to other attributes will be ignored.
 
 ### Discard RUM Events
 
@@ -221,13 +221,13 @@ flashcatRum.init({
 
 By adding user information to RUM sessions, you can:
 
-- Track specific users' browsing paths.
+- Track browsing paths of specific users.
 - Understand which users are most affected by errors.
 - Monitor performance for key users.
 
 ### User Attributes
 
-The following are optional user attributes, but it is recommended to provide at least one:
+The following are optional user attributes, with at least one recommended:
 
 - **usr.id** (string): Unique user identifier.
 - **usr.name** (string): User-friendly name, displayed by default in the RUM UI.
@@ -254,13 +254,13 @@ flashcatRum.setUser({
 const user = flashcatRum.getUser();
 ```
 
-#### Add/Override User Properties
+#### Add/Override User Attributes
 
 ```javascript
 flashcatRum.setUserProperty("name", "John Doe");
 ```
 
-#### Remove User Properties
+#### Remove User Attributes
 
 ```javascript
 flashcatRum.removeUserProperty("name");
@@ -274,7 +274,7 @@ flashcatRum.clearUser();
 
 **Note**:
 
-- After user session information is changed, subsequent RUM events will include the updated information.
+- After user session information changes, subsequent RUM events will include the updated information.
 - After logout (calling `clearUser`), the last view will still retain user information, but subsequent views and session-level data will not.
 
 ## Sampling
@@ -290,7 +290,7 @@ flashcatRum.init({
 });
 ```
 
-Sampled-out sessions will not collect any page views or their related telemetry data.
+Sampled sessions will not collect any page views and their related telemetry data.
 
 ## User Tracking Consent
 
@@ -302,7 +302,7 @@ To comply with privacy regulations such as GDPR and CCPA, FlashDuty RUM allows s
 You can change the consent status after initialization using the `setTrackingConsent` API:
 
 - Changing from `"granted"` to `"not-granted"`: Stops the RUM session, and data is no longer sent.
-- Changing from `"not-granted"` to `"granted"`: If there is no active session, a new session is created and data collection resumes.
+- Changing from `"not-granted"` to `"granted"`: If there is no active session, a new session will be created and data collection resumes.
 
 **Note**: Consent status is not synchronized between tabs or persisted; you need to provide the user's decision during initialization or through `setTrackingConsent`.
 
@@ -348,7 +348,7 @@ flashcatRum.setViewContext({
 
 ## Error Context
 
-When capturing errors, you can attach local context to error objects through the `dd_context` property, and the RUM SDK will automatically merge it into the final error event context.
+When capturing errors, you can attach local context to error objects through the `dd_context` attribute, and the RUM SDK will automatically merge it into the final error event context.
 
 ```javascript
 const error = new Error("Something went wrong");
@@ -360,37 +360,37 @@ throw error;
 
 Global context is attached to all RUM events and supports the following operations:
 
-- **Add Global Context Property**:
+- **Add global context attribute**:
   ```javascript
   flashcatRum.setGlobalContextProperty("activity", {
     hasPaid: true,
     amount: 23.42,
   });
   ```
-- **Remove Global Context Property**:
+- **Remove global context attribute**:
   ```javascript
   flashcatRum.removeGlobalContextProperty("codeVersion");
   ```
-- **Replace Global Context**:
+- **Replace global context**:
   ```javascript
   flashcatRum.setGlobalContext({
     codeVersion: 34,
   });
   ```
-- **Clear Global Context**:
+- **Clear global context**:
   ```javascript
   flashcatRum.clearGlobalContext();
   ```
-- **Read Global Context**:
+- **Read global context**:
   ```javascript
   const context = flashcatRum.getGlobalContext();
   ```
 
 ### Context Lifecycle
 
-By default, global context and user context are stored in the current page's memory, meaning:
+By default, global context and user context are stored in the current page memory, therefore:
 
-- They are not retained after a full page refresh.
+- They are not retained after a complete page refresh.
 - They are not shared between different tabs or windows.
 
 Enabling the `storeContextsAcrossPages` option stores context in `localStorage`, supporting:
@@ -413,15 +413,15 @@ flashcatRum.init({
 
 - It is not recommended to store personally identifiable information in context, as `localStorage` data exceeds the user session lifecycle.
 - Not compatible with the `trackSessionAcrossSubdomains` option, as `localStorage` is only shared within the same domain.
-- `localStorage` capacity is limited to 5 MiB, so ensure that the total of application data, FlashDuty context, and other third-party data is within this range.
+- `localStorage` capacity is limited to 5 MiB, so ensure that the total of application data, FlashDuty context, and other third-party data remains within this range.
 
 ## Micro-frontend Support
 
-FlashDuty RUM supports micro-frontend architecture by identifying event sources through the stacktrace mechanism. You need to extract `service` and `version` properties from application file paths and filenames.
+FlashDuty RUM supports micro-frontend architecture by identifying event sources through stacktrace mechanism. You need to extract `service` and `version` attributes from application file paths and filenames.
 
 ### Usage
 
-Override `service` and `version` properties in `beforeSend` based on stack information:
+Override `service` and `version` attributes in `beforeSend` based on stack information:
 
 ```javascript
 const SERVICE_REGEX = /some-pathname\/(?<service>\w+)\/(?<version>\w+)\//;
@@ -444,7 +444,7 @@ flashcatRum.init({
 });
 ```
 
-In the RUM browser, you can filter events using the `service` property.
+In the RUM browser, you can filter events using the `service` attribute.
 
 ### Limitations
 
@@ -455,36 +455,36 @@ The following events cannot be attributed to specific sources and therefore do n
 - View events (can be resolved by overriding view names).
 - CORS and CSP violation events.
 
-## Connect RUM and Traces
+## Integrate RUM with Distributed Tracing
 
-The APM integration with Real User Monitoring allows you to link requests from your web and mobile applications to their corresponding backend traces. This combination enables you to see your full frontend and backend data through one lens.
+Integrating RUM with distributed tracing allows you to correlate requests from your web and mobile applications with their corresponding backend traces. This combination enables you to view complete frontend and backend data at a glance.
 
-Use frontend data from RUM, as well as backend, infrastructure, and log information from trace ID injection to pinpoint issues anywhere in your stack and understand what your users are experiencing.
+Use frontend data from RUM along with backend, infrastructure, and log information from trace ID injection to identify issues anywhere in your stack and understand user experience.
 
 ### Usage
 
-Initialize the RUM SDK. Configure the `allowedTracingUrls` initialization parameter with the list of internal, first-party origins called by your browser application.
+Initialize the RUM SDK. Configure the `allowedTracingUrls` initialization parameter with the list of internal first-party origins called by your browser application.
 
 ```javascript
 import { flashcatRum } from "@flashcatcloud/browser-rum";
 
 flashcatRum.init({
   applicationId: "<YOUR_APPLICATION_ID>", // Get from application management page
   clientToken: "<YOUR_CLIENT_TOKEN>", // Get from application management page
-  service: "<SERVICE_NAME>", // Service name to distinguish different services
+  service: "<SERVICE_NAME>", // Service name for distinguishing different services
   env: "<ENV_NAME>", // Environment identifier
   version: "1.0.0", // Application version
   sessionSampleRate: 100, // Sampling rate
-  allowedTracingUrls: ["https://api.example.com", /https:\/\/.*\.my-api-domain\.com/, (url) => url.startsWith("https://api.example.com")], // A list of request URLs used to inject tracing headers.
-  traceSampleRate: 20 // Optional，The percentage of requests to trace: 100 for all, 0 for none. Default value: 100
+  allowedTracingUrls: ["https://api.example.com", /https:\/\/.*\.my-api-domain\.com/, (url) => url.startsWith("https://api.example.com")], // List of URLs that need to be tracked
+  traceSampleRate: 20 // Optional parameter, percentage of requests to trace: 100 for all, 0 for none. Default value: 100
 });
 ```
 
-allowedTracingUrls matches the full URL (`<scheme>://<host>[:<port>]/<path>[?<query>][#<fragment>]`). It accepts the following types:
+allowedTracingUrls matches the complete URL (`<scheme>://<host>[:<port>]/<path>[?<query>][#<fragment>]`). It accepts the following types:
 
-- **String:** matches any URL that starts with the value, so `https://api.example.com` matches `https://api.example.com/v1/resource`.
-- **RegExp:** executes a test with the provided RegExp and the URL.
-- **Function:** evaluates with the URL as parameter. Returning a boolean set to true indicates a match.
+- **String:** Matches any URL that starts with this value, for example `https://api.example.com ` matches `https://api.example.com/v1/resource`.
+- **RegExp:** Uses the regex test() method to check if the URL matches.
+- **Function:** Accepts the URL as a parameter and executes the callback function, returning `true` indicates a successful URL match.
 
 ## Considerations
 
@@ -494,4 +494,4 @@ allowedTracingUrls matches the full URL (`<scheme>://<host>[:<port>]/<path>[?<qu
 
 ## More Information
 
-For more detailed information about FlashDuty RUM, visit [FlashDuty SDK](https://github.com/flashcatcloud/browser-sdk).
+For more detailed information about FlashDuty RUM, please visit [FlashDuty SDK](https://github.com/flashcatcloud/browser-sdk).