Tests in Containers

Test Visibility is not available in the selected site () at this time.

Overview

If you run your tests inside a container that you launch yourself within the build (for example, using docker run or docker-compose), forward the following environment variables to the container depending on your CI provider. This enables the Datadog tracer to autodetect the build information.

Additionally, you need to pass in the environment variables required to configure the tracer as described in the per-language test instrumentation instructions (such as DD_SERVICE, DD_ENV, and a valid DD_TRACE_AGENT_URL that is accessible from within the container).

  • APPVEYOR
  • APPVEYOR_BUILD_ID
  • APPVEYOR_BUILD_NUMBER
  • APPVEYOR_BUILD_FOLDER
  • APPVEYOR_REPO_PROVIDER
  • APPVEYOR_REPO_NAME
  • APPVEYOR_REPO_BRANCH
  • APPVEYOR_REPO_COMMIT
  • APPVEYOR_REPO_TAG_NAME
  • APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH
  • APPVEYOR_REPO_COMMIT_MESSAGE
  • APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED
  • APPVEYOR_REPO_COMMIT_AUTHOR
  • APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL

Full list of build environment variables provided by AppVeyor

  • TF_BUILD
  • BUILD_DEFINITIONNAME
  • BUILD_BUILDID
  • BUILD_SOURCESDIRECTORY
  • BUILD_REPOSITORY_URI
  • BUILD_SOURCEBRANCH
  • BUILD_SOURCEVERSION
  • BUILD_SOURCEVERSIONMESSAGE
  • BUILD_REQUESTEDFORID
  • BUILD_REQUESTEDFOREMAIL
  • SYSTEM_TEAMFOUNDATIONSERVERURI
  • SYSTEM_TEAMPROJECTID
  • SYSTEM_JOBID
  • SYSTEM_TASKINSTANCEID
  • SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI
  • SYSTEM_PULLREQUEST_SOURCEBRANCH
  • SYSTEM_PULLREQUEST_SOURCECOMMITID
  • SYSTEM_STAGEDISPLAYNAME
  • SYSTEM_JOBDISPLAYNAME

Full list of build environment variables provided by Azure Pipelines

  • BITBUCKET_PIPELINE_UUID
  • BITBUCKET_BUILD_NUMBER
  • BITBUCKET_CLONE_DIR
  • BITBUCKET_REPO_FULL_NAME
  • BITBUCKET_GIT_SSH_ORIGIN
  • BITBUCKET_COMMIT
  • BITBUCKET_BRANCH
  • BITBUCKET_TAG

Full list of build environment variables provided by Bitbucket Pipelines

  • BITRISE_BUILD_SLUG
  • BITRISE_TRIGGERED_WORKFLOW_ID
  • BITRISE_BUILD_NUMBER
  • BITRISE_BUILD_URL
  • BITRISE_SOURCE_DIR
  • GIT_REPOSITORY_URL
  • BITRISE_GIT_COMMIT
  • GIT_CLONE_COMMIT_HASH
  • BITRISEIO_GIT_BRANCH_DEST
  • BITRISE_GIT_BRANCH
  • BITRISE_GIT_TAG
  • BITRISE_GIT_MESSAGE
  • BITRISE_APP_TITLE
  • GIT_CLONE_COMMIT_MESSAGE_SUBJECT
  • GIT_CLONE_COMMIT_MESSAGE_BODY
  • GIT_CLONE_COMMIT_AUTHOR_NAME
  • GIT_CLONE_COMMIT_AUTHOR_EMAIL
  • GIT_CLONE_COMMIT_COMMITER_NAME
  • GIT_CLONE_COMMIT_COMMITER_EMAIL

Full list of build environment variables provided by Bitrise

  • BUILDKITE
  • BUILDKITE_PIPELINE_SLUG
  • BUILDKITE_JOB_ID
  • BUILDKITE_BUILD_ID
  • BUILDKITE_BUILD_NUMBER
  • BUILDKITE_BUILD_URL
  • BUILDKITE_BUILD_CHECKOUT_PATH
  • BUILDKITE_REPO
  • BUILDKITE_COMMIT
  • BUILDKITE_BRANCH
  • BUILDKITE_TAG
  • BUILDKITE_MESSAGE
  • BUILDKITE_BUILD_AUTHOR
  • BUILDKITE_BUILD_AUTHOR_EMAIL
  • BUILDKITE_BUILD_CREATOR
  • BUILDKITE_BUILD_CREATOR_EMAIL
  • BUILDKITE_AGENT_ID
  • BUILDKITE_AGENT_META_DATA_*

Full list of build environment variables provided by Buildkite

  • CIRCLECI
  • CIRCLE_PROJECT_REPONAME
  • CIRCLE_BUILD_NUM
  • CIRCLE_BUILD_URL
  • CIRCLE_WORKFLOW_ID
  • CIRCLE_WORKING_DIRECTORY
  • CIRCLE_REPOSITORY_URL
  • CIRCLE_SHA1
  • CIRCLE_BRANCH
  • CIRCLE_TAG
  • CIRCLE_JOB

Full list of build environment variables provided by CircleCI

  • CF_BUILD_ID
  • CF_PIPELINE_NAME
  • CF_BUILD_URL
  • CF_STEP_NAME
  • CF_BRANCH
  • CF_REVISION

Full list of build environment variables provided by Codefresh

  • GITHUB_ACTION
  • GITHUB_SERVER_URL
  • GITHUB_RUN_ID
  • GITHUB_RUN_NUMBER
  • GITHUB_RUN_ATTEMPT
  • GITHUB_WORKFLOW
  • GITHUB_WORKSPACE
  • GITHUB_REPOSITORY
  • GITHUB_SHA
  • GITHUB_HEAD_REF
  • GITHUB_REF
  • GITHUB_JOB

Full list of build environment variables provided by GitHub Actions

  • GITLAB_CI
  • CI_PIPELINE_ID
  • CI_PIPELINE_URL
  • CI_PIPELINE_IID
  • CI_PROJECT_PATH
  • CI_PROJECT_DIR
  • CI_JOB_STAGE
  • CI_JOB_NAME
  • CI_JOB_URL
  • CI_JOB_ID
  • CI_RUNNER_ID
  • CI_RUNNER_TAGS
  • CI_REPOSITORY_URL
  • CI_COMMIT_SHA
  • CI_COMMIT_REF_NAME
  • CI_COMMIT_BRANCH
  • CI_COMMIT_TAG
  • CI_COMMIT_AUTHOR
  • CI_COMMIT_MESSAGE
  • CI_COMMIT_TIMESTAMP

Full list of build environment variables provided by GitLab CI

  • JENKINS_URL
  • BUILD_TAG
  • BUILD_NUMBER
  • BUILD_URL
  • WORKSPACE
  • JOB_NAME
  • JOB_URL
  • GIT_URL
  • GIT_URL_1
  • GIT_COMMIT
  • GIT_BRANCH
  • NODE_NAME
  • NODE_LABELS
  • DD_CUSTOM_TRACE_ID (custom variable set by the Jenkins Datadog Plugin)
  • DD_CUSTOM_PARENT_ID (idem)

Full list of build environment variables provided by Jenkins

Full list of build environment variables provided by TeamCity

  • TRAVIS
  • TRAVIS_BUILD_ID
  • TRAVIS_BUILD_NUMBER
  • TRAVIS_BUILD_WEB_URL
  • TRAVIS_BUILD_DIR
  • TRAVIS_JOB_WEB_URL
  • TRAVIS_REPO_SLUG
  • TRAVIS_COMMIT
  • TRAVIS_BRANCH
  • TRAVIS_TAG
  • TRAVIS_PULL_REQUEST_SLUG
  • TRAVIS_PULL_REQUEST_BRANCH
  • TRAVIS_COMMIT_MESSAGE

Full list of build environment variables provided by Travis CI

  • BUDDY
  • BUDDY_SCM_URL
  • BUDDY_EXECUTION_REVISION
  • BUDDY_EXECUTION_BRANCH
  • BUDDY_EXECUTION_TAG
  • BUDDY_PIPELINE_ID
  • BUDDY_EXECUTION_ID
  • BUDDY_PIPELINE_NAME
  • BUDDY_EXECUTION_URL
  • BUDDY_EXECUTION_REVISION_MESSAGE
  • BUDDY_EXECUTION_REVISION_COMMITTER_NAME
  • BUDDY_EXECUTION_REVISION_COMMITTER_EMAIL

Full list of build environment variables provided by Buddy CI

Further reading

Additional helpful documentation, links, and articles: