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):
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):
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:
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-civisibility
Configure 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:
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-tasks
Note: As Gradle builds can be customizable programmatically, you may need to adapt these steps to your specific build configuration.
Configuration settings
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.service
Name of the service or library under test. Environment variable: DD_SERVICE Default: unnamed-java-app Example: my-java-app
dd.env
Name of the environment where tests are being run. Environment variable: DD_ENV Default: none Examples: local, ci
dd.trace.agent.url
Datadog Agent URL for trace collection in the form http://hostname:port. Environment variable: DD_TRACE_AGENT_URL Default: http://localhost:8126
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.
Collecting Git metadata
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_URL
URL of the repository where the code is stored. Both HTTP and SSH URLs are supported. Example: git@github.com:MyCompany/MyApp.git, https://github.com/MyCompany/MyApp.git
DD_GIT_BRANCH
Git branch being tested. Leave empty if providing tag information instead. Example: develop
DD_GIT_TAG
Git tag being tested (if applicable). Leave empty if providing branch information instead. Example: 1.0.1
DD_GIT_COMMIT_SHA
Full commit hash. Example: a18ebf361cc831f5535e58ec4fae04ffd98d8152
DD_GIT_COMMIT_MESSAGE
Commit message. Example: Set release number
DD_GIT_COMMIT_AUTHOR_NAME
Commit author name. Example: John Smith
DD_GIT_COMMIT_AUTHOR_EMAIL
Commit author email. Example: john@example.com
DD_GIT_COMMIT_AUTHOR_DATE
Commit author date in ISO 8601 format. Example: 2021-03-12T16:00:28Z
DD_GIT_COMMIT_COMMITTER_NAME
Commit committer name. Example: Jane Smith
DD_GIT_COMMIT_COMMITTER_EMAIL
Commit committer email. Example: jane@example.com
DD_GIT_COMMIT_COMMITTER_DATE
Commit committer date in ISO 8601 format. Example: 2021-03-12T16:00:28Z
Troubleshooting
The tests are not appearing in Datadog after enabling CI Visibility in the tracer
If 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: