Documentation
    Preparing search index...

    Module @datadog/browser-rum

    Datadog Browser RUM SDK - Full version with Session Replay and Real User Profiling capabilities. Use this package to monitor your web application's performance and user experience.

    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.

    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.

    API

    RumGlobal

    Configuration

    RumInitConfiguration

    Other

    Account
    AddDurationVitalOptions
    CommonProperties
    Context
    DurationVitalOptions
    DurationVitalReference
    OnRumStartOptions
    RumActionEventDomainContext
    RumErrorEventDomainContext
    RumFetchResourceEventDomainContext
    RumInternalContext
    RumLongTaskEventDomainContext
    RumOtherResourceEventDomainContext
    RumPlugin
    RumViewEventDomainContext
    RumVitalEventDomainContext
    RumXhrResourceEventDomainContext
    StartRecordingOptions
    TracingOption
    User
    ViewOptions
    ContextValue
    DefaultPrivacyLevel
    FeatureFlagsForEvents
    MatchOption
    PropagatorType
    ProxyFn
    RumActionEvent
    RumErrorEvent
    RumEvent
    RumEventDomainContext
    RumLongTaskEvent
    RumResourceEvent
    RumViewEvent
    RumVitalEvent
    SessionPersistence
    Site
    TraceContextInjection
    TraceContextInjection
    TrackingConsent
    TrackingConsent
    datadogRum
    DefaultPrivacyLevel