spring starter: add thread details instrumentation / configure logging span exporter

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/logging/LoggingExporterAutoConfiguration.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.logging;
+
+import io.opentelemetry.exporter.logging.LoggingSpanExporter;
+import io.opentelemetry.instrumentation.internal.logging.LoggingSpanExporterConfigurer;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.SdkEnabled;
+import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+@Conditional(SdkEnabled.class)
+// for backward compatibility with declarative configuration
+@ConditionalOnProperty(name = "otel.debug", havingValue = "true")
+@ConditionalOnClass(LoggingSpanExporter.class)
+@Configuration
+public class LoggingExporterAutoConfiguration {
+
+  @Bean
+  public AutoConfigurationCustomizerProvider loggingOtelCustomizer() {
+    return p ->
+        p.addTracerProviderCustomizer(
+            (builder, config) -> {
+              LoggingSpanExporterConfigurer.enableLoggingExporter(builder, config);
+              return builder;
+            });
+  }
+}

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/thread/ThreadDetailsAutoConfiguration.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.thread;
+
+import io.opentelemetry.instrumentation.internal.thread.AddThreadDetailsSpanProcessor;
+import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
+import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+@ConditionalOnEnabledInstrumentation(module = "common.thread-details", enabledByDefault = false)
+@Configuration
+@SuppressWarnings("OtelPrivateConstructorForUtilityClass")
+public class ThreadDetailsAutoConfiguration {
+
+  @Bean
+  public AutoConfigurationCustomizerProvider threadDetailOtelCustomizer() {
+    return p ->
+        p.addTracerProviderCustomizer(
+            (builder, config) -> {
+              builder.addSpanProcessor(new AddThreadDetailsSpanProcessor());
+              return builder;
+            });
+  }
+}

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/properties/SpringConfigProperties.java

@@ -7,7 +7,7 @@
 
 import io.opentelemetry.api.internal.ConfigUtil;
 import io.opentelemetry.exporter.otlp.internal.OtlpConfigUtil;
-import io.opentelemetry.instrumentation.resources.ResourceProviderPropertiesCustomizer;
+import io.opentelemetry.instrumentation.internal.resources.ResourceProviderPropertiesCustomizer;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import java.time.Duration;

instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -13,7 +13,8 @@ io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.w
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.scheduling.SpringSchedulingInstrumentationAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.RuntimeMetricsAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.Java8RuntimeMetricsProvider,\
-io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.Java17RuntimeMetricsProvider
+io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.Java17RuntimeMetricsProvider,\
+io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.thread.ThreadDetailsAutoConfiguration
 
 org.springframework.context.ApplicationListener=\
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.logging.LogbackAppenderApplicationListener

instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -14,3 +14,4 @@ io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.s
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.RuntimeMetricsAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.Java8RuntimeMetricsProvider
 io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.runtimemetrics.Java17RuntimeMetricsProvider
+io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.thread.ThreadDetailsAutoConfiguration

instrumentation/spring/spring-boot-autoconfigure/src/test/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java

@@ -100,7 +100,7 @@ void specialListProperties() {
                                   "io.opentelemetry.contrib.aws.resource.LambdaResourceProvider",
                                   "io.opentelemetry.contrib.gcp.resource.GCPResourceProvider",
                                   "io.opentelemetry.contrib.cloudfoundry.resources.CloudFoundryResourceProvider",
-                                  "io.opentelemetry.instrumentation.resources.ResourceProviderPropertiesCustomizerTest$Provider");
+                                  "io.opentelemetry.instrumentation.internal.resources.ResourceProviderPropertiesCustomizerTest$Provider");
                         }));
   }
 

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/AgentTracerProviderConfigurer.java

@@ -5,18 +5,17 @@
 
 package io.opentelemetry.javaagent.tooling;
 
+import static io.opentelemetry.instrumentation.internal.logging.LoggingSpanExporterConfigurer.enableLoggingExporter;
 import static io.opentelemetry.javaagent.tooling.AgentInstaller.JAVAAGENT_ENABLED_CONFIG;
-import static java.util.Collections.emptyList;
 
 import com.google.auto.service.AutoService;
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
-import io.opentelemetry.exporter.logging.LoggingSpanExporter;
+import io.opentelemetry.instrumentation.internal.thread.AddThreadDetailsSpanProcessor;
 import io.opentelemetry.javaagent.tooling.config.AgentConfig;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder;
-import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
 
 @AutoService(AutoConfigurationCustomizerProvider.class)
 public class AgentTracerProviderConfigurer implements AutoConfigurationCustomizerProvider {
@@ -40,22 +39,10 @@ private static SdkTracerProviderBuilder configure(
       sdkTracerProviderBuilder.addSpanProcessor(new AddThreadDetailsSpanProcessor());
     }
 
-    maybeEnableLoggingExporter(sdkTracerProviderBuilder, config);
-
-    return sdkTracerProviderBuilder;
-  }
-
-  private static void maybeEnableLoggingExporter(
-      SdkTracerProviderBuilder builder, ConfigProperties config) {
     if (AgentConfig.isDebugModeEnabled(config)) {
-      // don't install another instance if the user has already explicitly requested it.
-      if (loggingExporterIsNotAlreadyConfigured(config)) {
-        builder.addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()));
-      }
+      enableLoggingExporter(sdkTracerProviderBuilder, config);
     }
-  }
 
-  private static boolean loggingExporterIsNotAlreadyConfigured(ConfigProperties config) {
-    return !config.getList("otel.traces.exporter", emptyList()).contains("logging");
+    return sdkTracerProviderBuilder;
   }
 }

sdk-autoconfigure-support/build.gradle.kts

@@ -6,8 +6,10 @@ plugins {
 group = "io.opentelemetry.instrumentation"
 
 dependencies {
+  compileOnly("io.opentelemetry:opentelemetry-exporter-logging")
   api("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
 
   compileOnly("com.google.code.findbugs:annotations")
   testCompileOnly("com.google.code.findbugs:annotations")
+  testImplementation(project(":testing-common"))
 }

sdk-autoconfigure-support/src/main/java/io/opentelemetry/instrumentation/internal/logging/LoggingSpanExporterConfigurer.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.internal.logging;
+
+import static java.util.Collections.emptyList;
+
+import io.opentelemetry.exporter.logging.LoggingSpanExporter;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder;
+import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class LoggingSpanExporterConfigurer {
+
+  private LoggingSpanExporterConfigurer() {}
+
+  public static void enableLoggingExporter(
+      SdkTracerProviderBuilder builder, ConfigProperties config) {
+    // don't install another instance if the user has already explicitly requested it.
+    if (loggingExporterIsNotAlreadyConfigured(config)) {
+      builder.addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()));
+    }
+  }
+
+  private static boolean loggingExporterIsNotAlreadyConfigured(ConfigProperties config) {
+    return !config.getList("otel.traces.exporter", emptyList()).contains("logging");
+  }
+}

sdk-autoconfigure-support/src/main/java/io/opentelemetry/instrumentation/resources/ResourceProviderPropertiesCustomizer.java → sdk-autoconfigure-support/src/main/java/io/opentelemetry/instrumentation/internal/resources/ResourceProviderPropertiesCustomizer.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.resources;
+package io.opentelemetry.instrumentation.internal.resources;
 
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
@@ -17,6 +17,10 @@
 import java.util.Set;
 import javax.annotation.Nullable;
 
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 public class ResourceProviderPropertiesCustomizer implements AutoConfigurationCustomizerProvider {
 
   private static final Map<String, String> DISABLED_BY_DEFAULT_RESOURCE_PROVIDERS = new HashMap<>();
@@ -49,7 +53,7 @@ public class ResourceProviderPropertiesCustomizer implements AutoConfigurationCu
         "cloudfoundry");
     // for testing
     DISABLED_BY_DEFAULT_RESOURCE_PROVIDERS.put(
-        "io.opentelemetry.instrumentation.resources.ResourceProviderPropertiesCustomizerTest$Provider",
+        "io.opentelemetry.instrumentation.internal.resources.ResourceProviderPropertiesCustomizerTest$Provider",
         "test");
   }
 

javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/AddThreadDetailsSpanProcessor.java → sdk-autoconfigure-support/src/main/java/io/opentelemetry/instrumentation/internal/thread/AddThreadDetailsSpanProcessor.java

@@ -3,22 +3,33 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.javaagent.tooling;
+package io.opentelemetry.instrumentation.internal.thread;
 
+import static io.opentelemetry.api.common.AttributeKey.longKey;
+import static io.opentelemetry.api.common.AttributeKey.stringKey;
+
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.trace.ReadWriteSpan;
 import io.opentelemetry.sdk.trace.ReadableSpan;
 import io.opentelemetry.sdk.trace.SpanProcessor;
-import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes;
 
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
 public class AddThreadDetailsSpanProcessor implements SpanProcessor {
 
+  // attributes are not stable yet
+  public static final AttributeKey<Long> THREAD_ID = longKey("thread.id");
+  public static final AttributeKey<String> THREAD_NAME = stringKey("thread.name");
+
   @Override
   public void onStart(Context context, ReadWriteSpan span) {
     Thread currentThread = Thread.currentThread();
-    span.setAttribute(ThreadIncubatingAttributes.THREAD_ID, currentThread.getId());
-    span.setAttribute(ThreadIncubatingAttributes.THREAD_NAME, currentThread.getName());
+    span.setAttribute(THREAD_ID, currentThread.getId());
+    span.setAttribute(THREAD_NAME, currentThread.getName());
   }
 
   @Override

sdk-autoconfigure-support/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider

@@ -1 +1 @@
-io.opentelemetry.instrumentation.resources.ResourceProviderPropertiesCustomizer
+io.opentelemetry.instrumentation.internal.resources.ResourceProviderPropertiesCustomizer

sdk-autoconfigure-support/src/test/java/io/opentelemetry/instrumentation/resources/ResourceProviderPropertiesCustomizerTest.java → sdk-autoconfigure-support/src/test/java/io/opentelemetry/instrumentation/internal/resources/ResourceProviderPropertiesCustomizerTest.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.resources;
+package io.opentelemetry.instrumentation.internal.resources;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -58,7 +58,7 @@ private EnabledTestCase(
   @TestFactory
   Stream<DynamicTest> enabledTestCases() {
     String className =
-        "io.opentelemetry.instrumentation.resources.ResourceProviderPropertiesCustomizerTest$Provider";
+        "io.opentelemetry.instrumentation.internal.resources.ResourceProviderPropertiesCustomizerTest$Provider";
     return Stream.of(
             new EnabledTestCase(
                 "explicitEnabled", true, Collections.emptySet(), Collections.emptySet(), true),

sdk-autoconfigure-support/src/test/java/io/opentelemetry/instrumentation/internal/thread/AddThreadDetailsSpanProcessorTest.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.internal.thread;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.sdk.trace.ReadWriteSpan;
+import io.opentelemetry.sdk.trace.SpanProcessor;
+import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes;
+import org.junit.jupiter.api.Test;
+
+class AddThreadDetailsSpanProcessorTest {
+
+  private final ReadWriteSpan span = mock(ReadWriteSpan.class);
+
+  private final SpanProcessor spanProcessor = new AddThreadDetailsSpanProcessor();
+
+  @Test
+  void onStart() {
+    assertThat(spanProcessor.isStartRequired()).isTrue();
+  }
+
+  @Test
+  void setThreadAttributes() {
+    Thread thread = Thread.currentThread();
+    spanProcessor.onStart(Context.root(), span);
+
+    verify(span).setAttribute(ThreadIncubatingAttributes.THREAD_ID, thread.getId());
+    verify(span).setAttribute(ThreadIncubatingAttributes.THREAD_NAME, thread.getName());
+    verifyNoMoreInteractions(span);
+  }
+}

sdk-autoconfigure-support/src/test/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider

@@ -1 +1 @@
-io.opentelemetry.instrumentation.resources.ResourceProviderPropertiesCustomizerTest$Provider
+io.opentelemetry.instrumentation.internal.resources.ResourceProviderPropertiesCustomizerTest$Provider

smoke-tests-otel-starter/spring-boot-2/src/test/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java

@@ -18,5 +18,6 @@
       // The headers are simply set here to make sure that headers can be parsed
       "otel.exporter.otlp.headers.c=3",
       "otel.instrumentation.runtime-telemetry.emit-experimental-telemetry=true",
+      "otel.instrumentation.common.thread_details.enabled=true",
     })
 class OtelSpringStarterSmokeTest extends AbstractOtelSpringStarterSmokeTest {}

smoke-tests-otel-starter/spring-boot-3/src/test/java/io/opentelemetry/spring/smoketest/GraalVmNativeKafkaSpringStarterSmokeTest.java

@@ -27,6 +27,6 @@
       AbstractKafkaSpringStarterSmokeTest.KafkaConfig.class
     },
     webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
-@EnabledInNativeImage // see JvmMongodbSpringStarterSmokeTest for the JVM test
+@EnabledInNativeImage // see AbstractJvmKafkaSpringStarterSmokeTest for the JVM test
 @RequiresDockerCompose
 public class GraalVmNativeKafkaSpringStarterSmokeTest extends AbstractKafkaSpringStarterSmokeTest {}

smoke-tests-otel-starter/spring-boot-3/src/test/java/io/opentelemetry/spring/smoketest/GraalVmNativeMongodbSpringStarterSmokeTest.java

@@ -23,7 +23,7 @@
 @SpringBootTest(
     classes = {OtelSpringStarterSmokeTestApplication.class, SpringSmokeOtelConfiguration.class},
     webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
-@EnabledInNativeImage // see JvmMongodbSpringStarterSmokeTest for the JVM test
+@EnabledInNativeImage // see AbstractJvmMongodbSpringStarterSmokeTest for the JVM test
 @RequiresDockerCompose
 public class GraalVmNativeMongodbSpringStarterSmokeTest
     extends AbstractMongodbSpringStarterSmokeTest {}

smoke-tests-otel-starter/spring-boot-3/src/test/java/io/opentelemetry/spring/smoketest/OtelSpringStarterSmokeTest.java

@@ -21,6 +21,7 @@
       "otel.exporter.otlp.headers.c=3",
       "otel.instrumentation.runtime-telemetry.emit-experimental-telemetry=true",
       "otel.instrumentation.runtime-telemetry-java17.enable-all=true",
+      "otel.instrumentation.common.thread_details.enabled=true",
     })
 class OtelSpringStarterSmokeTest extends AbstractOtelSpringStarterSmokeTest {