[rum] Inject browser sdk #119
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # RUM Plugin <!-- #omit in toc --> | ||
|
|
||
| Interact with Real User Monitoring (RUM) directly from your build system. | ||
|
|
||
| <!-- The title and the following line will both be added to the root README.md --> | ||
|
|
||
| ## Table of content <!-- #omit in toc --> | ||
|
|
||
| <!-- This is auto generated with yarn cli integrity --> | ||
|
|
||
| <!-- #toc --> | ||
| - [Configuration](#configuration) | ||
| - [Browser SDK Injection](#browser-sdk-injection) | ||
| - [rum.sdk.applicationId](#rumsdkapplicationid) | ||
| - [rum.sdk.clientToken](#rumsdkclienttoken) | ||
| <!-- #toc --> | ||
|
|
||
| ## Configuration | ||
|
|
||
| <details> | ||
| <summary>Full configuration</summary> | ||
|
|
||
| ```ts | ||
| rum?: { | ||
| disabled?: boolean; | ||
| sdk?: { | ||
| actionNameAttribute?: string; | ||
| allowedTracingUrls?: string[]; | ||
| allowUntrustedEvents?: boolean; | ||
| applicationId: string; | ||
| clientToken?: string; | ||
| compressIntakeRequests?: boolean; | ||
| defaultPrivacyLevel?: 'mask' | 'mask-user-input' | 'allow'; | ||
| enablePrivacyForActionName?: boolean; | ||
| env?: string; | ||
| excludedActivityUrls?: string[]; | ||
| proxy?: string; | ||
| service?: string; | ||
| sessionReplaySampleRate?: number; | ||
| sessionSampleRate?: number; | ||
| silentMultipleInit?: boolean; | ||
| site?: string; | ||
| startSessionReplayRecordingManually?: boolean; | ||
| storeContextsAcrossPages?: boolean; | ||
| telemetrySampleRate?: number; | ||
| traceSampleRate?: number; | ||
| trackingConsent?: 'granted' | 'not_granted'; | ||
| trackLongTasks?: boolean; | ||
| trackResources?: boolean; | ||
| trackUserInteractions?: boolean; | ||
| trackViewsManually?: boolean; | ||
| version?: string; | ||
| workerUrl?: string; | ||
| }; | ||
| } | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
||
| **Minimal configuration**: | ||
|
|
||
| ```ts | ||
| rum: { | ||
| sdk: { | ||
| applicationId: 'your_application_id', | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Browser SDK Injection | ||
|
|
||
| Automatically inject the RUM SDK into your application. | ||
|
|
||
| Full documentation can be found in the [Datadog documentation](https://docs.datadoghq.com/real_user_monitoring/browser/setup/client?tab=rum#configuration). | ||
|
|
||
| ### rum.sdk.applicationId | ||
|
|
||
| > required | ||
|
|
||
| The RUM application ID. [Create a new application if necessary](https://app.datadoghq.com/rum/list/create). | ||
|
|
||
| ### rum.sdk.clientToken | ||
|
|
||
| > optional, will be fetched if missing | ||
|
|
||
| A [Datadog client token](https://docs.datadoghq.com/account_management/api-app-keys/#client-tokens). | ||
|
|
||
| > [!NOTE] | ||
| > If not provided, the plugin will attempt to fetch the client token using the API. | ||
| > You need to provide both `auth.apiKey` and `auth.appKey` with the `rum_apps_read` permission. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| { | ||
| "name": "@dd/rum-plugin", | ||
| "packageManager": "[email protected]", | ||
| "license": "MIT", | ||
| "private": true, | ||
| "author": "Datadog", | ||
| "description": "Interact with Real User Monitoring (RUM) directly from your build system.", | ||
| "homepage": "https://github.com/DataDog/build-plugins/tree/main/packages/plugins/rum#readme", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/DataDog/build-plugins", | ||
| "directory": "packages/plugins/rum" | ||
| }, | ||
| "main": "./src/index.ts", | ||
| "toBuild": { | ||
| "rum-browser-sdk": { | ||
| "entry": "./src/built/rum-browser-sdk.ts" | ||
| } | ||
| }, | ||
| "exports": { | ||
| ".": "./src/index.ts", | ||
| "./*": "./src/*.ts" | ||
| }, | ||
| "scripts": { | ||
| "typecheck": "tsc --noEmit" | ||
| }, | ||
| "dependencies": { | ||
| "@dd/core": "workspace:*", | ||
| "chalk": "2.3.1" | ||
| }, | ||
| "devDependencies": { | ||
| "@datadog/browser-rum": "6.0.0" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // Unless explicitly stated otherwise all files in this repository are licensed under the MIT License. | ||
| // This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| // Copyright 2019-Present Datadog, Inc. | ||
|
|
||
| /* global globalThis */ | ||
|
|
||
| import { datadogRum } from '@datadog/browser-rum'; | ||
Ayc0 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // To please TypeScript. | ||
|
|
||
| const globalAny: any = globalThis; | ||
|
|
||
| // Also them to the global DD_RUM object. | ||
| globalAny.DD_RUM = datadogRum; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| // Unless explicitly stated otherwise all files in this repository are licensed under the MIT License. | ||
| // This product includes software developed at Datadog (https://www.datadoghq.com/). | ||
| // Copyright 2019-Present Datadog, Inc. | ||
|
|
||
| import type { PluginName } from '@dd/core/types'; | ||
|
|
||
| export const CONFIG_KEY = 'rum' as const; | ||
| export const PLUGIN_NAME: PluginName = 'datadog-rum-plugin' as const; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few of these options were removed from the browser sdk config in v6. I guess this works still as it will work for v5 and prior and just do nothing for v6+ but just a heads up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you know which ones? Because they all are still in the doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah you're right, they're still there. They just default to
trueso we removed them from the default config. You can keep them!