Auto-instrumentation runs on the CI executor and does not automatically apply to tests in a separate container. Before using it for containerized tests, see Tests in Containers.
If the auto-instrumentation step configures the process that runs your tests, you can skip the rest of the setup steps below.
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:
Set these variables before starting the test process. For parallel test runners, set them on the parent process so every worker inherits them.
DD_CIVISIBILITY_AGENTLESS_ENABLED=true selects Agentless mode. DD_API_KEY provides authentication but does not enable Agentless mode.
DD_CIVISIBILITY_AGENTLESS_ENABLED=true (Required for Agentless mode)
Enables Agentless mode to send test results directly to Datadog. Default: false
DD_API_KEY (Required for Agentless mode)
The Datadog API key used to authenticate test result uploads. Default: (empty)
If you use a Datadog site other than US1, set the following variable:
DD_SITE (Optional for Agentless mode)
The Datadog site to upload results to. Default: datadoghq.com
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 it allows you to automatically link test results to logs and underlying host metrics.
If you are using a Kubernetes executor, Datadog recommends using the Datadog Operator.
The operator includes Datadog Admission Controller which can automatically inject the tracer library into the build pods.
Note: If you use the Datadog Operator, there is no need to download and inject the tracer library since the Admission Controller can do this for you, so you can skip the corresponding step below.
However, you still need to make sure that your pods set the environment variables or command-line parameters necessary to enable Test Visibility.
If you are not using Kubernetes or can’t use the Datadog Admission Controller and the CI provider is using a container-based executor, set the DD_TRACE_AGENT_URL environment variable (which defaults to http://localhost:8126) in the build container running the tracer to an endpoint that is accessible from within that container. Note: Using localhost inside the build references the container itself and not the underlying worker node or any container where the Agent might be running in.
DD_TRACE_AGENT_URL includes the protocol and port (for example, http://localhost:8126) and takes precedence over DD_AGENT_HOST and DD_TRACE_AGENT_PORT, and is the recommended configuration parameter to configure the Datadog Agent’s URL for CI Visibility.
If you still have issues connecting to the Datadog Agent, use the Agentless Mode.
Note: When using this method, tests are not correlated with logs and infrastructure metrics.
SDK のダウンロード
SDK のダウンロードは、サーバーごとに 1 回だけ行う必要があります。
SDK がすでにサーバー上にローカルで存在する場合、直接テストの実行に進むことができます。
ダウンロードしたトレーサー JAR を保存するフォルダーへのパスで、DD_TRACER_FOLDER 変数を宣言します。
unit-tests、integration-tests、smoke-tests などのテストグループを識別します。 デフォルト: CI ジョブ名とテストコマンド、または CI ジョブ名が利用できない場合はテストコマンド。 例: unit-tests、integration-tests、smoke-tests
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
importio.opentelemetry.api.trace.Span;// ...// inside your testSpanspan=Span.current();span.setAttribute("test_owner","my_team");// test continues normally// ...
importio.opentracing.Span;importio.opentracing.util.GlobalTracer;// ...// inside your testfinalSpanspan=GlobalTracer.get().activeSpan();if(span!=null){span.setTag("test_owner","my_team");}// test continues normally// ...
これらのタグに対してフィルターや group by フィールドを作成するには、まずファセットを作成する必要があります。
importio.opentelemetry.api.trace.Span;// ...// inside your testSpanspan=Span.current();span.setAttribute("test.memory.usage",1e8);// test continues normally// ...
importio.opentracing.Span;importio.opentracing.util.GlobalTracer;// ...// inside your testfinalSpanspan=GlobalTracer.get().activeSpan();if(span!=null){span.setTag("test.memory.usage",1e8);}// test continues normally// ...
packagecom.datadog.civisibility.example;importdatadog.trace.api.civisibility.CIVisibility;importdatadog.trace.api.civisibility.DDTest;importdatadog.trace.api.civisibility.DDTestModule;importdatadog.trace.api.civisibility.DDTestSession;importdatadog.trace.api.civisibility.DDTestSuite;importjava.lang.reflect.Method;// the null arguments in the calls below are optional startTime/endTime values:// when they are not specified, current time is usedpublicclassManualTest{publicstaticvoidmain(String[]args)throwsException{DDTestSessiontestSession=CIVisibility.startSession("my-project-name","my-test-framework",null);testSession.setTag("my-tag","additional-session-metadata");try{runTestModule(testSession);}finally{testSession.end(null);}}privatestaticvoidrunTestModule(DDTestSessiontestSession)throwsException{DDTestModuletestModule=testSession.testModuleStart("my-module",null);testModule.setTag("my-module-tag","additional-module-metadata");try{runFirstTestSuite(testModule);runSecondTestSuite(testModule);}finally{testModule.end(null);}}privatestaticvoidrunFirstTestSuite(DDTestModuletestModule)throwsException{DDTestSuitetestSuite=testModule.testSuiteStart("my-suite",ManualTest.class,null);testSuite.setTag("my-suite-tag","additional-suite-metadata");try{runTestCase(testSuite);}finally{testSuite.end(null);}}privatestaticvoidrunTestCase(DDTestSuitetestSuite)throwsException{MethodmyTestCaseMethod=ManualTest.class.getDeclaredMethod("myTestCase");DDTestddTest=testSuite.testStart("myTestCase",myTestCaseMethod,null);ddTest.setTag("my-test-case-tag","additional-test-case-metadata");ddTest.setTag("my-test-case-tag","more-test-case-metadata");try{myTestCase();}catch(Exceptione){ddTest.setErrorInfo(e);// pass error info to mark test case as failed}finally{ddTest.end(null);}}privatestaticvoidmyTestCase()throwsException{// run some test logic}privatestaticvoidrunSecondTestSuite(DDTestModuletestModule){DDTestSuitesecondTestSuite=testModule.testSuiteStart("my-second-suite",ManualTest.class,null);secondTestSuite.setSkipReason("this test suite is skipped");// pass skip reason to mark test suite as skippedsecondTestSuite.end(null);}}
JUnit 5 では、テストパラメーターの値を変更せずに 文字列表現をカスタマイズする ことでも対処できます。
そのためには、org.junit.jupiter.api.Named インターフェースを使用するか、org.junit.jupiter.params.ParameterizedTest アノテーションの name パラメーターを変更してください。
@ParameterizedTest@MethodSource("namedArguments")voidparameterizedTest(Strings,Dated){// The second parameter in this test case is non-deterministic.// In the argument provider method it is wrapped with Named to ensure it has a deterministic name.}staticStream<Arguments>namedArguments(){returnStream.of(Arguments.of("a string",Named.of("current date",newDate())),Arguments.of("another string",Named.of("a date in the future",newDate(System.currentTimeMillis()+TimeUnit.DAYS.toMillis(1)))));}
@ParameterizedTest(name="[{index}] {0}, a random number from one to ten")@MethodSource("randomArguments")voidanotherParameterizedTest(Strings,inti){// The second parameter in this test case is non-deterministic.// The name of the parameterized test is customized to ensure it has a deterministic name.}staticStream<Arguments>randomArguments(){returnStream.of(Arguments.of("a string",ThreadLocalRandom.current().nextInt(10)+1),Arguments.of("another string",ThreadLocalRandom.current().nextInt(10)+1));}
