Track service name source (#10607)

wip

Fix tests and finalise implementation

Add ability to add extra tags for controller spans

Enforce usage of new signature

codenarc

Fix tests

Add base tests

Use the real integration name for the preferred service name source

muzzle

Fix leftover rename

Merge branch 'master' into andrea.marziali/serviename-integration

Co-authored-by: devflow.devflow-routing-intake <devflow.devflow-routing-intake@kubernetes.us1.ddbuild.io>

Author: amarziali

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/instrumentation/decorator/ClientDecorator.java

@@ -13,8 +13,9 @@ protected String spanKind() {
 
   @Override
   public AgentSpan afterStart(final AgentSpan span) {
-    if (service() != null) {
-      span.setServiceName(service());
+    final String service = service();
+    if (service != null) {
+      span.setServiceName(service, component());
     }
     span.setTag(Tags.SPAN_KIND, spanKind());
 

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/instrumentation/decorator/DatabaseClientDecorator.java

@@ -76,7 +76,7 @@ public AgentSpan onConnection(final AgentSpan span, final CONNECTION connection)
         span.setTag(Tags.PEER_HOSTNAME, hostName);
 
         if (Config.get().isDbClientSplitByHost()) {
-          span.setServiceName(hostName.toString());
+          span.setServiceName(hostName.toString(), component());
         }
       }
     }
@@ -88,7 +88,7 @@ protected AgentSpan onInstance(final AgentSpan span, final String dbInstance) {
       span.setTag(Tags.DB_INSTANCE, dbInstance);
       String serviceName = dbClientService(dbInstance);
       if (null != serviceName) {
-        span.setServiceName(serviceName);
+        span.setServiceName(serviceName, component());
       }
     }
     return span;

dd-java-agent/agent-bootstrap/src/main/java/datadog/trace/bootstrap/instrumentation/decorator/UriBasedClientDecorator.java

@@ -19,7 +19,7 @@ public void onURI(@Nonnull final AgentSpan span, @Nonnull final URI uri) {
     if (null != host && !host.isEmpty()) {
       span.setTag(Tags.PEER_HOSTNAME, host);
       if (Config.get().isHttpClientSplitByDomain() && host.charAt(0) >= 'A') {
-        span.setServiceName(host);
+        span.setServiceName(host, component());
       }
       if (port > 0) {
         setPeerPort(span, port);

dd-java-agent/agent-bootstrap/src/test/groovy/datadog/trace/bootstrap/instrumentation/decorator/BaseDecoratorTest.groovy

@@ -31,7 +31,7 @@ class BaseDecoratorTest extends DDSpecification {
     _ * span.setTag(_, _) // Want to allow other calls from child implementations.
     _ * span.setMeasured(true)
     _ * span.setMetric(_, _)
-    _ * span.setServiceName(_)
+    _ * span.setServiceName(_, _)
     _ * span.setOperationName(_)
     _ * span.setSamplingPriority(_)
     0 * _

dd-java-agent/agent-bootstrap/src/test/groovy/datadog/trace/bootstrap/instrumentation/decorator/ClientDecoratorTest.groovy

@@ -19,7 +19,7 @@ class ClientDecoratorTest extends BaseDecoratorTest {
 
     then:
     if (serviceName != null) {
-      1 * span.setServiceName(serviceName)
+      1 * span.setServiceName(serviceName, "test-component")
     }
     1 * span.setMeasured(true)
     1 * span.setTag(Tags.COMPONENT, "test-component")

dd-java-agent/agent-bootstrap/src/test/groovy/datadog/trace/bootstrap/instrumentation/decorator/DBTypeProcessingDatabaseClientDecoratorTest.groovy

@@ -20,7 +20,7 @@ class DBTypeProcessingDatabaseClientDecoratorTest extends ClientDecoratorTest {
 
     then:
     if (serviceName != null) {
-      1 * span.setServiceName(serviceName)
+      1 * span.setServiceName(serviceName, "test-component")
     }
     1 * span.setMeasured(true)
     1 * span.setTag(Tags.COMPONENT, "test-component")

dd-java-agent/agent-bootstrap/src/test/groovy/datadog/trace/bootstrap/instrumentation/decorator/DatabaseClientDecoratorTest.groovy

@@ -23,7 +23,7 @@ class DatabaseClientDecoratorTest extends ClientDecoratorTest {
 
     then:
     if (serviceName != null) {
-      1 * span.setServiceName(serviceName)
+      1 * span.setServiceName(serviceName, "test-component")
     }
     1 * span.setMeasured(true)
     1 * span.setTag(Tags.COMPONENT, "test-component")
@@ -58,11 +58,11 @@ class DatabaseClientDecoratorTest extends ClientDecoratorTest {
         1 * span.setTag(Tags.PEER_HOSTNAME, session.hostname)
       }
       if (instanceTypeSuffix && renameByInstance && session.instance) {
-        1 * span.setServiceName(session.instance + "-" + decorator.dbType())
+        1 * span.setServiceName(session.instance + "-" + decorator.dbType(), _)
       } else if (renameByInstance && session.instance) {
-        1 * span.setServiceName(session.instance)
+        1 * span.setServiceName(session.instance, _)
       } else if (renameByHost) {
-        1 * span.setServiceName(session.hostname)
+        1 * span.setServiceName(session.hostname, _)
       }
     }
     0 * _

dd-java-agent/agent-bootstrap/src/test/groovy/datadog/trace/bootstrap/instrumentation/decorator/HttpClientDecoratorTest.groovy

@@ -72,7 +72,7 @@ class HttpClientDecoratorTest extends ClientDecoratorTest {
       1 * span.setTag(Tags.PEER_PORT, req.url.port)
       1 * span.setResourceName({ it as String == req.method.toUpperCase() + " " + req.path }, ResourceNamePriorities.HTTP_PATH_NORMALIZER)
       if (renameService) {
-        1 * span.setServiceName(req.url.host)
+        1 * span.setServiceName(req.url.host, _)
       }
       1 * span.traceConfig() >> AgentTracer.traceConfig()
     }
@@ -147,7 +147,7 @@ class HttpClientDecoratorTest extends ClientDecoratorTest {
 
     then:
     if (expectedServiceName) {
-      1 * span.setServiceName(expectedServiceName)
+      1 * span.setServiceName(expectedServiceName, _)
     }
     if (url != null) {
       1 * span.setResourceName(_, _)

dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/InstrumentationSpecification.groovy

@@ -41,6 +41,7 @@ import datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers
 import datadog.trace.agent.tooling.bytebuddy.matcher.GlobalIgnores
 import datadog.trace.api.Config
 import datadog.trace.api.IdGenerationStrategy
+import datadog.trace.api.Pair
 import datadog.trace.api.ProcessTags
 import datadog.trace.api.TraceConfig
 import datadog.trace.api.config.GeneralConfig
@@ -240,7 +241,7 @@ abstract class InstrumentationSpecification extends DDSpecification implements A
       return null
     }
     @Override
-    String getPreferredServiceName() {
+    Pair<String, CharSequence> getPreferredServiceNameAndSource() {
       return null
     }
 

dd-java-agent/instrumentation-testing/src/main/groovy/datadog/trace/agent/test/TrackingSpanDecorator.groovy

@@ -13,6 +13,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentSpanLink
 import datadog.trace.core.DDSpan
 
 import java.util.concurrent.ConcurrentHashMap
+import javax.annotation.Nonnull
 
 /**
  * Decorator for {@link AgentSpan} that keeps track of the decorated span's finish location.
@@ -344,6 +345,11 @@ class TrackingSpanDecorator implements AgentSpan {
     return delegate.setServiceName(serviceName)
   }
 
+  @Override
+  void setServiceName(@Nonnull String serviceName, @Nonnull CharSequence source) {
+    delegate.setServiceName(serviceName, source)
+  }
+
   @Override
   CharSequence getResourceName() {
     return delegate.getResourceName()