@datadog/browser-rum

What is @datadog/browser-rum?

The @datadog/browser-rum package is a Real User Monitoring (RUM) solution provided by Datadog. It allows developers to collect and analyze performance and user behavior data from their web applications in real-time. This data can be used to identify and troubleshoot issues, improve user experience, and monitor application performance.

What are @datadog/browser-rum's main functionalities?

Real User Monitoring

Initializes the RUM SDK to start collecting data from the user's browser, including session replay recording.

import { datadogRum } from '@datadog/browser-rum';

datadogRum.init({
  applicationId: 'YOUR_APPLICATION_ID',
  clientToken: 'YOUR_CLIENT_TOKEN',
  site: 'datadoghq.com',
  service:'your-service-name',
  // Specify a version number to identify the deployed version of your application in Datadog
  version: '1.0.0',
  sampleRate: 100,
  trackInteractions: true,
});

datadogRum.startSessionReplayRecording();

Custom User Actions

Records custom user actions, such as button clicks, with additional context.

datadogRum.addAction('button_click', { buttonId: 'my-button' });

Logging Errors

Logs errors manually with additional context to help with debugging.

datadogRum.addError(new Error('Something went wrong'), {
  context: {
    productId: 123
  }
});

User Tracking

Sets user information to track user-specific data and associate it with the collected RUM data.

datadogRum.setUser({
  id: '1234',
  name: 'John Doe',
  email: '[e-mail]',
  // User-defined attributes
  plan_type: 'premium',
});

Other packages similar to @datadog/browser-rum

raygun4js

Raygun4js is a JavaScript SDK for Raygun, providing error tracking and real user monitoring. It captures errors and performance data from the browser, offering a feature set that competes with @datadog/browser-rum, with a focus on error diagnosis and resolution.

README

RUM Browser Monitoring

Datadog Real User Monitoring (RUM) enables you to visualize and analyze the real-time performance and user journeys of your application's individual users.

See the dedicated datadog documentation for more details.

Usage

To start collecting events, 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',
  sessionSampleRate: 100,
  sessionReplaySampleRate: 100,
  trackResources: true,
  trackLongTasks: true,
  trackUserInteractions: true,
})

Note: The trackUserInteractions parameter enables the automatic collection of user clicks in your application. Sensitive and private data contained in your pages may be included to identify the elements interacted with.

Changelog

v5.0.0

See our upgrade guide for a comprehensive list of breaking changes introduced by this major version.

• 💥 [RUMF-1589] automatically start recording (#2275)
• 💥 [RUMF-1587] Remove premiumSampleRate and replaySampleRate (#2256)
• 💥 [RUMF-1597] Drop plan and send sampled_for_replay (#2293)
• 💥 [RUMF-1578] Promote track frustration as default action behaviour (#2232)
• 💥 [RUMF-1230] Only apply main logger configuration to its own logs (#2298)
• 💥 [RUM-1210] Add W3C tracecontext to default propagator types (#2443)
• 💥 [RUMF-1473] Ignore untrusted event (#2308)
• 💥 [RUMF-1564] remove intake subdomains (#2309)
• 💥 [RUMF-1577] Stop collecting foreground periods (#2311)
• 💥 [RUMF-1557] beforeSend domain context: use PerformanceEntry (#2300)
• 💥 [RUMF-1556] Typings: consistent beforeSend return type (#2303)
• 💥 [RUMF-1229] Logs: remove error.origin attribute (#2294)
• 💥 [RUMF-1228] Remove console error message prefix (#2289)
• 💥 [RUMF-1555] Rework logger context APIs (#2285)
• 💥 [RUMF-1152] sanitize resource method names (#2288)
• 💥 [RUMF-1555] Remove event in action domain context (#2286)
• 💥 [RUMF-1588] Update default session replay behaviour (#2257)
• 💥 [RUMF-1554] Drop some deprecated public APIs (#2241)
• 💥 [RUMF-1554] Drop some deprecated config parameters (#2238)
• ✨ [RUM-255] add allowUntrustedEvents config parameter (#2347)
• 🐛 [RUMF-1499] Don't send duration for resources crossing a page frozen state (#2271)
• 🔥 [RUMF-1555] Remove startTime in xhr start context (#2287)
• ♻️ [RUMF-1555] Remove deprecated context manager APIs (#2284)