use customizer that can be easily added by native instrumentations and is added for agent and starter by default

Author: zeitlinger

instrumentation-api-incubator/build.gradle.kts

@@ -22,6 +22,7 @@ dependencies {
 
   testImplementation("io.opentelemetry.javaagent:opentelemetry-testing-common")
   testImplementation("io.opentelemetry:opentelemetry-sdk")
+  testImplementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
   testImplementation("io.opentelemetry.semconv:opentelemetry-semconv-incubating")
 }

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/instrumenter/InstrumenterCustomizer.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.api.incubator.instrumenter;
 
+import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.ContextCustomizer;
@@ -34,6 +35,13 @@ public interface InstrumenterCustomizer {
    */
   String getInstrumentationName();
 
+  /**
+   * Returns the OpenTelemetry instance associated with this instrumenter.
+   *
+   * @return the OpenTelemetry instance
+   */
+  OpenTelemetry getOpenTelemetry();
+
   /**
    * Tests whether given instrumenter produces telemetry of specified type. Instrumentation type is
    * detected based on the standard {@link AttributesExtractor} implementations used by this

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/instrumenter/ThreadDetailsInstrumenterCustomizerProvider.java

@@ -0,0 +1,60 @@
+package io.opentelemetry.instrumentation.api.incubator.instrumenter;
+
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import javax.annotation.Nullable;
+
+import static io.opentelemetry.api.common.AttributeKey.longKey;
+import static io.opentelemetry.api.common.AttributeKey.stringKey;
+import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
+
+public class ThreadDetailsInstrumenterCustomizerProvider implements InstrumenterCustomizerProvider {
+  @Override
+  public void customize(InstrumenterCustomizer customizer) {
+    OpenTelemetry openTelemetry = customizer.getOpenTelemetry();
+    if (openTelemetry instanceof ExtendedOpenTelemetry) {
+      // Declarative config is used.
+      // Otherwise, thread details are configured in
+      // io.opentelemetry.javaagent.tooling.AgentTracerProviderConfigurer.
+
+      DeclarativeConfigProperties instrumentationConfig =
+          ((ExtendedOpenTelemetry) openTelemetry).getConfigProvider().getInstrumentationConfig();
+
+      if (instrumentationConfig != null
+          && instrumentationConfig
+              .getStructured("java", empty())
+              .getStructured("common", empty())
+              .getStructured("thread_details", empty())
+              .getBoolean("enabled", false)) {
+        customizer.addAttributesExtractor(new ThreadDetailsAttributesExtractor<>());
+      }
+    }
+  }
+
+  private static class ThreadDetailsAttributesExtractor<RESPONSE, REQUEST>
+      implements AttributesExtractor<REQUEST, RESPONSE> {
+    // attributes are not stable yet
+    private static final AttributeKey<Long> THREAD_ID = longKey("thread.id");
+    private static final AttributeKey<String> THREAD_NAME = stringKey("thread.name");
+
+    @Override
+    public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
+      Thread currentThread = Thread.currentThread();
+      attributes.put(THREAD_ID, currentThread.getId());
+      attributes.put(THREAD_NAME, currentThread.getName());
+    }
+
+    @Override
+    public void onEnd(
+        AttributesBuilder attributes,
+        Context context,
+        REQUEST request,
+        @Nullable RESPONSE response,
+        @Nullable Throwable error) {}
+  }
+}

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/instrumenter/internal/InstrumenterCustomizerImpl.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.api.incubator.instrumenter.internal;
 
+import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.api.incubator.instrumenter.InstrumenterCustomizer;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.ContextCustomizer;
@@ -47,6 +48,11 @@ public String getInstrumentationName() {
     return customizer.getInstrumentationName();
   }
 
+  @Override
+  public OpenTelemetry getOpenTelemetry() {
+    return customizer.getOpenTelemetry();
+  }
+
   @Override
   public boolean hasType(InstrumentationType type) {
     SpanKey spanKey = typeToSpanKey.get(type);

…i/instrumenter/AddThreadDetailsTest.java …sInstrumenterCustomizerProviderTest.javainstrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/instrumenter/AddThreadDetailsTest.java renamed to instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/instrumenter/ThreadDetailsInstrumenterCustomizerProviderTest.java instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/instrumenter/AddThreadDetailsTest.java renamed to instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/instrumenter/ThreadDetailsInstrumenterCustomizerProviderTest.java

@@ -3,14 +3,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.api.instrumenter;
+package io.opentelemetry.instrumentation.api.incubator.instrumenter;
 
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
 import static java.util.Collections.emptyMap;
 import static java.util.Collections.singletonMap;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationBuilder;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalLanguageSpecificInstrumentationModel;
@@ -28,7 +29,7 @@
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
 
-class AddThreadDetailsTest {
+class ThreadDetailsInstrumenterCustomizerProviderTest {
 
   @RegisterExtension
   static final OpenTelemetryExtension otelTesting = OpenTelemetryExtension.create();

instrumentation-api-incubator/src/test/resources/META-INF/services/io.opentelemetry.instrumentation.api.incubator.instrumenter.InstrumenterCustomizerProvider

@@ -0,0 +1,3 @@
+# added in test resources for testing purposes
+# the real implementation is in sdk-autoconfigure-support module
+io.opentelemetry.instrumentation.api.incubator.instrumenter.ThreadDetailsInstrumenterCustomizerProvider

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterBuilder.java

@@ -5,18 +5,11 @@
 
 package io.opentelemetry.instrumentation.api.instrumenter;
 
-import static io.opentelemetry.api.common.AttributeKey.longKey;
-import static io.opentelemetry.api.common.AttributeKey.stringKey;
-import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
 import static java.util.Objects.requireNonNull;
 import static java.util.logging.Level.WARNING;
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.api.OpenTelemetry;
-import io.opentelemetry.api.common.AttributeKey;
-import io.opentelemetry.api.common.AttributesBuilder;
-import io.opentelemetry.api.incubator.ExtendedOpenTelemetry;
-import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.api.metrics.MeterBuilder;
 import io.opentelemetry.api.trace.SpanKind;
@@ -61,8 +54,6 @@ public final class InstrumenterBuilder<REQUEST, RESPONSE> {
           ConfigPropertiesUtil.getString(
               "otel.instrumentation.experimental.span-suppression-strategy"));
 
-  static boolean isIncubator = isIncubator();
-
   final OpenTelemetry openTelemetry;
   final String instrumentationName;
   SpanNameExtractor<? super REQUEST> spanNameExtractor;
@@ -93,20 +84,6 @@ public final class InstrumenterBuilder<REQUEST, RESPONSE> {
                     operationListenerAttributesExtractor, "operationListenerAttributesExtractor")));
   }
 
-  private static boolean isIncubator() {
-    try {
-      Class.forName("io.opentelemetry.api.incubator.ExtendedOpenTelemetry");
-      return true;
-    } catch (ClassNotFoundException e) {
-      // The incubator module is not available.
-      // This only happens in OpenTelemetry API instrumentation tests, where an older version of
-      // OpenTelemetry API is used that does not have ExtendedOpenTelemetry.
-      // Having the incubator module without ExtendedOpenTelemetry class should still return false
-      // for those tests to avoid a ClassNotFoundException.
-      return false;
-    }
-  }
-
   InstrumenterBuilder(
       OpenTelemetry openTelemetry,
       String instrumentationName,
@@ -320,7 +297,6 @@ private Instrumenter<REQUEST, RESPONSE> buildInstrumenter(
       InstrumenterConstructor<REQUEST, RESPONSE> constructor,
       SpanKindExtractor<? super REQUEST> spanKindExtractor) {
 
-    addThreadDetailsAttributeExtractor(this);
     applyCustomizers(this);
 
     this.spanKindExtractor = spanKindExtractor;
@@ -434,6 +410,11 @@ public String getInstrumentationName() {
               return builder.instrumentationName;
             }
 
+            @Override
+            public OpenTelemetry getOpenTelemetry() {
+              return builder.openTelemetry;
+            }
+
             @Override
             public boolean hasType(SpanKey type) {
               return spanKeys.contains(type);
@@ -478,28 +459,7 @@ public void setSpanStatusExtractorCustomizer(
     }
   }
 
-  private static <RESPONSE, REQUEST> void addThreadDetailsAttributeExtractor(
-      InstrumenterBuilder<REQUEST, RESPONSE> builder) {
-    if (isIncubator && builder.openTelemetry instanceof ExtendedOpenTelemetry) {
-      // Declarative config is used.
-      // Otherwise, thread details are configured in
-      // io.opentelemetry.javaagent.tooling.AgentTracerProviderConfigurer.
-
-      DeclarativeConfigProperties instrumentationConfig =
-          ((ExtendedOpenTelemetry) builder.openTelemetry)
-              .getConfigProvider()
-              .getInstrumentationConfig();
-
-      if (instrumentationConfig != null
-          && instrumentationConfig
-              .getStructured("java", empty())
-              .getStructured("common", empty())
-              .getStructured("thread_details", empty())
-              .getBoolean("enabled", false)) {
-        builder.addAttributesExtractor(new ThreadDetailsAttributesExtractor<>());
-      }
-    }
-  }
+
 
   private interface InstrumenterConstructor<RQ, RS> {
     Instrumenter<RQ, RS> create(InstrumenterBuilder<RQ, RS> builder);
@@ -545,26 +505,4 @@ public <RQ, RS> void propagateOperationListenersToOnEnd(
           }
         });
   }
-
-  private static class ThreadDetailsAttributesExtractor<RESPONSE, REQUEST>
-      implements AttributesExtractor<REQUEST, RESPONSE> {
-    // attributes are not stable yet
-    private static final AttributeKey<Long> THREAD_ID = longKey("thread.id");
-    private static final AttributeKey<String> THREAD_NAME = stringKey("thread.name");
-
-    @Override
-    public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) {
-      Thread currentThread = Thread.currentThread();
-      attributes.put(THREAD_ID, currentThread.getId());
-      attributes.put(THREAD_NAME, currentThread.getName());
-    }
-
-    @Override
-    public void onEnd(
-        AttributesBuilder attributes,
-        Context context,
-        REQUEST request,
-        @Nullable RESPONSE response,
-        @Nullable Throwable error) {}
-  }
 }

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/InternalInstrumenterCustomizer.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.api.internal;
 
+import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.ContextCustomizer;
 import io.opentelemetry.instrumentation.api.instrumenter.OperationMetrics;
@@ -20,6 +21,8 @@ public interface InternalInstrumenterCustomizer<REQUEST, RESPONSE> {
 
   String getInstrumentationName();
 
+  OpenTelemetry getOpenTelemetry();
+
   boolean hasType(SpanKey type);
 
   void addAttributesExtractor(AttributesExtractor<REQUEST, RESPONSE> extractor);

sdk-autoconfigure-support/build.gradle.kts

@@ -8,6 +8,7 @@ group = "io.opentelemetry.instrumentation"
 dependencies {
   api("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
   api("io.opentelemetry:opentelemetry-sdk-extension-incubator")
+  implementation(project(":instrumentation-api-incubator"))
 
   compileOnly("com.google.code.findbugs:annotations")
   testCompileOnly("com.google.code.findbugs:annotations")

sdk-autoconfigure-support/src/main/resources/META-INF/services/io.opentelemetry.instrumentation.api.incubator.instrumenter.InstrumenterCustomizerProvider

@@ -0,0 +1 @@
+io.opentelemetry.instrumentation.api.incubator.instrumenter.ThreadDetailsInstrumenterCustomizerProvider