Do not set contextual service name if jee-split-by-deployment is not enabled

amarziali · amarziali · commit 8760af662e51 · 2025-01-10T11:38:12.000+01:00
diff --git a/dd-java-agent/instrumentation/jboss-modules/src/main/java/datadog/trace/instrumentation/jbossmodules/ModuleInstrumentation.java b/dd-java-agent/instrumentation/jboss-modules/src/main/java/datadog/trace/instrumentation/jbossmodules/ModuleInstrumentation.java
@@ -164,8 +164,7 @@ public static class CaptureModuleNameAdvice {
     public static void afterConstruct(@Advice.This final Module module) {
       final String name = ModuleNameHelper.extractDeploymentName(module.getClassLoader());
       if (name != null && !name.isEmpty()) {
-        ClassloaderConfigurationOverrides.addContextualInfo(
-            module.getClassLoader(), new ClassloaderConfigurationOverrides.ContextualInfo(name));
+        ClassloaderConfigurationOverrides.withPinnedServiceName(module.getClassLoader(), name);
       }
     }
   }
diff --git a/dd-java-agent/instrumentation/liberty-20/src/main/java/datadog/trace/instrumentation/liberty20/ThreadContextClassloaderInstrumentation.java b/dd-java-agent/instrumentation/liberty-20/src/main/java/datadog/trace/instrumentation/liberty20/ThreadContextClassloaderInstrumentation.java
@@ -40,8 +40,7 @@ public static class ThreadContextClassloaderAdvice {
     public static void afterConstruct(@Advice.This ThreadContextClassLoader self) {
       final String name = BundleNameHelper.extractDeploymentName(self);
       if (name != null && !name.isEmpty()) {
-        ClassloaderConfigurationOverrides.addContextualInfo(
-            self, new ClassloaderConfigurationOverrides.ContextualInfo(name));
+        ClassloaderConfigurationOverrides.withPinnedServiceName(self, name);
       }
     }
   }
diff --git a/dd-java-agent/instrumentation/tomcat-classloading-9/src/main/java/datadog/trace/instrumentation/tomcat9/WebappClassLoaderInstrumentation.java b/dd-java-agent/instrumentation/tomcat-classloading-9/src/main/java/datadog/trace/instrumentation/tomcat9/WebappClassLoaderInstrumentation.java
@@ -9,6 +9,8 @@
 import datadog.trace.agent.tooling.Instrumenter;
 import datadog.trace.agent.tooling.InstrumenterModule;
 import datadog.trace.api.ClassloaderConfigurationOverrides;
+import java.util.HashMap;
+import java.util.Map;
 import net.bytebuddy.asm.Advice;
 import org.apache.catalina.Context;
 import org.apache.catalina.WebResourceRoot;
@@ -47,14 +49,12 @@ public static void onContextAvailable(
 
       final String contextName = context.getBaseName();
       if (contextName != null && !contextName.isEmpty()) {
-        info = new ClassloaderConfigurationOverrides.ContextualInfo(contextName);
+        info = ClassloaderConfigurationOverrides.withPinnedServiceName(classLoader, contextName);
       }
       if (context.getNamingResources() != null) {
         final ContextEnvironment[] envs = context.getNamingResources().findEnvironments();
         if (envs != null) {
-          if (info == null) {
-            info = new ClassloaderConfigurationOverrides.ContextualInfo(null);
-          }
+          final Map<String, String> tags = new HashMap<>();
           for (final ContextEnvironment env : envs) {
             // as a limitation here we simplify a lot the logic and we do not try to resolve the
             // typed value but we just take the string representation. It avoids implementing the
@@ -70,14 +70,17 @@ public static void onContextAvailable(
               name = env.getName().substring(DATADOG_TAGS_JNDI_PREFIX.length());
             }
             if (name != null && !name.isEmpty()) {
-              info.addTag(name, env.getValue());
+              tags.put(name, env.getValue());
+            }
+          }
+          if (!tags.isEmpty()) {
+            if (info == null) {
+              info = ClassloaderConfigurationOverrides.maybeCreateContextualInfo(classLoader);
             }
+            tags.forEach(info::addTag);
           }
         }
       }
-      if (info != null) {
-        ClassloaderConfigurationOverrides.addContextualInfo(classLoader, info);
-      }
     }
   }
 }
diff --git a/internal-api/src/main/java/datadog/trace/api/ClassloaderConfigurationOverrides.java b/internal-api/src/main/java/datadog/trace/api/ClassloaderConfigurationOverrides.java
@@ -81,6 +81,16 @@ public static ContextualInfo maybeCreateContextualInfo(ClassLoader classLoader)
     }
   }
 
+  @Nullable
+  public static ContextualInfo withPinnedServiceName(ClassLoader classLoader, String serviceName) {
+    if (!CAN_SPLIT_SERVICE_NAME_BY_DEPLOYMENT) {
+      return null;
+    }
+    final ContextualInfo contextualInfo = new ContextualInfo(serviceName);
+    addContextualInfo(classLoader, contextualInfo);
+    return contextualInfo;
+  }
+
   @Nullable
   public static ContextualInfo maybeGetContextualInfo(ClassLoader classLoader) {
     if (atLeastOneEntry) {

Original file line number	Diff line number	Diff line change
`@@ -164,8 +164,7 @@ public static class CaptureModuleNameAdvice {`
`164`	`164`	`public static void afterConstruct(@Advice.This final Module module) {`
`165`	`165`	`final String name = ModuleNameHelper.extractDeploymentName(module.getClassLoader());`
`166`	`166`	`if (name != null && !name.isEmpty()) {`
`167`		`- ClassloaderConfigurationOverrides.addContextualInfo(`
`168`		`- module.getClassLoader(), new ClassloaderConfigurationOverrides.ContextualInfo(name));`
	`167`	`+ ClassloaderConfigurationOverrides.withPinnedServiceName(module.getClassLoader(), name);`
`169`	`168`	`}`
`170`	`169`	`}`
`171`	`170`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,7 @@ public static class ThreadContextClassloaderAdvice {`
`40`	`40`	`public static void afterConstruct(@Advice.This ThreadContextClassLoader self) {`
`41`	`41`	`final String name = BundleNameHelper.extractDeploymentName(self);`
`42`	`42`	`if (name != null && !name.isEmpty()) {`
`43`		`- ClassloaderConfigurationOverrides.addContextualInfo(`
`44`		`- self, new ClassloaderConfigurationOverrides.ContextualInfo(name));`
	`43`	`+ ClassloaderConfigurationOverrides.withPinnedServiceName(self, name);`
`45`	`44`	`}`
`46`	`45`	`}`
`47`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`import datadog.trace.agent.tooling.Instrumenter;`
`10`	`10`	`import datadog.trace.agent.tooling.InstrumenterModule;`
`11`	`11`	`import datadog.trace.api.ClassloaderConfigurationOverrides;`
	`12`	`+import java.util.HashMap;`
	`13`	`+import java.util.Map;`
`12`	`14`	`import net.bytebuddy.asm.Advice;`
`13`	`15`	`import org.apache.catalina.Context;`
`14`	`16`	`import org.apache.catalina.WebResourceRoot;`
`@@ -47,14 +49,12 @@ public static void onContextAvailable(`
`47`	`49`
`48`	`50`	`final String contextName = context.getBaseName();`
`49`	`51`	`if (contextName != null && !contextName.isEmpty()) {`
`50`		`- info = new ClassloaderConfigurationOverrides.ContextualInfo(contextName);`
	`52`	`+ info = ClassloaderConfigurationOverrides.withPinnedServiceName(classLoader, contextName);`
`51`	`53`	`}`
`52`	`54`	`if (context.getNamingResources() != null) {`
`53`	`55`	`final ContextEnvironment[] envs = context.getNamingResources().findEnvironments();`
`54`	`56`	`if (envs != null) {`
`55`		`- if (info == null) {`
`56`		`- info = new ClassloaderConfigurationOverrides.ContextualInfo(null);`
`57`		`- }`
	`57`	`+ final Map<String, String> tags = new HashMap<>();`
`58`	`58`	`for (final ContextEnvironment env : envs) {`
`59`	`59`	`// as a limitation here we simplify a lot the logic and we do not try to resolve the`
`60`	`60`	`// typed value but we just take the string representation. It avoids implementing the`
`@@ -70,14 +70,17 @@ public static void onContextAvailable(`
`70`	`70`	`name = env.getName().substring(DATADOG_TAGS_JNDI_PREFIX.length());`
`71`	`71`	`}`
`72`	`72`	`if (name != null && !name.isEmpty()) {`
`73`		`- info.addTag(name, env.getValue());`
	`73`	`+ tags.put(name, env.getValue());`
	`74`	`+ }`
	`75`	`+ }`
	`76`	`+ if (!tags.isEmpty()) {`
	`77`	`+ if (info == null) {`
	`78`	`+ info = ClassloaderConfigurationOverrides.maybeCreateContextualInfo(classLoader);`
`74`	`79`	`}`
	`80`	`+ tags.forEach(info::addTag);`
`75`	`81`	`}`
`76`	`82`	`}`
`77`	`83`	`}`
`78`		`- if (info != null) {`
`79`		`- ClassloaderConfigurationOverrides.addContextualInfo(classLoader, info);`
`80`		`- }`
`81`	`84`	`}`
`82`	`85`	`}`
`83`	`86`	`}`