Datadog Real User Monitoring (RUM) enables you to visualize and analyze the real-time performance and user journeys of your application’s individual users.
The RUM Browser SDK supports all modern desktop and mobile browsers including IE11. For more information, see the Browser Support table.
To set up RUM Browser Monitoring:
clientToken and an applicationId for your application.Until Datadog starts to receive data, your application appears as “pending” on the RUM Applications page.
Add @datadog/browser-rum to your package.json file, then initialize it with:
import { datadogRum } from '@datadog/browser-rum'
datadogRum.init({
applicationId: '<DATADOG_APPLICATION_ID>',
clientToken: '<DATADOG_CLIENT_TOKEN>',
site: '<DATADOG_SITE>',
// service: 'my-web-application',
// env: 'production',
// version: '1.0.0',
sampleRate: 100,
premiumSampleRate: 100, // if not included - default 100
trackInteractions: true,
})
The trackInteractions parameter enables the automatic collection of user clicks in your application. Sensitive and private data contained on your pages may be included to identify the elements interacted with.
Add the generated code snippet to the head tag of every HTML page you want to monitor in your application.
<script>
(function(h,o,u,n,d) {
h=h[d]=h[d]||{q:[],onReady:function(c){h.q.push(c)}}
d=o.createElement(u);d.async=1;d.src=n
n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
})(window,document,'script','https://www.datadoghq-browser-agent.com/datadog-rum-v4.js','DD_RUM')
DD_RUM.onReady(function() {
DD_RUM.init({
clientToken: '<CLIENT_TOKEN>',
applicationId: '<APPLICATION_ID>',
site: '<DATADOG_SITE>',
// service: 'my-web-application',
// env: 'production',
// version: '1.0.0',
sampleRate: 100,
premiumSampleRate: 100, // if not included - default 100
trackInteractions: true,
})
})
</script>
The trackInteractions parameter enables the automatic collection of user clicks in your application. Sensitive and private data contained on your pages may be included to identify the elements interacted with.
Early RUM API calls must be wrapped in the DD_RUM.onReady() callback. This ensures the code only gets executed once the SDK is properly loaded.
Add the generated code snippet to the head tag (in front of any other script tags) of every HTML page you want to monitor in your application. Including the script tag higher and synchronized ensures Datadog RUM can collect all performance data and errors.
<script src="https://www.datadoghq-browser-agent.com/datadog-rum-v4.js" type="text/javascript"></script>
<script>
window.DD_RUM &&
window.DD_RUM.init({
clientToken: '<CLIENT_TOKEN>',
applicationId: '<APPLICATION_ID>',
site: '<DATADOG_SITE>',
// service: 'my-web-application',
// env: 'production',
// version: '1.0.0',
sampleRate: 100,
premiumSampleRate: 100, // if not included - default 100
trackInteractions: true,
})
</script>
The trackInteractions parameter enables the automatic collection of user clicks in your application. Sensitive and private data contained on your pages may be included to identify the elements interacted with.
The window.DD_RUM check is used to prevent issues if a loading failure occurs with the RUM Browser SDK.
Types are compatible with TypeScript >= 3.8.2. For earlier versions, import JS sources and use global variables to avoid any compilation issues:
import '@datadog/browser-rum/bundle/datadog-rum'
window.DD_RUM.init({
applicationId: 'XXX',
clientToken: 'XXX',
site: 'datadoghq.com',
sampleRate: 100,
})
The following parameters are available:
applicationIdclientTokensitedatadoghq.comserviceenvversiontrackViewsManuallyfalsetrackInteractionsfalsedefaultPrivacyLevelmask-user-inputactionNameAttributesampleRate100100 for all, 0 for none. Only tracked sessions send RUM events. For more details about sampleRate, see the sampling configuration.replaySampleRate100premiumSampleRate.premiumSampleRate100100 for all, 0 for none. For more details about premiumSampleRate, see the sampling configuration.silentMultipleInitfalseproxyUrlallowedTracingOriginstracingSampleRate100100 for all, 0 for none. For more information, see Connect RUM and Traces.telemetrySampleRate200 to opt out from telemetry collection.excludedActivityUrlsOptions that must have matching configuration when also using logs SDK:
trackSessionAcrossSubdomainsfalseuseSecureSessionCookiefalseuseCrossSiteSessionCookiefalseuseSecureSessionCookie.Init must be called to start the tracking:
init(configuration: {
applicationId: string,
clientToken: string,
site?: string,
sampleRate?: number,
silentMultipleInit?: boolean,
trackInteractions?: boolean,
service?: string,
env?: string,
version?: string,
allowedTracingOrigins?: Array<String|Regexp>,
trackSessionAcrossSubdomains?: boolean,
useSecureSessionCookie?: boolean,
useCrossSiteSessionCookie?: boolean,
})
This feature requires the RUM Browser SDK v3.6.0+.
When a new session is created, it can be tracked as either:
startSessionReplayRecording() are ignored.startSessionReplayRecording().Two initialization parameters are available to control how the session is tracked:
sampleRate controls the percentage of overall sessions being tracked. It defaults to 100%, so every sessions is tracked by default.premiumSampleRate is applied after the overall sample rate, and controls the percentage of sessions tracked as RUM Premium. It defaults to 100%, so every sessions is tracked as RUM Premium by default.To track 100% of your sessions as Browser RUM:
datadogRum.init({
....
sampleRate: 100,
premiumSampleRate: 0
});
To track 100% of your sessions as RUM Premium:
datadogRum.init({
....
sampleRate: 100,
premiumSampleRate: 100
});
For example, to track only 50% of your overall sessions with half tracked as Browser RUM and the other half tracked as RUM Premium, set the sampleRate and the premiumSampleRate to 50:
datadogRum.init({
....
sampleRate: 50,
premiumSampleRate: 50
});
Additional helpful documentation, links, and articles:
