ブラウザ監視のクライアントサイド設定

このドキュメントは最新ではありません。最新版はこちらをクリックして英語版をご覧ください。

概要

Datadog Browser SDK は、Web アプリケーションのための Real User Monitoring (RUM) を有効にし、ユーザーエクスペリエンスとアプリケーションパフォーマンスに関する包括的な可視性を提供します。RUM を使用すると、ページの読み込み時間、ユーザー操作、リソースの読み込み、およびアプリケーションエラーをリアルタイムで監視できます。

RUM は次のことに役立ちます。

  • ページ読み込み、ユーザーアクション、リソースリクエストに関する、詳細なパフォーマンスメトリクスを活用してユーザーエクスペリエンスを監視する
  • セッションリプレイ機能を活用して、アプリケーション内のユーザー操作を追跡する
  • パフォーマンスのボトルネックを特定し、APM トレースを使用してフロントエンドとバックエンドのパフォーマンスを相関させる

ブラウザ SDK は、すべての最新のデスクトップおよびモバイルブラウザをサポートし、主要なパフォーマンスメトリクス、ユーザーアクション、およびアプリケーションエラーの自動収集を提供します。設定後、Datadog でアプリケーションごとに RUM 構成を管理し、ダッシュボードや RUM エクスプローラーで収集したデータを可視化できます。

This page describes how to instrument your web applications with the Datadog Browser SDK. The Browser SDK supports Real User Monitoring (RUM), Error Tracking, Session Replay, and Product Analytics.

Select a setup method based on your application stack and workflow:

  • Manual client-side setup: Add the SDK directly to your frontend code when you need full control over initialization and configuration.
  • Agentic Onboarding: Use an AI-assisted workflow to automatically configure and deploy the SDK with minimal manual steps.
  • Server-side auto-instrumentation (RUM only): Inject the SDK through your web server or proxy when you cannot modify frontend code directly.

The Browser SDK supports all modern desktop and mobile browsers.

Setup

Create the application in the UI

  1. In Datadog, navigate to Digital Experience > Add an Application and select the JavaScript (JS) application type.
  2. Enter a name for your application, then click Create Application. This generates a clientToken and an applicationId for your application.

Install the Browser SDK

Choose the installation method for the Browser SDK.

    Installing through Node Package Manager (npm) registry is recommended for modern web applications. The Browser SDK is packaged with the rest of your frontend JavaScript code. It has no impact on page load performance. However, the SDK may miss errors, resources, and user actions triggered before the SDK is initialized. Datadog recommends using a matching version with the Browser Logs SDK.

    Add @datadog/browser-rum to your package.json file, for example if you use npm cli:

    npm install --save @datadog/browser-rum

    Installing through CDN async is recommended for web applications with performance targets. The Browser SDK loads from Datadog's CDN asynchronously, ensuring the SDK download does not impact page load performance. However, the SDK may miss errors, resources, and user actions triggered before the SDK is initialized.

    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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/us1/v7/datadog-rum.js','DD_RUM')
</script>

    <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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/eu/v7/datadog-rum.js','DD_RUM')
</script>

    <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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/ap1/v7/datadog-rum.js','DD_RUM')
</script>

    <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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/ap2/v7/datadog-rum.js','DD_RUM')
</script>

    <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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/us3/v7/datadog-rum.js','DD_RUM')
</script>

    <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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/us5/v7/datadog-rum.js','DD_RUM')
</script>

    <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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/uk1/v7/datadog-rum.js','DD_RUM')
</script>

    <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,d.crossOrigin=''
    n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
  })(window,document,'script','https://www.datadoghq-browser-agent.com/datadog-rum-v7.js','DD_RUM')
</script>

    Installing through CDN sync is recommended for collecting all events. The Browser SDK loads from Datadog's CDN synchronously, ensuring the SDK loads first and collects all errors, resources, and user actions. This method may impact page load performance.

    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. Placing the script tag higher and loading it synchronously ensures Datadog RUM can collect all performance data and errors.

    <script
    src="https://www.datadoghq-browser-agent.com/us1/v7/datadog-rum.js"
    type="text/javascript"
    crossorigin>
</script>

    <script
    src="https://www.datadoghq-browser-agent.com/eu/v7/datadog-rum.js"
    type="text/javascript"
    crossorigin>
</script>

    <script
    src="https://www.datadoghq-browser-agent.com/ap1/v7/datadog-rum.js"
    type="text/javascript"
    crossorigin>
</script>

    <script
    src="https://www.datadoghq-browser-agent.com/ap2/v7/datadog-rum.js"
    type="text/javascript"
    crossorigin>
</script>

    <script
    src="https://www.datadoghq-browser-agent.com/us3/v7/datadog-rum.js"
    type="text/javascript"
    crossorigin>
</script>

    <script
    src="https://www.datadoghq-browser-agent.com/us5/v7/datadog-rum.js"
    type="text/javascript"
    crossorigin>
</script>

    <script
    src="https://www.datadoghq-browser-agent.com/uk1/v7/datadog-rum.js"
    type="text/javascript"
    crossorigin>
</script>

    <script
    src="https://www.datadoghq-browser-agent.com/datadog-rum-v7.js"
    type="text/javascript">
</script>

    Initialize the Browser SDK

    The SDK should be initialized as early as possible in the app lifecycle. This ensures all measurements are captured correctly.

    In the initialization snippet, set an environment name, service name, and client token. See the full list of initialization parameters.

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

datadogRum.init({
   applicationId: '<APP_ID>',
   clientToken: '<CLIENT_TOKEN>',
   // `site` refers to the Datadog site parameter of your organization
   // see https://docs.datadoghq.com/getting_started/site/
   site: '<DATADOG_SITE>',
  //  service: 'my-web-application',
  //  env: 'production',
  //  version: '1.0.0',
});

      Types are compatible with TypeScript >= 3.8.2. For earlier versions of TypeScript, import JavaScript sources and use global variables to avoid any compilation issues.

      import '@datadog/browser-rum/bundle/datadog-rum'

window.DD_RUM.init({
  ...
})

      <script>
  window.DD_RUM.onReady(function() {
    window.DD_RUM.init({
      clientToken: '<CLIENT_TOKEN>',
      applicationId: '<APP_ID>',
      // `site` refers to the Datadog site parameter of your organization
      // see https://docs.datadoghq.com/getting_started/site/
      site: '<DATADOG_SITE>',
      //  service: 'my-web-application',
      //  env: 'production',
      //  version: '1.0.0',
    });
  })
</script>

      <script>
    window.DD_RUM && window.DD_RUM.init({
      clientToken: '<CLIENT_TOKEN>',
      applicationId: '<APP_ID>',
      // `site` refers to the Datadog site parameter of your organization
      // see https://docs.datadoghq.com/getting_started/site/
      site: '<DATADOG_SITE>',
      //  service: 'my-web-application',
      //  env: 'production',
      //  version: '1.0.0',

    });
</script>

      Configure tracking consent (GDPR compliance)

      To be compliant with GDPR, CCPA, and similar regulations, the Browser SDK lets you provide the tracking consent value at initialization.

      Configure Content Security Policy (CSP)

      If you're using the Datadog Content Security Policy (CSP) integration on your site, see the CSP documentation for additional setup steps.

      Use the Agentic Onboarding page to instrument your browser application using the AI Setup CLI or the Datadog MCP Server.

      RUM Auto-Instrumentation is not available for the selected site (). Use Client-Side instrumentation instead.

      Server-side auto-instrumentation only supports RUM. For Error Tracking, Session Replay, or Product Analytics, use manual client-side setup.

      RUM Auto-Instrumentation allows you to add RUM JS to your web app HTML. It works by injecting the RUM Browser SDK into the HTML responses being served through a web server or proxy. After auto-instrumentation is set up, you can manage configurations from the UI.

      RUM Auto-Instrumentation requires Datadog Agent version 7.34+.

      Getting started

      Select a platform to start collecting RUM data on your application:

      To request support for a web server that is not listed here, fill out this form.

      Java Servlet
      NGINX
      Windows IIS
      Apache HTTP Server
      IBM HTTP Server

      Limitations

      Server-side auto-instrumentation has the following limitations. If your use case requires more control, use client-side instrumentation instead.

      • This instrumentation method does not support advanced RUM configurations.
      • If your web server is acting as a proxy and the upstream server uses end-to-end encryption (TLS) or content compression (gzip, zstd, Brotli), the RUM Browser SDK cannot be injected. For proper instrumentation:
        • Disable content compression on the upstream server.
        • Enable TLS origination on the web server.

      Start monitoring

      Visualize the data collected in dashboards or create a search query in the RUM Explorer.

      Your application appears as pending on the Applications page until Datadog starts receiving data. If data takes time to appear, see Troubleshooting Browser SDK Issues.

      セッションサンプリングレートの設定

      アプリケーションが Datadog RUM に送信するデータを制御するため、ブラウザ SDK を初期化する際に RUM セッションのサンプリングレートを指定できます。たとえば、セッションの 80% をサンプリングするには、sessionSampleRate を 80 に設定します。

      datadogRum.init({
  applicationId: '<APP_ID>',
  clientToken: '<CLIENT_TOKEN>',
  site: '<DATADOG_SITE>',
  sessionSampleRate: 80,
  sessionReplaySampleRate: 20,
  // ... other configuration options
});

      詳細については、ブラウザ RUM とセッションリプレイのサンプリング を参照してください。

      アプリケーションの監視を開始する

      RUM の基本設定が完了したので、アプリケーションはブラウザエラーを収集しており、リアルタイムで問題の監視やデバッグを開始できます。

      収集したデータ を ダッシュボード で視覚化したり、RUM エクスプローラー で検索クエリを作成したりできます。

      Datadog がデータの受信を開始するまで、[Applications] (アプリケーション) ページでアプリケーションは保留中として表示されます。

      次のステップ

      高度な構成 を参照してください。

      Further reading

      お役に立つドキュメント、リンクや記事: