dd-trace v6 には Node.js 22 以降が必要です。

We support auto-instrumentation for the following CI providers:

Auto-instrumentation runs on the CI executor and does not automatically apply to tests in a separate container. Before using it for containerized tests, see Tests in Containers.

If the auto-instrumentation step configures the process that runs your tests, you can skip the rest of the setup steps below.

If you are using a cloud CI provider without access to the underlying worker nodes, such as GitHub Actions or CircleCI, configure the library to use the Agentless mode. For this, set the following environment variables:

DD_CIVISIBILITY_AGENTLESS_ENABLED=true (Required)

Enables or disables Agentless mode.
Default: false

DD_API_KEY (Required)

The Datadog API key used to upload the test results.
Default: (empty)

Additionally, configure the Datadog site to which you want to send data.

DD_SITE (Required)

The Datadog site to upload results to.
Default: datadoghq.com

If you are running tests on an on-premises CI provider, such as Jenkins or self-managed GitLab CI, install the Datadog Agent on each worker node by following the Agent installation instructions. This is the recommended option as it allows you to automatically link test results to logs and underlying host metrics.

If you are using a Kubernetes executor, Datadog recommends using the Datadog Operator. The operator includes Datadog Admission Controller which can automatically inject the tracer library into the build pods. Note: If you use the Datadog Operator, there is no need to download and inject the tracer library since the Admission Controller can do this for you, so you can skip the corresponding step below. However, you still need to make sure that your pods set the environment variables or command-line parameters necessary to enable Test Visibility.

If you are not using Kubernetes or can’t use the Datadog Admission Controller and the CI provider is using a container-based executor, set the DD_TRACE_AGENT_URL environment variable (which defaults to http://localhost:8126) in the build container running the tracer to an endpoint that is accessible from within that container. Note: Using localhost inside the build references the container itself and not the underlying worker node or any container where the Agent might be running in.

DD_TRACE_AGENT_URL includes the protocol and port (for example, http://localhost:8126) and takes precedence over DD_AGENT_HOST and DD_TRACE_AGENT_PORT, and is the recommended configuration parameter to configure the Datadog Agent’s URL for CI Visibility.

If you still have issues connecting to the Datadog Agent, use the Agentless Mode. Note: When using this method, tests are not correlated with logs and infrastructure metrics.

環境変数 NODE_OPTIONS を -r dd-trace/ci/init に設定します。通常通りテストを実行します。オプションで DD_TEST_SESSION_NAME を使用してテストセッションの名前を指定することもできます。

NODE_OPTIONS="-r dd-trace/ci/init" DD_TEST_SESSION_NAME=unit-tests yarn test

注: NODE_OPTIONS に値を設定する場合は、-r dd-trace/ci/init を上書きしないように注意してください。これは ${NODE_OPTIONS:-} 節を使用して行うことができます。

{
  "scripts": {
    "test": "NODE_OPTIONS=\"--max-old-space-size=12288 ${NODE_OPTIONS:-}\" jest"
  }
}

テストにカスタムタグを追加する

現在アクティブなスパンを使用して、テストにカスタムタグを追加することができます。

  it('sum function can sum', () => {
    const testSpan = require('dd-trace').scope().active()
    testSpan.setTag('team_owner', 'my_team')
    // test continues normally
    // ...
  })

これらのタグに対してフィルターや group by フィールドを作成するには、まずファセットを作成する必要があります。タグの追加の詳細については、Node.js カスタムインスツルメンテーションドキュメントの タグの追加 セクションを参照してください。

テストへのカスタム測定値の追加

タグと同様に、現在アクティブなスパンを使用して、テストにカスタム測定値を追加できます。

  it('sum function can sum', () => {
    const testSpan = require('dd-trace').scope().active()
    testSpan.setTag('memory_allocations', 16)
    // test continues normally
    // ...
  })

カスタム測定値の詳細については、カスタム測定値の追加ガイド を参照してください。

Mocha ECMAScript モジュール (ESM)

Mocha >=9.0.0 は、テストファイルの読み込みに ESM-first アプローチを採用しています。テストの完全な可視性を得るには、NODE_OPTIONS を -r dd-trace/ci/init --import dd-trace/register.js に設定します。詳細については、dd-trace-js ESM サポート を参照してください。

環境変数 NODE_OPTIONS を -r dd-trace/ci/init に設定します。通常通りテストを実行します。オプションで DD_TEST_SESSION_NAME を使用してテストセッションの名前を指定することもできます。

NODE_OPTIONS="-r dd-trace/ci/init" DD_TEST_SESSION_NAME=e2e-tests yarn test:e2e

注: NODE_OPTIONS に値を設定する場合は、-r dd-trace/ci/init を上書きしないように注意してください。これは ${NODE_OPTIONS:-} 節を使用して行うことができます。

{
  "scripts": {
    "test": "NODE_OPTIONS=\"--max-old-space-size=12288 ${NODE_OPTIONS:-}\" jest"
  }
}

テストにカスタムタグを追加する

現在アクティブなスパンを使用して、テストにカスタムタグを追加することができます。

test('user profile', async ({ page }) => {
  const testSpan = require('dd-trace').scope().active()
  testSpan.setTag('team_owner', 'my_team')
  // ...
})

test('landing page', async ({ page }) => {
  const testSpan = require('dd-trace').scope().active()
  testSpan.setTag('test.cpu.usage', 'high')
  // ...
})

これらのタグに対してフィルターや group by フィールドを作成するには、まずファセットを作成する必要があります。タグの追加の詳細については、Node.js カスタムインスツルメンテーションドキュメントの タグの追加 セクションを参照してください。

テストへのカスタム測定値の追加

現在アクティブなスパンを使用して、テストにカスタム測定値を追加することもできます。

test('user profile', async ({ page }) => {
  const testSpan = require('dd-trace').scope().active()
  testSpan.setTag('memory_allocations', 16)
  // ...
})

カスタム測定値の詳細については、カスタム測定値の追加ガイド を参照してください。

Playwright - RUM インテグレーション

テスト対象のブラウザアプリケーションが Browser Monitoring を使用してインスツルメントされている場合、Playwright テストの結果と生成された RUM ブラウザセッションおよびセッションリプレイは自動的にリンクされます。詳細については、RUM によるブラウザテストのインスツルメントガイド を参照してください。

テストの失敗スクリーンショットをアップロードする

有効にすると、Test Optimization はテストが失敗したときに Playwright がキャプチャしたスクリーンショットをアップロードします。スクリーンショットは、Test Optimization テスト詳細サイドパネルの Media タブで表示します。これらを使用して、失敗時のブラウザの状態を調査します。

v5 リリースラインでは dd-trace v5.116.0 以降 を、v6 リリースラインでは dd-trace v6.5.0 以降 を使用してください。

スクリーンショットのアップロードを有効にするには、DD_TEST_FAILURE_SCREENSHOTS_ENABLED 環境変数を 1 に設定します。Playwright 構成の use で screenshot を以下のいずれかの値に設定します。

• 'on': 各テストの後にスクリーンショットをキャプチャします。
• 'only-on-failure': 各テスト失敗の後にスクリーンショットをキャプチャします。
• 'on-first-failure': 各テストの最初の失敗の後にスクリーンショットをキャプチャします。

注: 'on' を使用する場合、Test Optimization は失敗したテストのスクリーンショットのみをアップロードします。

環境変数 NODE_OPTIONS を -r dd-trace/ci/init に設定します。通常通りテストを実行します。オプションで DD_TEST_SESSION_NAME を使用してテストセッションの名前を指定することもできます。

NODE_OPTIONS="-r dd-trace/ci/init" DD_TEST_SESSION_NAME=integration-tests yarn test:integration

注: NODE_OPTIONS に値を設定する場合は、-r dd-trace/ci/init を上書きしないように注意してください。これは ${NODE_OPTIONS:-} 節を使用して行うことができます。

{
  "scripts": {
    "test": "NODE_OPTIONS=\"--max-old-space-size=12288 ${NODE_OPTIONS:-}\" jest"
  }
}

テストにカスタムタグを追加する

現在アクティブなスパンをつかんで、テストにカスタムタグを追加することができます。

  When('the function is called', function () {
    const stepSpan = require('dd-trace').scope().active()
    testSpan.setTag('team_owner', 'my_team')
    // test continues normally
    // ...
  })

これらのタグに対してフィルターや group by フィールドを作成するには、まずファセットを作成する必要があります。タグの追加の詳細については、Node.js カスタムインスツルメンテーションドキュメントの タグの追加 セクションを参照してください。

テストへのカスタム測定値の追加

現在アクティブなスパンをつかんで、テストにカスタム測定値を追加することもできます。

  When('the function is called', function () {
    const stepSpan = require('dd-trace').scope().active()
    testSpan.setTag('memory_allocations', 16)
    // test continues normally
    // ...
  })

カスタム測定値の詳細については、カスタム測定値の追加ガイド を参照してください。

Cypress バージョン 10 以降

Cypress API ドキュメントを使用して、cypress>=10 のための プラグインの使用方法を学ぶ ことができます。

cypress.config.js ファイルで、以下を設定します。

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    setupNodeEvents: require('dd-trace/ci/cypress/plugin'),
    supportFile: 'cypress/support/e2e.js'
  }
})

次の行を supportFile のトップレベルに追加します。

// Your code can be before this line
// require('./commands')
require('dd-trace/ci/cypress/support')
// Also supported:
// import 'dd-trace/ci/cypress/support'
// Your code can also be after this line
// Cypress.Commands.add('login', (email, pw) => {})

他の Cypress プラグインを使用している場合、cypress.config.js ファイルに以下の内容が含まれている必要があります。

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // your previous code is before this line
      return require('dd-trace/ci/cypress/plugin')(on, config)
    }
  }
})

Cypress after:run イベント

Datadog が機能するには after:run Cypress イベントが必要ですが、Cypress はそのイベントに対して複数のハンドラーを許可していません。after:run のハンドラーをすでに定義している場合は、'dd-trace/ci/cypress/after-run' をインポートして Datadog ハンドラーを手動で追加します。

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      require('dd-trace/ci/cypress/plugin')(on, config)
      // other plugins
      on('after:run', (details) => {
        // other 'after:run' handlers
        // important that this function call is returned
        return require('dd-trace/ci/cypress/after-run')(details)
      })
    }
  }
})

Cypress after:spec イベント

Datadog が機能するには after:spec Cypress イベントが必要ですが、Cypress はそのイベントに対して複数のハンドラーを許可していません。after:spec のハンドラーをすでに定義している場合は、'dd-trace/ci/cypress/after-spec' をインポートして Datadog ハンドラーを手動で追加します。

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      require('dd-trace/ci/cypress/plugin')(on, config)
      // other plugins
      on('after:spec', (...args) => {
        // other 'after:spec' handlers
        // Important that this function call is returned
        // Important that all the arguments are passed
        return require('dd-trace/ci/cypress/after-spec')(...args)
      })
    }
  }
})

通常通りテストを実行します。オプションで DD_TEST_SESSION_NAME を使用してテストセッションの名前を指定することもできます。

DD_TEST_SESSION_NAME=ui-tests yarn test:ui

テストにカスタムタグを追加する

チーム所有者などの追加情報をテストに追加するには、テストまたはフック内で cy.task('dd:addTags', { yourTags: 'here' }) を使用します。

たとえば、以下のとおりです。

beforeEach(() => {
  cy.task('dd:addTags', {
    'before.each': 'certain.information'
  })
})
it('renders a hello world', () => {
  cy.task('dd:addTags', {
    'team.owner': 'ui'
  })
  cy.get('.hello-world')
    .should('have.text', 'Hello World')
})

これらのタグに対してフィルターや group by フィールドを作成するには、まずファセットを作成する必要があります。タグの追加の詳細については、Node.js カスタムインスツルメンテーションドキュメントの タグの追加 セクションを参照してください。

テストへのカスタム測定値の追加

メモリ割り当てなどのカスタム測定値をテストに追加するには、テストまたはフック内で cy.task('dd:addTags', { yourNumericalTags: 1 }) を使用します。

たとえば、以下のとおりです。

it('renders a hello world', () => {
  cy.task('dd:addTags', {
    'memory_allocations': 16
  })
  cy.get('.hello-world')
    .should('have.text', 'Hello World')
})

カスタム測定値の詳細については、カスタム測定値の追加ガイド を参照してください。

Cypress - RUM インテグレーション

テスト対象のブラウザアプリケーションが Browser Monitoring を使用してインスツルメントされている場合、Cypress テストの結果と生成された RUM ブラウザセッションおよびセッションリプレイは自動的にリンクされます。詳細については、RUM によるブラウザテストのインスツルメントガイド を参照してください。

テストの失敗スクリーンショットをアップロードする

有効にすると、Test Optimization はテストが失敗したときに Cypress がキャプチャしたスクリーンショットをアップロードします。これらは Test Optimization テスト詳細サイドパネルの Media タブに表示されます。これらを使用して、失敗時のブラウザの状態を調査します。

v5 リリースラインでは dd-trace v5.112.0 以降 を、v6 リリースラインでは dd-trace v6.1.0 以降 を使用してください。

スクリーンショットのアップロードを有効にするには、DD_TEST_FAILURE_SCREENSHOTS_ENABLED 環境変数を 1 に設定します。Cypress 構成で、screenshotOnRunFailure が true (デフォルト) に設定されていることを確認してください。

Vitest インスツルメンテーションには、dd-trace メジャーバージョンでサポートされている Node.js バージョンを使用してください。

• dd-trace v5 には Node.js 18.19 以降または Node.js 20.6 以降が必要です。
• dd-tracev6 には Node.js 22 以降が必要です。

環境変数 NODE_OPTIONS を --import dd-trace/register.js -r dd-trace/ci/init に設定します。通常通りテストを実行します。オプションで DD_TEST_SESSION_NAME を使用してテストセッションの名前を指定することもできます。

NODE_OPTIONS="--import dd-trace/register.js -r dd-trace/ci/init" DD_TEST_SESSION_NAME=smoke-tests yarn test:smoke

注: NODE_OPTIONS に値を設定する場合は、--import dd-trace/register.js -r dd-trace/ci/init を上書きしないように注意してください。これは ${NODE_OPTIONS:-} 節を使用して行うことができます。

{
  "scripts": {
    "test": "NODE_OPTIONS=\"--max-old-space-size=12288 ${NODE_OPTIONS:-}\" vitest run"
  }
}

テストへのカスタムタグまたは測定値の追加

現在アクティブなスパンを使用して、テストにカスタムタグを追加することができます。

import tracer from 'dd-trace'
import { expect, test } from 'vitest'

test('sum function can sum', () => {
  const testSpan = tracer.scope().active()
  testSpan.setTag('team_owner', 'my_team')

  expect(1 + 2).toBe(3)
})

これらのタグに対してフィルターや group by フィールドを作成するには、まずファセットを作成する必要があります。タグの追加の詳細については、Node.js カスタムインスツルメンテーションドキュメントの タグの追加 セクションを参照してください。

現在アクティブなスパンを使用して、テストにカスタム測定値を追加することもできます。

import tracer from 'dd-trace'
import { expect, test } from 'vitest'

test('sum function can sum', () => {
  const testSpan = tracer.scope().active()
  testSpan.setTag('memory_allocations', 16)

  expect(1 + 2).toBe(3)
})

カスタム測定値の詳細については、カスタム測定値の追加ガイド を参照してください。

WebdriverIO インスツルメンテーションには、dd-trace メジャーバージョンでサポートされている Node.js バージョンを使用してください。

• dd-trace v5 には Node.js 18.19 以降または Node.js 20.6 以降が必要です。
• dd-tracev6 には Node.js 22 以降が必要です。

環境変数 NODE_OPTIONS を --import dd-trace/register.js -r dd-trace/ci/init に設定します。通常通りテストを実行します。オプションで DD_TEST_SESSION_NAME を使用してテストセッションの名前を指定することもできます。

NODE_OPTIONS="--import dd-trace/register.js -r dd-trace/ci/init" DD_TEST_SESSION_NAME=e2e-tests yarn test:e2e

注: NODE_OPTIONS に値を設定する場合は、--import dd-trace/register.js -r dd-trace/ci/init を上書きしないように注意してください。これは ${NODE_OPTIONS:-} 節を使用して行うことができます。

{
  "scripts": {
    "test:e2e": "NODE_OPTIONS=\"--max-old-space-size=12288 ${NODE_OPTIONS:-}\" wdio run ./wdio.conf.js"
  }
}

テストへのカスタムタグまたは測定値の追加

現在アクティブなスパンを使用して、テストにカスタムタグを追加することができます。

import tracer from 'dd-trace'

describe('home page', () => {
  it('displays the heading', async () => {
    const testSpan = tracer.scope().active()
    testSpan.setTag('team_owner', 'my_team')

    await browser.url('/')
    await expect($('h1')).toBeDisplayed()
  })
})

これらのタグに対してフィルターや group by フィールドを作成するには、まずファセットを作成する必要があります。タグの追加の詳細については、Node.js カスタムインスツルメンテーションドキュメントの タグの追加 セクションを参照してください。

現在アクティブなスパンを使用して、テストにカスタム測定値を追加することもできます。

import tracer from 'dd-trace'

describe('home page', () => {
  it('displays the heading', async () => {
    const testSpan = tracer.scope().active()
    testSpan.setTag('memory_allocations', 16)

    await browser.url('/')
    await expect($('h1')).toBeDisplayed()
  })
})

カスタム測定値の詳細については、カスタム測定値の追加ガイド を参照してください。