Skip to content

Commit bd9bbd9

Browse files
Fiona2016Fiona2016
committed
feat: 1. update images 2. add english version
1 parent eb5bc5f commit bd9bbd9

10 files changed

Lines changed: 326 additions & 32 deletions

File tree

‎flashduty/en/2. RUM/2. Applications/2. SDK Integration.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -108,35 +108,35 @@ Add the following code snippet to the beginning of the `head` tag in each `HTML`
108108

109109
You can check for loading issues with `window.FC_RUM` if the RUM browser SDK fails to load.
110110

111-
112-
113-
114111
## Initialization Parameters
115112

116-
| Configuration | Type | Required | Description |
117-
| -------------------------- | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
118-
| applicationId | String | Yes | Application ID, obtained from the application management page |
119-
| clientToken | String | Yes | Client Token, obtained from the application management page |
120-
| service | String | Yes | Service name, used to distinguish different services |
121-
| env | String | No | Environment identifier, such as production, staging, etc. |
122-
| version | String | No | Application version |
123-
| trackingConsent | "granted" \| "not-granted" | No | Set initial user tracking consent status. See user tracking consent. Default: `granted` |
124-
| trackViewsManually | Boolean | No | Allows you to control RUM view creation. See override default RUM view names. Default: `false` |
125-
| trackUserInteractions | Boolean | No | Enable automatic collection of user actions. Default: `true` |
126-
| trackResources | Boolean | No | Enable collection of resource events. Default: `true` |
127-
| trackLongTasks | Boolean | No | Enable collection of long task events. Default: `true` |
128-
| trackAnonymousUser | Boolean | No | Enable cross-session collection of anonymous user IDs. Default: `true` |
129-
| enablePrivacyForActionName | Boolean | No | See mask action names. Default: `false` |
130-
| actionNameAttribute | String | No | Specify your own attribute to use for naming actions. Default: `false` |
131-
| sessionSampleRate | Number | No | Percentage of sessions to track: 100 for all, 0 for none. Only tracked sessions send RUM events. Default: `100` |
132-
| silentMultipleInit | Boolean | No | If the RUM browser SDK is already initialized on the page, initialization will silently fail. Default: `false` |
133-
| proxy | String | No | Optional proxy URL, for example: `https://www.proxy.com/path` |
134-
| allowedTracingUrls | Array | No | List of request URLs for injecting tracing headers. For more information, see [Connect RUM and Traces](https://docs.flashcat.cloud/en/flashduty/rum/sdk-integration#Connect%20RUM%20and%20Traces) |
135-
| traceSampleRate | Number | No | Percentage of requests to trace: 100 for all, 0 for none. Default: `100` |
136-
| excludedActivityUrls | Array | No | List of request origins to ignore when calculating page activity |
137-
| compressIntakeRequests | Boolean | No | Compress requests sent to the FlashDuty intake to reduce bandwidth usage when sending large amounts of data. Compression is done in a Worker thread. Default: `false` |
138-
| storeContextsAcrossPages | Boolean | No | Store global context and user context in localStorage to preserve them across user navigation. Default: `false` |
139-
| allowUntrustedEvents | Boolean | No | Allow capturing [untrusted events][https://developer.mozilla.org/en-US/docs/Web/API/Event/isTrusted], for example in automated UI tests. Default: `false` |
113+
| Configuration | Type | Required | Description |
114+
| ----------------------------------- | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
115+
| applicationId | String | Yes | Application ID, obtained from the application management page |
116+
| clientToken | String | Yes | Client Token, obtained from the application management page |
117+
| service | String | Yes | Service name, used to distinguish different services |
118+
| env | String | No | Environment identifier, such as production, staging, etc. |
119+
| version | String | No | Application version |
120+
| trackingConsent | "granted" \| "not-granted" | No | Set initial user tracking consent status. See user tracking consent. Default: `granted` |
121+
| trackViewsManually | Boolean | No | Allows you to control RUM view creation. See override default RUM view names. Default: `false` |
122+
| trackUserInteractions | Boolean | No | Enable automatic collection of user actions. Default: `true` |
123+
| trackResources | Boolean | No | Enable collection of resource events. Default: `true` |
124+
| trackLongTasks | Boolean | No | Enable collection of long task events. Default: `true` |
125+
| trackAnonymousUser | Boolean | No | Enable cross-session collection of anonymous user IDs. Default: `true` |
126+
| enablePrivacyForActionName | Boolean | No | See mask action names. Default: `false` |
127+
| actionNameAttribute | String | No | Specify your own attribute to use for naming actions. Default: `false` |
128+
| sessionSampleRate | Number | No | Percentage of sessions to track: 100 for all, 0 for none. Only tracked sessions send RUM events. Default: `100` |
129+
| sessionReplaySampleRate | Number | No | Percentage of tracked sessions to enable [session replay](https://docs.flashcat.cloud/en/flashduty/rum/session-replay) functionality: 100 for all, 0 for none. Default: `0` |
130+
| sessionReplayPrivacyLevel | String | No | Privacy policy for session replay data collection. 'allow' collects all data except passwords, 'mask-user-input' hides user input field content, 'mask-all' hides all text information. Default: `'mask-user-input'` |
131+
| startSessionReplayRecordingManually | Boolean | No | Whether to manually enable session replay recording switch |
132+
| silentMultipleInit | Boolean | No | If the RUM browser SDK is already initialized on the page, initialization will silently fail. Default: `false` |
133+
| proxy | String | No | Optional proxy URL, for example: `https://www.proxy.com/path` |
134+
| allowedTracingUrls | Array | No | List of request URLs for injecting tracing headers. For more information, see [Connect RUM and Traces](https://docs.flashcat.cloud/en/flashduty/rum/advanced-configuration#connect-rum-and-distributed-tracing) |
135+
| traceSampleRate | Number | No | Percentage of requests to trace: 100 for all, 0 for none. Default: `100` |
136+
| excludedActivityUrls | Array | No | List of request origins to ignore when calculating page activity |
137+
| compressIntakeRequests | Boolean | No | Compress requests sent to the FlashDuty intake to reduce bandwidth usage when sending large amounts of data. Compression is done in a Worker thread. Default: `false` |
138+
| storeContextsAcrossPages | Boolean | No | Store global context and user context in localStorage to preserve them across user navigation. Default: `false` |
139+
| allowUntrustedEvents | Boolean | No | Allow capturing [untrusted events](https://developer.mozilla.org/en-US/docs/Web/API/Event/isTrusted), for example in automated UI tests. Default: `false` |
140140

141141
## Use Cases
142142

@@ -209,4 +209,4 @@ After integration, you can validate whether the integration was successful throu
209209

210210
- [RUM Application Management](https://docs.flashcat.cloud/en/flashduty/rum/application-management?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): Learn how to create and manage RUM applications
211211
- [RUM SDK Advanced Configuration](https://docs.flashcat.cloud/en/flashduty/rum/advanced-configuration?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): Learn how to configure advanced features of the SDK
212-
- [RUM Analysis Dashboard](https://docs.flashcat.cloud/en/flashduty/rum/analysis-dashboard?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): View and analyze RUM data
212+
- [RUM Analysis Dashboard](https://docs.flashcat.cloud/en/flashduty/rum/analysis-dashboard?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): View and analyze RUM data

0 commit comments

Comments
 (0)