A script that installs Datadog tracing libraries and prints environment variables necessary for configuring Datadog Test Optimization. The variables are printed in the following format: variableName=variableValue

Supported languages are .NET, Java, Javascript, Python, Ruby and Go.

Test Optimization provides a test-first view into your CI health by displaying important metrics and results from your tests. It can help you investigate and mitigate performance problems and test failures that are most relevant to your work, focusing on the code you are responsible for, rather than the pipelines which run your tests.

Run the script with the necessary parameters:

DD_CIVISIBILITY_INSTRUMENTATION_LANGUAGES=... DD_API_KEY=... ./install_test_visibility.sh

The script parameters are

• DD_CIVISIBILITY_INSTRUMENTATION_LANGUAGES: (required) List of languages to be instrumented. Can be either all or any of java, js, python, dotnet, ruby, go (multiple languages can be specified as a space-separated list).
• DD_API_KEY: (required for .NET tracer installation) Datadog API key. Can be found at https://app.datadoghq.com/organization-settings/api-keys
• DD_TRACER_FOLDER: (optional) The folder where the tracing libraries will be installed, defaults to ./.datadog
• DD_SITE: (optional) Datadog site, defaults to US1. See https://docs.datadoghq.com/getting_started/site for more information about sites.
• DD_SET_TRACER_VERSION_DOTNET: (optional) Version of the .NET tracer to install. If not provided, the latest version is installed.
• DD_SET_TRACER_VERSION_JAVA: (optional) Version of the Java tracer to install (without the v prefix, e.g. 1.37.1). If not provided, the latest version is installed.
• DD_SET_TRACER_REPOSITORY_URL_JAVA: (optional) Base URL of a Maven repository (or proxy/mirror) used to download the Java tracer JAR and its .sha256. The path under the base must follow the standard Maven layout for com.datadoghq:dd-java-agent (i.e. <base>/<version>/dd-java-agent-<version>.jar, plus <base>/maven-metadata.xml when DD_SET_TRACER_VERSION_JAVA is not pinned). Trailing slashes are tolerated. Defaults to https://repo1.maven.org/maven2/com/datadoghq/dd-java-agent.
• DD_SET_AUTH_HEADER_JAVA: (optional) HTTP header used to authenticate against DD_SET_TRACER_REPOSITORY_URL_JAVA, provided as a complete Name: Value string (e.g. Authorization: Bearer <token>). Passed verbatim to curl -H / wget --header on every Java tracer download. Requires DD_SET_TRACER_REPOSITORY_URL_JAVA to be set to a custom repository URL. Redirects are followed by default; be aware that the header will be re-sent on each redirect hop with the following caveats: curl strips Authorization and Cookie headers on cross-origin redirects (different host, port, or scheme), but wget does not strip any header. Custom header names (e.g. X-API-Key, X-JFrog-Art-Api) are never stripped by either tool — prefer the Authorization: … form when possible. Set DD_SET_AUTH_HEADER_JAVA_DISABLE_REDIRECTS to opt out of redirect following entirely.
• DD_SET_AUTH_HEADER_JAVA_DISABLE_REDIRECTS: (optional) When set to any non-empty value, disables HTTP redirect following for Java tracer downloads that send DD_SET_AUTH_HEADER_JAVA. Use this if your repository never redirects and you want to guarantee the auth header is only ever sent to the configured DD_SET_TRACER_REPOSITORY_URL_JAVA host.
• DD_SET_TRACER_VERSION_JS: (optional) Version of the JS tracer to install. If not provided, the latest version is installed.
• DD_SET_TRACER_VERSION_PYTHON: (optional) Version of the Python tracer to install. If not provided, the latest version is installed.
• DD_SET_COVERAGE_VERSION_PYTHON: (optional) Version of the Python coverage package to install. Defaults to 7.13.5.
• DD_SET_TRACER_VERSION_RUBY: (optional) Version of the Ruby datadog-ci gem to install. If not provided, the latest version is installed.
• DD_SET_TRACER_VERSION_GO: (optional) Version of Orchestrion to install. If not provided, the latest version is installed.
• DD_CIVISIBILITY_GO_MODULE_DIR: (optional) Directory that contains the Go project's go.mod file. Use this when the Go module is not at the repository root or when the repository contains multiple Go modules.
• DD_INSTRUMENTATION_BUILD_SYSTEM_JAVA: (optional) A hint for Java instrumentation to instrument a specific build system. Allowed values are maven, gradle, sbt, ant, and all. If not specified, every Maven, Gradle, SBT, and Ant build will be instrumented. all is a special value that allows instrumenting every JVM process.

The script will install the libraries and print the list of environment variables that should be set in order to enable Test Optimization. Example output:

DD_CIVISIBILITY_ENABLED=true
DD_CIVISIBILITY_AGENTLESS_ENABLED=true
DD_ENV=ci
JAVA_TOOL_OPTIONS=-javaagent:./.datadog/dd-java-agent.jar

If you want to set the variables printed by the script, use the following expression:

while IFS='=' read -r name value; do
  if [[ $name =~ ^[A-Za-z_][A-Za-z0-9_]*$ ]]; then
    export "$name=$value"
  fi
done < <(DD_CIVISIBILITY_INSTRUMENTATION_LANGUAGES=[...] DD_API_KEY=[...] ./install_test_visibility.sh)

ℹ️ This section is only relevant if you're running tests with vitest.

To use this script with vitest you need to modify the NODE_OPTIONS environment variable adding the --import flag with the value of the DD_TRACE_ESM_IMPORT environment variable.

export NODE_OPTIONS="$NODE_OPTIONS --import=$DD_TRACE_ESM_IMPORT"

Important: vitest and dd-trace require Node.js>=18.19 or Node.js>=20.6 to work together.

To instrument your Cypress tests with Datadog Test Optimization, please follow the manual steps in the docs.