dd-trace v6 nécessite Node.js 22 ou une version ultérieure.

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 for Agentless mode)

Enables Agentless mode to send test results directly to Datadog.
Default: false

DD_API_KEY (Required for Agentless mode)

The Datadog API key used to authenticate test result uploads.
Default: (empty)

If you use a Datadog site other than US1, set the following variable:

DD_SITE (Optional for Agentless mode)

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.

Définissez la variable d’environnement NODE_OPTIONS sur -r dd-trace/ci/init. Exécutez vos tests comme vous le feriez normalement, en spécifiant éventuellement un nom pour votre session de test avec DD_TEST_SESSION_NAME :

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

Remarque : si vous définissez une valeur pour NODE_OPTIONS, assurez-vous qu’elle n’écrase pas -r dd-trace/ci/init. Cela peut être fait en utilisant la clause ${NODE_OPTIONS:-} :

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

Ajout de tags personnalisés aux tests

Vous pouvez ajouter des tags personnalisés à vos tests en utilisant la span actuellement active :

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

Pour créer des filtres ou des champs group by pour ces tags, vous devez d’abord créer des facettes. Pour plus d’informations sur l’ajout de tags, consultez la section Adding Tags de la documentation sur l’instrumentation personnalisée de Node.js.

Ajout de mesures personnalisées aux tests

Tout comme pour les tags, vous pouvez ajouter des mesures personnalisées à vos tests en utilisant le span actif :

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

Pour plus d’informations sur les mesures personnalisées, consultez le guide d’ajout de mesures personnalisées.

Mocha ECMAScript modules (ESM)

Mocha >=9.0.0 utilise une approche axée sur l’ESM pour charger les fichiers de test. Définissez NODE_OPTIONS sur -r dd-trace/ci/init --import dd-trace/register.js pour obtenir une visibilité complète sur vos tests. Consultez dd-trace-js ESM support pour plus d’informations.

Définissez la variable d’environnement NODE_OPTIONS sur -r dd-trace/ci/init. Exécutez vos tests comme vous le feriez normalement, en spécifiant éventuellement un nom pour votre session de test avec DD_TEST_SESSION_NAME :

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

Remarque : si vous définissez une valeur pour NODE_OPTIONS, assurez-vous qu’elle n’écrase pas -r dd-trace/ci/init. Cela peut être fait en utilisant la clause ${NODE_OPTIONS:-} :

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

Ajout de tags personnalisés aux tests

Vous pouvez ajouter des tags personnalisés à vos tests en utilisant la span actuellement active :

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')
  // ...
})

Pour créer des filtres ou des champs group by pour ces tags, vous devez d’abord créer des facettes. Pour plus d’informations sur l’ajout de tags, consultez la section Adding Tags de la documentation sur l’instrumentation personnalisée de Node.js.

Ajout de mesures personnalisées aux tests

Vous pouvez également ajouter des mesures personnalisées à vos tests en utilisant le span actif :

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

Pour plus d’informations sur les mesures personnalisées, consultez le guide d’ajout de mesures personnalisées.

Intégration Playwright - RUM

Si l’application de navigateur testée est instrumentée à l’aide de Browser Monitoring, les résultats des tests Playwright et leurs RUM browser sessions et session replays générées sont automatiquement liés. Pour plus d’informations, consultez le guide Instrumenter vos tests Browser avec RUM.

Téléversez les captures d’écran d’échec de test

Lorsqu’elle est activée, Test Optimization télécharge les captures d’écran que Playwright capture lorsqu’un test échoue. Affichez les captures d’écran dans l’onglet Media du panneau latéral des détails de test de Test Optimization. Utilisez-les pour inspecter l’état du navigateur au moment de l’échec.

Utilisez dd-trace v5.116.0 ou version ultérieure sur la ligne de version v5, ou dd-trace v6.5.0 ou version ultérieure sur la ligne de version v6.

Pour activer les téléchargements de captures d’écran, définissez la variable d’environnement DD_TEST_FAILURE_SCREENSHOTS_ENABLED sur 1. Dans votre configuration Playwright, définissez screenshot sous use sur l’une des valeurs suivantes :

• 'on' : Capturez une capture d’écran après chaque test.
• 'only-on-failure' : Capturez une capture d’écran après chaque échec de test.
• 'on-first-failure' : Capturez une capture d’écran après le premier échec de chaque test.

Remarque : Si vous utilisez 'on', Test Optimization ne télécharge que les captures d’écran des tests ayant échoué.

Définissez la variable d’environnement NODE_OPTIONS sur -r dd-trace/ci/init. Exécutez vos tests comme vous le feriez normalement, en spécifiant éventuellement un nom pour votre session de test avec DD_TEST_SESSION_NAME :

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

Remarque : si vous définissez une valeur pour NODE_OPTIONS, assurez-vous qu’elle n’écrase pas -r dd-trace/ci/init. Cela peut être fait en utilisant la clause ${NODE_OPTIONS:-} :

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

Ajout de tags personnalisés aux tests

Vous pouvez ajouter des tags personnalisés à votre test en récupérant la span active :

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

Pour créer des filtres ou des champs group by pour ces tags, vous devez d’abord créer des facettes. Pour plus d’informations sur l’ajout de tags, consultez la section Adding Tags de la documentation sur l’instrumentation personnalisée de Node.js.

Ajout de mesures personnalisées aux tests

Vous pouvez également ajouter des mesures personnalisées à votre test en utilisant le span actif :

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

Pour plus d’informations sur les mesures personnalisées, consultez le guide d’ajout de mesures personnalisées.

Cypress version 10 ou ultérieure

Utilisez la documentation de l’API Cypress pour apprendre à utiliser les plugins pour cypress>=10.

Dans votre fichier cypress.config.js, définissez ce qui suit :

const { defineConfig } = require('cypress')

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

Ajoutez la ligne suivante au niveau supérieur de votre 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) => {})

Si vous utilisez d’autres plugins Cypress, votre fichier cypress.config.js doit contenir ce qui suit :

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)
    }
  }
})

Événement Cypress after:run

Datadog nécessite l’événement Cypress after:run pour fonctionner, et Cypress n’autorise pas plusieurs gestionnaires pour cet événement. Si vous avez déjà défini des gestionnaires pour after:run, ajoutez manuellement le gestionnaire Datadog en important 'dd-trace/ci/cypress/after-run' :

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)
      })
    }
  }
})

Événement Cypress after:spec

Datadog nécessite l’événement Cypress after:spec pour fonctionner, et Cypress n’autorise pas plusieurs gestionnaires pour cet événement. Si vous avez déjà défini des gestionnaires pour after:spec, ajoutez manuellement le gestionnaire Datadog en important 'dd-trace/ci/cypress/after-spec' :

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)
      })
    }
  }
})

Exécutez vos tests comme vous le feriez normalement, en spécifiant éventuellement un nom pour votre session de test avec DD_TEST_SESSION_NAME :

DD_TEST_SESSION_NAME=ui-tests yarn test:ui

Ajout de tags personnalisés aux tests

Pour ajouter des informations supplémentaires à vos tests, telles que le propriétaire de l’équipe, utilisez cy.task('dd:addTags', { yourTags: 'here' }) dans votre test ou vos hooks.

Exemple :

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')
})

Pour créer des filtres ou des champs group by pour ces tags, vous devez d’abord créer des facettes. Pour plus d’informations sur l’ajout de tags, consultez la section Adding Tags de la documentation sur l’instrumentation personnalisée Node.js.

Ajout de mesures personnalisées aux tests

Pour ajouter des mesures personnalisées à vos tests, telles que les allocations de mémoire, utilisez cy.task('dd:addTags', { yourNumericalTags: 1 }) dans votre test ou vos hooks.

Exemple :

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

Pour plus d’informations sur les mesures personnalisées, consultez le guide d’ajout de mesures personnalisées.

Intégration Cypress - RUM

Si l’application de navigateur testée est instrumentée à l’aide de Browser Monitoring, les résultats des tests Cypress ainsi que les sessions de navigateur RUM et les relectures de session générées sont automatiquement liés. Pour plus d’informations, consultez le guide d’instrumentation de vos tests de navigateur avec RUM.

Téléversez les captures d’écran d’échec de test

Lorsqu’elle est activée, Test Optimization téléverse les captures d’écran que Cypress prend lorsqu’un test échoue. Elles apparaissent dans l’onglet Media du panneau latéral des détails de test de Test Optimization. Utilisez-les pour inspecter l’état du navigateur au moment de l’échec.

Utilisez dd-trace v5.112.0 ou version ultérieure sur la ligne de version v5, ou dd-trace v6.1.0 ou version ultérieure sur la ligne de version v6.

Pour activer les téléchargements de captures d’écran, définissez la variable d’environnement DD_TEST_FAILURE_SCREENSHOTS_ENABLED sur 1. Dans votre configuration Cypress, assurez-vous que screenshotOnRunFailure est défini sur true (la valeur par défaut).

Utilisez une version de Node.js prise en charge par votre version majeure de dd-trace pour l’instrumentation Vitest :

• dd-trace v5 nécessite Node.js 18.19+ ou Node.js 20.6+.
• dd-trace v6 nécessite Node.js 22 ou une version ultérieure.

Définissez la variable d’environnement NODE_OPTIONS sur --import dd-trace/register.js -r dd-trace/ci/init. Exécutez vos tests comme vous le feriez normalement, en spécifiant éventuellement un nom pour votre session de test avec 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

Remarque : si vous définissez une valeur pour NODE_OPTIONS, assurez-vous qu’elle n’écrase pas --import dd-trace/register.js -r dd-trace/ci/init. Cela peut être fait en utilisant la clause ${NODE_OPTIONS:-} :

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

Ajout de tags ou de mesures personnalisés aux tests

Vous pouvez ajouter des tags personnalisés à vos tests en utilisant la span actuellement active :

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)
})

Pour créer des filtres ou des champs group by pour ces tags, vous devez d’abord créer des facettes. Pour plus d’informations sur l’ajout de tags, consultez la section Adding Tags de la documentation sur l’instrumentation personnalisée de Node.js.

Vous pouvez également ajouter des mesures personnalisées à vos tests en utilisant le span actif :

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)
})

Pour plus d’informations sur les mesures personnalisées, consultez le guide d’ajout de mesures personnalisées.

Utilisez une version de Node.js prise en charge par votre dd-trace version majeure pour l’instrumentation WebdriverIO :

• dd-trace v5 nécessite Node.js 18.19+ ou Node.js 20.6+.
• dd-trace v6 nécessite Node.js 22 ou une version ultérieure.

Définissez la variable d’environnement NODE_OPTIONS sur --import dd-trace/register.js -r dd-trace/ci/init. Exécutez vos tests comme vous le feriez normalement, en spécifiant éventuellement un nom pour votre session de test avec 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

Remarque : si vous définissez une valeur pour NODE_OPTIONS, assurez-vous qu’elle n’écrase pas --import dd-trace/register.js -r dd-trace/ci/init. Cela peut être fait en utilisant la clause ${NODE_OPTIONS:-} :

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

Ajout de tags ou de mesures personnalisés aux tests

Vous pouvez ajouter des tags personnalisés à vos tests en utilisant la span actuellement active :

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()
  })
})

Pour créer des filtres ou des champs group by pour ces tags, vous devez d’abord créer des facettes. Pour plus d’informations sur l’ajout de tags, consultez la section Adding Tags de la documentation sur l’instrumentation personnalisée de Node.js.

Vous pouvez également ajouter des mesures personnalisées à vos tests en utilisant le span actif :

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()
  })
})

Pour plus d’informations sur les mesures personnalisées, consultez le guide d’ajout de mesures personnalisées.