Track service name source

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()

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

@@ -225,6 +225,11 @@ abstract class HttpServerTest<SERVER> extends WithHttpServer<SERVER> {
     Collections.emptyMap()
   }
 
+  Map<String, Serializable> expectedExtraControllerTags(ServerEndpoint endpoint) {
+    Collections.emptyMap()
+  }
+
+
   // Only used if hasExtraErrorInformation is true
   Map<String, Serializable> expectedExtraErrorInformation(ServerEndpoint endpoint) {
     if (endpoint.errored) {
@@ -2377,6 +2382,8 @@ abstract class HttpServerTest<SERVER> extends WithHttpServer<SERVER> {
   void controllerSpan(TraceAssert trace, ServerEndpoint endpoint = null) {
     def exception = endpoint == CUSTOM_EXCEPTION ? expectedCustomExceptionType() : expectedExceptionType()
     def errorMessage = endpoint?.body
+    def extraTags = expectedExtraControllerTags(endpoint)
+
     trace.span {
       operationName "controller"
       resourceName "controller"
@@ -2386,6 +2393,7 @@ abstract class HttpServerTest<SERVER> extends WithHttpServer<SERVER> {
         if (errorMessage) {
           errorTags(exception, errorMessage)
         }
+        addTags(extraTags)
         defaultTags()
       }
     }
@@ -2498,11 +2506,11 @@ abstract class HttpServerTest<SERVER> extends WithHttpServer<SERVER> {
         //        if (endpoint.fragment) {
         //          "$DDTags.HTTP_FRAGMENT" endpoint.fragment
         //        }
-        defaultTags(true)
         addTags(expectedExtraServerTags)
         if (extraTags) {
           it.addTags(extraTags)
         }
+        defaultTags(true)
       }
     }
   }

dd-java-agent/instrumentation/aerospike-4.0/src/main/java/datadog/trace/instrumentation/aerospike4/AerospikeClientDecorator.java

@@ -81,7 +81,7 @@ public AgentSpan onConnection(
       }
       span.setTag(Tags.DB_INSTANCE, instanceName);
       if (Config.get().isDbClientSplitByInstance()) {
-        span.setServiceName(instanceName);
+        span.setServiceName(instanceName, component());
       }
     }
 

dd-java-agent/instrumentation/aws-java/aws-java-sdk-1.11/src/main/java/datadog/trace/instrumentation/aws/v0/AwsSdkClientDecorator.java

@@ -44,6 +44,8 @@ public class AwsSdkClientDecorator extends HttpClientDecorator<Request, Response
   public static final boolean SQS_LEGACY_TRACING = Config.get().isSqsLegacyTracingEnabled();
 
   private static final String SQS_SERVICE_NAME =
+      // this is probably wrong since it should use SpanNaming.instance()...
+      // but at this point changing the naming will be a breaking change
       AWS_LEGACY_TRACING || SQS_LEGACY_TRACING ? "sqs" : Config.get().getServiceName();
 
   private static final String SNS_SERVICE_NAME =
@@ -106,19 +108,17 @@ public AgentSpan onRequest(final AgentSpan span, final Request request) {
       case "SQS.ReceiveMessage":
       case "SQS.DeleteMessage":
       case "SQS.DeleteMessageBatch":
-        if (SQS_SERVICE_NAME != null) {
-          span.setServiceName(SQS_SERVICE_NAME);
-        }
+        span.setServiceName(SQS_SERVICE_NAME, component());
         break;
       case "SNS.Publish":
       case "SNS.PublishBatch":
         if (SNS_SERVICE_NAME != null) {
-          span.setServiceName(SNS_SERVICE_NAME);
+          span.setServiceName(SNS_SERVICE_NAME, component());
         }
         break;
       default:
         if (GENERIC_SERVICE_NAME != null) {
-          span.setServiceName(GENERIC_SERVICE_NAME);
+          span.setServiceName(GENERIC_SERVICE_NAME, component());
         }
         break;
     }

dd-java-agent/instrumentation/aws-java/aws-java-sdk-1.11/src/test/groovy/AWS1ClientTest.groovy

@@ -183,6 +183,11 @@ abstract class AWS1ClientTest extends VersionedNamingTestBase {
             for (def addedTag : additionalTags) {
               "$addedTag.key" "$addedTag.value"
             }
+            if (operation == "SendMessage") {
+              // this is a corner case. The issues is that the aws integration should not set the service name
+              // but it's doing it.
+              serviceNameSource "java-aws-sdk"
+            }
             if (peerService == null) {
               defaultTagsNoPeerService()
             } else {
@@ -462,6 +467,12 @@ abstract class AWS1ClientTest extends VersionedNamingTestBase {
             "peer.service" "${server.address.host}:${server.address.port}"
             "_dd.peer.service.source" "peer.service"
 
+            if (operation == "SendMessage") {
+              // this is a corner case. The issues is that the aws integration should not set the service name
+              // but it's doing it.
+              serviceNameSource "java-aws-sdk"
+            }
+
             defaultTags(false, true)
           }
         }

dd-java-agent/instrumentation/aws-java/aws-java-sdk-2.2/src/main/java/datadog/trace/instrumentation/aws/v2/AwsSdkClientDecorator.java

@@ -242,18 +242,18 @@ private static AgentSpan onOperation(
       case "Sqs.DeleteMessage":
       case "Sqs.DeleteMessageBatch":
         if (SQS_SERVICE_NAME != null) {
-          span.setServiceName(SQS_SERVICE_NAME);
+          span.setServiceName(SQS_SERVICE_NAME, COMPONENT_NAME);
         }
         break;
       case "Sns.PublishBatch":
       case "Sns.Publish":
         if (SNS_SERVICE_NAME != null) {
-          span.setServiceName(SNS_SERVICE_NAME);
+          span.setServiceName(SNS_SERVICE_NAME, COMPONENT_NAME);
         }
         break;
       default:
         if (GENERIC_SERVICE_NAME != null) {
-          span.setServiceName(GENERIC_SERVICE_NAME);
+          span.setServiceName(GENERIC_SERVICE_NAME, COMPONENT_NAME);
         }
         break;
     }

dd-java-agent/instrumentation/aws-java/aws-java-sdk-2.2/src/test/groovy/Aws2ClientTest.groovy

@@ -174,6 +174,11 @@ abstract class Aws2ClientTest extends VersionedNamingTestBase {
               checkPeerService = true
             }
             urlTags("${server.address}${path}", ExpectedQueryParams.getExpectedQueryParams(operation))
+            if (operation == "SendMessage") {
+              // this is a corner case. The issues is that the aws integration should not set the service name
+              // but it's doing it.
+              serviceNameSource "java-aws-sdk"
+            }
             defaultTags(false, checkPeerService)
           }
         }
@@ -309,6 +314,11 @@ abstract class Aws2ClientTest extends VersionedNamingTestBase {
               checkPeerService = true
             }
             urlTags("${server.address}${path}", ExpectedQueryParams.getExpectedQueryParams(operation))
+            if (operation == "SendMessage") {
+              // this is a corner case. The issues is that the aws integration should not set the service name
+              // but it's doing it.
+              serviceNameSource "java-aws-sdk"
+            }
             defaultTags(false, checkPeerService)
           }
         }
@@ -468,6 +478,11 @@ abstract class Aws2ClientTest extends VersionedNamingTestBase {
           measured true
           parent()
           tags {
+            if (operation == "SendMessage") {
+              // this is a corner case. The issues is that the aws integration should not set the service name
+              // but it's doing it.
+              serviceNameSource "java-aws-sdk"
+            }
             defaultTags(false, true)
 
             // AWS specific tags

dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/test/groovy/SqsClientTest.groovy

@@ -136,6 +136,7 @@ abstract class SqsClientTest extends VersionedNamingTestBase {
             if ({ isDataStreamsEnabled() }) {
               "$DDTags.PATHWAY_HASH" { String }
             }
+            serviceNameSource("java-aws-sdk")
             defaultTags()
           }
         }
@@ -410,6 +411,7 @@ abstract class SqsClientTest extends VersionedNamingTestBase {
             "aws.operation" "SendMessageRequest"
             "aws.agent" "java-aws-sdk"
             "aws.queue.url" "http://localhost:${address.port}/000000000000/somequeue"
+            serviceNameSource("java-aws-sdk")
             defaultTags()
           }
         }
@@ -477,6 +479,7 @@ abstract class SqsClientTest extends VersionedNamingTestBase {
             "aws.operation" "DeleteMessageRequest"
             "aws.agent" "java-aws-sdk"
             "aws.queue.url" "http://localhost:${address.port}/000000000000/somequeue"
+            serviceNameSource("java-aws-sdk")
             defaultTags()
           }
         }

dd-java-agent/instrumentation/aws-java/aws-java-sqs-1.0/src/test/groovy/TimeInQueueForkedTest.groovy

@@ -283,6 +283,7 @@ class TimeInQueueForkedTest extends InstrumentationSpecification {
         "aws.operation" "SendMessageBatchRequest"
         "aws.agent" "java-aws-sdk"
         "aws.queue.url" "http://localhost:${address.port}/000000000000/somequeue"
+        serviceNameSource("java-aws-sdk")
         defaultTags()
       }
     }
@@ -305,6 +306,9 @@ class TimeInQueueForkedTest extends InstrumentationSpecification {
         "aws.operation" "ReceiveMessageRequest"
         "aws.agent" "java-aws-sdk"
         "aws.queue.url" "http://localhost:${address.port}/000000000000/somequeue"
+        // the receive instrumentation always do setInstrumentationServiceName
+        // even when == to DD_SERVICE
+        serviceNameSource("java-aws-sdk")
         defaultTags(parent.resourceName as String == "SQS.SendMessageBatch")
       }
     }
@@ -323,6 +327,7 @@ class TimeInQueueForkedTest extends InstrumentationSpecification {
         "$Tags.COMPONENT" "java-aws-sdk"
         "$Tags.SPAN_KIND" Tags.SPAN_KIND_BROKER
         "aws.queue.url" "http://localhost:${address.port}/000000000000/somequeue"
+        serviceNameSource("java-aws-sdk")
         defaultTags(true)
       }
     }

dd-java-agent/instrumentation/aws-java/aws-java-sqs-2.0/src/test/groovy/SqsClientTest.groovy

@@ -135,6 +135,7 @@ abstract class SqsClientTest extends VersionedNamingTestBase {
               "$DDTags.PATHWAY_HASH" { String }
             }
             urlTags("http://localhost:${address.port}/", ExpectedQueryParams.getExpectedQueryParams("SendMessage"))
+            serviceNameSource("java-aws-sdk")
             defaultTags()
           }
         }
@@ -366,6 +367,7 @@ abstract class SqsClientTest extends VersionedNamingTestBase {
             "aws.queue.url" "http://localhost:${address.port}/000000000000/somequeue"
             "aws.requestId" "00000000-0000-0000-0000-000000000000"
             urlTags("http://localhost:${address.port}/", ExpectedQueryParams.getExpectedQueryParams("SendMessage"))
+            serviceNameSource("java-aws-sdk")
             defaultTags()
           }
         }
@@ -435,6 +437,7 @@ abstract class SqsClientTest extends VersionedNamingTestBase {
             "aws.queue.url" "http://localhost:${address.port}/000000000000/somequeue"
             "aws.requestId" { it.trim() == "00000000-0000-0000-0000-000000000000" } // the test server seem messing with request id and insert \n
             urlTags("http://localhost:${address.port}/", ExpectedQueryParams.getExpectedQueryParams("DeleteMessage"))
+            serviceNameSource("java-aws-sdk")
             defaultTags()
           }
         }