Supported test frameworks:
To report test results to Datadog, you need to configure the Datadog Java library:
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 test results are then automatically linked to the underlying host metrics.
If the CI provider is using a container-based executor, set the DD_AGENT_HOST environment variable on all builds (which defaults to http://localhost:8126) to an endpoint that is accessible from within build containers, as using 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 Datadog Admission Controller, which automatically sets the DD_AGENT_HOST environment variable in the build pods to communicate with the local Datadog Agent.
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)falseDD_API_KEY (Required)(empty)Additionally, configure which Datadog site to which you want to send data.
DD_SITE (Required)datadoghq.comInstall and enable the Java tracer v0.101.0 or newer.
Add a new Maven profile in your root pom.xml configuring the Datadog Java tracer dependency and the javaagent arg property, replacing $VERSION with the latest version of the tracer accessible from the Maven Repository (without the preceding v):
pom.xml
<profile>
<id>dd-civisibility</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<properties>
<dd.java.agent.arg>-javaagent:${settings.localRepository}/com/datadoghq/dd-java-agent/$VERSION/dd-java-agent-$VERSION.jar -Ddd.service=my-java-app -Ddd.civisibility.enabled=true</dd.java.agent.arg>
</properties>
<dependencies>
<dependency>
<groupId>com.datadoghq</groupId>
<artifactId>dd-java-agent</artifactId>
<version>$VERSION</version>
<scope>provided</scope>
</dependency>
</dependencies>
</profile>Add the ddTracerAgent entry to the configurations task block, and add the Datadog Java tracer dependency, replacing $VERSION with the latest version of the tracer available in the Maven Repository (without the preceding v):
build.gradle
configurations {
ddTracerAgent
}
dependencies {
ddTracerAgent "com.datadoghq:dd-java-agent:$VERSION"
}Configure the Maven Surefire Plugin or the Maven Failsafe Plugin (or both if you use both) to use Datadog Java agent, specifying the name of the service or library under test with the -Ddd.service property:
pom.xml
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<argLine>${dd.java.agent.arg}</argLine>
</configuration>
</plugin>pom.xml
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<configuration>
<argLine>${dd.java.agent.arg}</argLine>
</configuration>
<executions>
<execution>
<goals>
<goal>integration-test</goal>
<goal>verify</goal>
</goals>
</execution>
</executions>
</plugin>Run your tests as you normally do, specifying the environment where tests are being run (for example, local when running tests on a developer workstation, or ci when running them on a CI provider) in the DD_ENV environment variable. For example:
DD_ENV=ci mvn clean verify -Pdd-civisibilityConfigure the test Gradle task by adding to the jvmArgs attribute the -javaagent argument targeting the Datadog Java tracer based on the configurations.ddTracerAgent property, specifying the name of the service or library under test with the -Ddd.service property:
build.gradle
test {
if(project.hasProperty("dd-civisibility")) {
jvmArgs = ["-javaagent:${configurations.ddTracerAgent.asPath}", "-Ddd.service=my-java-app", "-Ddd.civisibility.enabled=true"]
}
}Run your tests as you normally do, specifying the environment where test are being run (for example, local when running tests on a developer workstation, or ci when running them on a CI provider) in the DD_ENV environment variable. For example:
DD_ENV=ci ./gradlew cleanTest test -Pdd-civisibility --rerun-tasksNote: As Gradle builds can be customizable programmatically, you may need to adapt these steps to your specific build configuration.
You can add custom tags to your tests by using the current active span:
// inside your test
final Span span = GlobalTracer.get().activeSpan();
if (span != null) {
span.setTag("test_owner", "my_team");
}
// test continues normally
// ...
To create filters or group by fields for these tags, you must first create facets. For more information about adding tags, see the Adding Tags section of the Java custom instrumentation documentation.
The following system properties set configuration options and have environment variable equivalents. If the same key type is set for both, the system property configuration takes priority. System properties can be set as JVM flags.
dd.serviceDD_SERVICEunnamed-java-appmy-java-appdd.envDD_ENVnonelocal, cidd.trace.agent.urlhttp://hostname:port.DD_TRACE_AGENT_URLhttp://localhost:8126All other Datadog Tracer configuration options can also be used.
Important: You may want to enable more integrations if you have integration tests. To enable a specific integration, use the Datadog Tracer Compatibility table to create your custom setup for your integration tests.
For example, to enable OkHttp3 client request integration, add -Ddd.integration.okhttp-3.enabled=true to your setup.
Datadog uses Git information for visualizing your test results and grouping them by repository, branch, and commit. Git metadata is automatically collected by the test instrumentation from CI provider environment variables and the local .git folder in the project path, if available.
If you are running tests in non-supported CI providers or with no .git folder, you can set the Git information manually using environment variables. These environment variables take precedence over any auto-detected information. Set the following environment variables to provide Git information:
DD_GIT_REPOSITORY_URLgit@github.com:MyCompany/MyApp.git, https://github.com/MyCompany/MyApp.gitDD_GIT_BRANCHdevelopDD_GIT_TAG1.0.1DD_GIT_COMMIT_SHAa18ebf361cc831f5535e58ec4fae04ffd98d8152DD_GIT_COMMIT_MESSAGESet release numberDD_GIT_COMMIT_AUTHOR_NAMEJohn SmithDD_GIT_COMMIT_AUTHOR_EMAILjohn@example.comDD_GIT_COMMIT_AUTHOR_DATE2021-03-12T16:00:28ZDD_GIT_COMMIT_COMMITTER_NAMEJane SmithDD_GIT_COMMIT_COMMITTER_EMAILjane@example.comDD_GIT_COMMIT_COMMITTER_DATE2021-03-12T16:00:28ZIf the tests are not appearing in Datadog, ensure that you are using version 0.91.0 or greater of the Java tracer.
The -Ddd.civisibility.enabled=true configuration property is only available since that version.
If you need to use a previous version of the tracer, you can configure CI Visibility by using the following system properties:
-Ddd.prioritization.type=ENSURE_TRACE -Ddd.jmxfetch.enabled=false -Ddd.integrations.enabled=false -Ddd.integration.junit.enabled=true -Ddd.integration.testng.enabled=trueAdditional helpful documentation, links, and articles:
