The RUM application ID.
The client token for Datadog. Required for authenticating your application with Datadog.
OptionaldefaultAllow to protect end user privacy and prevent sensitive organizational information from being collected.
See Replay Privacy Options for further information.
OptionalenableEnables privacy control for action names.
OptionaltrackingSet the initial user tracking consent state. See User tracking consent for further information.
OptionalactionSpecify your own attribute to use to name actions.
See Declare a name for click actions for further information.
OptionalallowedA list of GraphQL endpoint URLs to track and enrich with GraphQL-specific metadata.
OptionalbeforeAccess to every event collected by the RUM SDK before they are sent to Datadog. It allows:
See Enrich And Control Browser RUM Data With beforeSend for further information.
The RUM event
The RUM event domain context providing access to native browser data based on the event type (e.g. error, performance entry).
true if the event should be sent to Datadog, false otherwise
OptionalenvThe application’s environment, for example: prod, pre-prod, and staging. Follows the tag syntax requirements.
OptionalserviceThe service name for your application. Follows the tag syntax requirements.
OptionalsessionThe percentage of sessions tracked. A value between 0 and 100.
OptionaltelemetryThe percentage of telemetry events sent. A value between 0 and 100.
OptionaltrackTrack anonymous user for the same site and extend cookie expiration date
OptionaltrackEnable the creation of dedicated views for pages restored from the Back-Forward cache.
OptionaltrackEnables early request collection before resource timing entries are available.
OptionaltrackEnables collection of features flags in additional events (e.g. long task, resource, action, vital).
OptionaltrackEnables collection of long task events.
OptionaltrackEnables collection of resource events.
OptionaltrackEnables automatic collection of users actions.
See Tracking User Actions for further information.
OptionaltrackAllows you to control RUM views creation. See Override default RUM view names for further information.
OptionalversionThe application’s version, for example: 1.2.3, 6c44da20, and 2020.02.13. Follows the tag syntax requirements.
OptionalsessionThe percentage of tracked sessions with Browser RUM & Session Replay pricing features: 100 for all, 0 for none.
See Configure Your Setup For Browser RUM and Browser RUM & Session Replay Sampling for further information.
OptionalstartIf the session is sampled for Session Replay, only start the recording when startSessionReplayRecording() is called, instead of at the beginning of the session. Default: if startSessionReplayRecording is 0, true; otherwise, false.
See Session Replay Usage for further information.
OptionalallowedA list of request URLs used to inject tracing headers. See Connect RUM and Traces for further information.
OptionalpropagateWhether to propagate user and account IDs in the baggage header of trace requests.
OptionaltraceIf you set a traceSampleRate, to ensure backend services' sampling decisions are still applied, configure the traceContextInjection initialization parameter to sampled.
See Connect RUM and Traces for further information.
OptionaltraceThe percentage of requests to trace: 100 for all, 0 for none. See Connect RUM and Traces for further information.
OptionalprofilingThe percentage of users profiled. A value between 0 and 100.
OptionalallowAllows the use of localStorage when cookies cannot be set. This enables the RUM Browser SDK to run in environments that do not provide cookie support.
Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values See Monitor Electron Applications Using the Browser SDK for further information.
OptionalsessionWhich storage strategy to use for persisting sessions. Can be either 'cookie' or 'local-storage'.
Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
OptionaltrackPreserve the session across subdomains for the same site.
Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
OptionaluseUse a partitioned secure cross-site session cookie. This allows the RUM Browser SDK to run when the site is loaded from another one (iframe). Implies useSecureSessionCookie.
Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
OptionaluseUse a secure session cookie. This disables RUM events sent on insecure (non-HTTPS) connections.
Important: If you are using the RUM and Logs Browser SDKs, this option must be configured with identical values
OptionalcompressCompress requests sent to the Datadog intake to reduce bandwidth usage when sending large amounts of data. The compression is done in a Worker thread. See Content Security Policy guidelines for further information.
OptionalproxyOptional proxy URL, for example: https://www.proxy.com/path. See Proxy Your Browser RUM Data for further information.
OptionalsiteThe Datadog site parameter of your organization.
OptionalworkerURL pointing to the Datadog Browser SDK Worker JavaScript file. The URL can be relative or absolute, but is required to have the same origin as the web application. See Content Security Policy guidelines for further information.
OptionalallowedList of origins where the SDK is allowed to run when used in a browser extension context. Matches urls against the extensions origin. If not provided and the SDK is running in a browser extension, the SDK will not run.
OptionalallowAllow listening to DOM events dispatched programmatically (untrusted events). Enabling this option can be useful if you heavily rely on programmatic events, such as in an automated UI test environment.
OptionalexcludedA list of request origins ignored when computing the page activity. See How page activity is calculated for further information.
OptionalpluginsList of plugins to enable. The plugins API is unstable and experimental, and may change without notice. Please use only plugins provided by Datadog matching the version of the SDK you are using.
OptionalsilentInitialization fails silently if the RUM Browser SDK is already initialized on the page.
OptionalstoreStore global context and user context in localStorage to preserve them along the user navigation. See Contexts life cycle for further information.
OptionalsubdomainIf you are accessing Datadog through a custom subdomain, you can set subdomain to include your custom domain in the getSessionReplayLink() returned URL .
See Connect Session Replay To Your Third-Party Tools for further information.
Init Configuration for the RUM browser SDK.
Example: NPM
Example: CDN