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 우선 접근 방식을 사용하여 테스트 파일을 로드합니다. 테스트에 대한 완전한 가시성을 확보하려면 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 통합

테스트 중인 브라우저 애플리케이션이 브라우저 모니터링을 사용하여 계측되는 경우, 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 통합

테스트 중인 브라우저 애플리케이션이 브라우저 모니터링을 사용하여 계측되는 경우, 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-trace v6에는 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-trace v6에는 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()
  })
})

사용자 지정 측정값에 대한 자세한 내용은 사용자 지정 측정값 추가 가이드를 참조하세요.