Installing the Datadog Agent to Collect Tests Data
CI Visibility is not available in the selected site () at this time.
To report test results to Datadog, the Datadog Agent is required.
There are two ways to set up the Agent in a CI environment:
Install the Agent as a long running process on each worker node (recommended for on-premises installations).
Run an ephemeral instance of the Agent as a service container on each build (recommended for SaaS CI providers).
Installing the Agent on each CI worker node
If you are running tests on an on-premises CI provider, install the Datadog Agent on each worker node by following the Agent installation instructions.
If the CI provider is using a container-based executor, set the DD_AGENT_HOST environment variable on all builds (which defaults to localhost) to an endpoint that is accessible from within build containers, as localhost inside the build references the container itself and not the underlying worker node where the Datadog Agent is running.
If you are using a Kubernetes executor, Datadog recommends using the Admission Controller, which automatically sets the DD_AGENT_HOST environment variable in the build pods to communicate with the local Datadog Agent.
Installing the Datadog Agent as a service container on each build
If you are using a SaaS CI provider with no access to the underlying worker nodes, run the Datadog Agent in a container as a build service. This method is also available for an on-premises CI provider that uses a container-based executor if installing the Datadog Agent on each worker node is not an option.
To run the Datadog Agent as a container acting as a simple results forwarder, use the Docker image gcr.io/datadoghq/agent:latest and the following environment variables:
DD_API_KEY (Required)
The Datadog API key used to upload the test results. Default: (none)
DD_INSIDE_CI (Required)
Disables the monitoring of the Datadog Agent container, as the underlying host is not accessible. Default: false Required value: true
DD_HOSTNAME (Required)
Disables the reporting of hostnames associated with tests, as the underlying host cannot be monitored. Default: (autodetected) Required value: none
Additionally, configure the Datadog site to use the selected one ():
DD_SITE
The Datadog site to upload results to. Default: datadoghq.com Selected site:
CI provider configuration examples
The following sections provide CI provider-specific instructions to run and configure the Agent to report test information.
To run the Datadog Agent in Azure Pipelines, define a new container in the resources section and link it with the job declaring it as a service container.
azure-pipeline.yml
variables:ddApiKey:$(DD_API_KEY)resources:containers:- container:dd_agentimage:gcr.io/datadoghq/agent:latestports:- 8126:8126env:DD_API_KEY:$(ddApiKey)DD_INSIDE_CI:"true"DD_HOSTNAME:"none"jobs:- job:testservices:dd_agent:dd_agentsteps:- script:make test
Replace <DD_SITE> with the selected site: .
azure-pipeline.yml
variables:ddApiKey:$(DD_API_KEY)resources:containers:- container:dd_agentimage:gcr.io/datadoghq/agent:latestports:- 8126:8126env:DD_API_KEY:$(ddApiKey)DD_INSIDE_CI:"true"DD_HOSTNAME:"none"DD_SITE:"<DD_SITE>"jobs:- job:testservices:dd_agent:dd_agentsteps:- script:make test
To run the Agent in GitLab, define the Agent container under services.
.gitlab-ci.yml
variables:DD_API_KEY:$DD_API_KEYDD_INSIDE_CI:"true"DD_HOSTNAME:"none"DD_AGENT_HOST:"datadog-agent"test:services:- name:gcr.io/datadoghq/agent:latestscript:- make test
Replace <DD_SITE> with the selected site: .
.gitlab-ci.yml
variables:DD_API_KEY:$DD_API_KEYDD_INSIDE_CI:"true"DD_HOSTNAME:"none"DD_AGENT_HOST:"datadog-agent"DD_SITE:"<DD_SITE>"test:services:- name:gcr.io/datadoghq/agent:latestscript:- make test
jobs:test:steps:- name:Start the Datadog Agent locallyuses:datadog/agent-github-action@v1with:api_key:${{ secrets.DD_API_KEY }}- run:make test
Replace <datadog_site> with the selected site: .
jobs:test:steps:- name:Start the Datadog Agent locallyuses:datadog/agent-github-action@v1with:api_key:${{ secrets.DD_API_KEY }}datadog_site:<datadog_site>- run:make test
To run the Agent in CircleCI, launch the Agent container before running tests by using the datadog/agent CircleCI orb, and stop it after to ensure results are sent to Datadog.
.circleci/config.yml
version:2.1orbs:datadog-agent:datadog/agent@0jobs:test:docker:- image:circleci/<language>:<version_tag>steps:- checkout- datadog-agent/setup- run:make test- datadog-agent/stopworkflows:test:jobs:- test
Replace <DD_SITE> with the selected site: .
.circleci/config.yml
version:2.1orbs:datadog-agent:datadog/agent@0jobs:test:docker:- image:circleci/<language>:<version_tag>environment:DD_SITE:"<DD_SITE>"steps:- checkout- datadog-agent/setup- run:make test- datadog-agent/stopworkflows:test:jobs:- test
In this case, DD_AGENT_HOST is not required because it is localhost by default.
Then, run your tests by providing your Datadog API key in the DD_API_KEY environment variable:
DD_API_KEY=<YOUR_DD_API_KEY> docker-compose up \
--build --abort-on-container-exit \
tests
Note: In this case, add all the required CI provider environment variables so build information can be attached to each test result, as described in Tests in containers.
Further reading
Additional helpful documentation, links, and articles: