address reviewer comments and add test agent to documentation

wconti27 · wconti27 · commit 4beb41a89a6f · 2023-06-06T16:04:11.000-04:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -212,3 +212,19 @@ To run tests on a different JVM than the one used for doing the build, you need
 2) A command line option to the gradle task on the form `-PtestJvm=[JDKNAME]`, i.e. `-PtestJvm=ZULU15`
 
 Please note that the JDK name needs to end with the JDK version, i.e. `11`, `ZULU15`, `ORACLE8`, et.c.
+
+## The APM Test Agent
+
+The APM test agent emulates the APM endpoints of the Datadog Agent. The Test Agent container runs alongside Java tracer
+Instrumentation Tests in CI, handling all traces during test runs and performing a number of `Trace Checks`. Trace
+Check results are returned within the `Get APM Test Agent Trace Check Results` step for all instrumentation test jobs.
+
+For more information on Trace Checks, see:
+https://github.com/DataDog/dd-apm-test-agent#trace-invariant-checks
+
+The APM Test Agent also emits helpful logging, including logging received traces' headers, spans, errors encountered,
+ands information on trace checks being performed. Logs can be viewed in CircleCI within the Test-Agent container step
+for all instrumentation test suites, ie: `z_test_8_inst` job
+
+Read more about the APM Test Agent:
+https://github.com/datadog/dd-apm-test-agent#readme
diff --git a/dd-java-agent/testing/src/main/groovy/datadog/trace/agent/test/AgentTestRunner.groovy b/dd-java-agent/testing/src/main/groovy/datadog/trace/agent/test/AgentTestRunner.groovy
@@ -14,16 +14,14 @@ import datadog.trace.agent.tooling.AgentInstaller
 import datadog.trace.agent.tooling.Instrumenter
 import datadog.trace.agent.tooling.TracerInstaller
 import datadog.trace.agent.tooling.bytebuddy.matcher.GlobalIgnores
-import datadog.trace.api.Config
-import datadog.trace.api.DDSpanId
-import datadog.trace.api.IdGenerationStrategy
-import datadog.trace.api.StatsDClient
-import datadog.trace.api.WellKnownTags
+import datadog.trace.api.*
 import datadog.trace.api.config.TracerConfig
 import datadog.trace.api.time.SystemTimeSource
 import datadog.trace.bootstrap.ActiveSubsystems
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer.TracerAPI
+import datadog.trace.bootstrap.instrumentation.api.DataStreamsMonitoring
+import datadog.trace.bootstrap.instrumentation.api.NoopDataStreamsMonitoring
 import datadog.trace.common.metrics.EventListener
 import datadog.trace.common.metrics.Sink
 import datadog.trace.common.writer.DDAgentWriter
@@ -32,9 +30,7 @@ import datadog.trace.common.writer.ddagent.DDAgentApi
 import datadog.trace.core.CoreTracer
 import datadog.trace.core.DDSpan
 import datadog.trace.core.PendingTrace
-import datadog.trace.bootstrap.instrumentation.api.DataStreamsMonitoring
 import datadog.trace.core.datastreams.DefaultDataStreamsMonitoring
-import datadog.trace.bootstrap.instrumentation.api.NoopDataStreamsMonitoring
 import datadog.trace.test.util.DDSpecification
 import datadog.trace.util.Strings
 import de.thetaphi.forbiddenapis.SuppressForbidden
@@ -61,10 +57,9 @@ import java.util.concurrent.TimeoutException
 import java.util.concurrent.atomic.AtomicInteger
 
 import static datadog.communication.http.OkHttpUtils.buildHttpClient
-import static datadog.trace.api.ConfigDefaults.DEFAULT_AGENT_HOST
-import static datadog.trace.api.ConfigDefaults.DEFAULT_AGENT_TIMEOUT
-import static datadog.trace.api.ConfigDefaults.DEFAULT_TRACE_AGENT_PORT
+import static datadog.trace.api.ConfigDefaults.*
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.closePrevious
+
 /**
  * A spock test runner which automatically applies instrumentation and exposes a global trace
  * writer.
@@ -100,7 +95,7 @@ abstract class AgentTestRunner extends DDSpecification implements AgentBuilder.L
           .append("=").append(entry.getValue()).append(",")
       }
     }
-    ddEnvVars.append("DD_SERVICE").append("=").append(Config.get().getServiceName())
+    ddEnvVars.append("DD_SERVICE=").append(Config.get().getServiceName())
 
     if (ddEnvVars.length() > 0) {
       agentapi.setHeader("X-Datadog-Trace-Env-Variables", ddEnvVars.toString())
