Initialize appenders in the spring boot starter (#8888)

Co-authored-by: Lauri Tulmin <ltulmin@splunk.com>
open-telemetry · Jul 11, 2023 · 8815952 · 8815952
1 parent 8011cb4
commit 8815952
Show file tree

Hide file tree

Showing 27 changed files with 233 additions and 144 deletions.
diff --git a/instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts b/instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts
@@ -41,6 +41,10 @@ dependencies {
   compileOnly("io.opentelemetry:opentelemetry-exporter-otlp")
   compileOnly("io.opentelemetry:opentelemetry-exporter-zipkin")
   compileOnly(project(":instrumentation-annotations"))
+  compileOnly(project(":instrumentation:log4j:log4j-appender-2.17:library"))
+  compileOnly("org.apache.logging.log4j:log4j-core:2.17.0")
+  compileOnly(project(":instrumentation:logback:logback-appender-1.0:library"))
+  compileOnly("ch.qos.logback:logback-classic:1.0.0")
 
   compileOnly(project(":instrumentation:resources:library"))
   annotationProcessor("com.google.auto.service:auto-service")
@@ -77,24 +81,59 @@ if (latestDepTest) {
   }
 }
 
-tasks.compileTestJava {
-  options.compilerArgs.add("-parameters")
+testing {
+  suites {
+    val testLogbackAppender by registering(JvmTestSuite::class) {
+      dependencies {
+        implementation(project())
+        implementation(project(":testing-common"))
+        implementation("io.opentelemetry:opentelemetry-sdk")
+        implementation("io.opentelemetry:opentelemetry-sdk-testing")
+        implementation("org.springframework.boot:spring-boot-autoconfigure:$springBootVersion")
+
+        implementation(project(":instrumentation:logback:logback-appender-1.0:library"))
+        // using the same versions as in the spring-boot-autoconfigure
+        implementation("ch.qos.logback:logback-classic") {
+          version {
+            strictly("1.2.11")
+          }
+        }
+        implementation("org.slf4j:slf4j-api") {
+          version {
+            strictly("1.7.32")
+          }
+        }
+      }
+    }
+  }
 }
 
-tasks.withType<Test>().configureEach {
-  usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+tasks {
+  check {
+    dependsOn(testing.suites)
+  }
+
+  compileTestJava {
+    options.compilerArgs.add("-parameters")
+  }
+
+  test {
+    usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+  }
 
-  systemProperty("testLatestDeps", latestDepTest)
+  withType<Test>().configureEach {
+    systemProperty("testLatestDeps", latestDepTest)
 
-  // required on jdk17
-  jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
-  jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+    // required on jdk17
+    jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
+    jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
 
-  // disable tests on openj9 18 because they often crash JIT compiler
-  val testJavaVersion = gradle.startParameter.projectProperties["testJavaVersion"]?.let(JavaVersion::toVersion)
-  val testOnOpenJ9 = gradle.startParameter.projectProperties["testJavaVM"]?.run { this == "openj9" }
-    ?: false
-  if (testOnOpenJ9 && testJavaVersion?.majorVersion == "18") {
-    enabled = false
+    // disable tests on openj9 18 because they often crash JIT compiler
+    val testJavaVersion = gradle.startParameter.projectProperties["testJavaVersion"]?.let(JavaVersion::toVersion)
+    val testOnOpenJ9 = gradle.startParameter.projectProperties["testJavaVM"]?.run { this == "openj9" }
+      ?: false
+    if (testOnOpenJ9 && testJavaVersion?.majorVersion == "18") {
+      enabled = false
+    }
   }
 }
diff --git a/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java b/...io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java
@@ -5,7 +5,6 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.TracerProvider;
 import io.opentelemetry.context.propagation.ContextPropagators;
@@ -141,9 +140,6 @@ public OpenTelemetry openTelemetry(
 
       ContextPropagators propagators = propagatorsProvider.getIfAvailable(ContextPropagators::noop);
 
-      // global is needed for logging appenders
-      GlobalOpenTelemetry.set(OpenTelemetrySdk.builder().setLoggerProvider(loggerProvider).build());
-
       return OpenTelemetrySdk.builder()
           .setTracerProvider(tracerProvider)
           .setMeterProvider(meterProvider)

diff --git a/.../instrumentation/spring/autoconfigure/logging/OpenTelemetryAppenderAutoConfiguration.java b/.../instrumentation/spring/autoconfigure/logging/OpenTelemetryAppenderAutoConfiguration.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.spring.autoconfigure.logging;
+
+import io.opentelemetry.api.OpenTelemetry;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.event.ApplicationReadyEvent;
+import org.springframework.context.ApplicationListener;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@SuppressWarnings("OtelPrivateConstructorForUtilityClass")
+@ConditionalOnBean(OpenTelemetry.class)
+public class OpenTelemetryAppenderAutoConfiguration {
+
+  @Configuration
+  @ConditionalOnProperty(
+      prefix = "otel.springboot.log4j-appender",
+      name = "enabled",
+      matchIfMissing = true)
+  @ConditionalOnClass({
+    io.opentelemetry.instrumentation.log4j.appender.v2_17.OpenTelemetryAppender.class
+  })
+  static class Log4jAppenderConfig {
+
+    @Bean
+    ApplicationListener<ApplicationReadyEvent> log4jOtelAppenderInitializer(
+        OpenTelemetry openTelemetry) {
+      return event -> {
+        io.opentelemetry.instrumentation.log4j.appender.v2_17.OpenTelemetryAppender.install(
+            openTelemetry);
+      };
+    }
+  }
+
+  @Configuration
+  @ConditionalOnProperty(
+      prefix = "otel.springboot.logback-appender",
+      name = "enabled",
+      matchIfMissing = true)
+  @ConditionalOnClass({
+    io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender.class
+  })
+  static class LogbackAppenderConfig {
+
+    @Bean
+    ApplicationListener<ApplicationReadyEvent> logbackOtelAppenderInitializer(
+        OpenTelemetry openTelemetry) {
+      return event -> {
+        io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender.install(
+            openTelemetry);
+      };
+    }
+  }
+}
diff --git a/...rumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories b/...rumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories
@@ -10,6 +10,7 @@ io.opentelemetry.instrumentation.spring.autoconfigure.exporters.zipkin.ZipkinSpa
 io.opentelemetry.instrumentation.spring.autoconfigure.httpclients.resttemplate.RestTemplateAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.httpclients.webclient.WebClientAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.kafka.KafkaInstrumentationAutoConfiguration,\
+io.opentelemetry.instrumentation.spring.autoconfigure.logging.OpenTelemetryAppenderAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.metrics.MicrometerShimAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.propagators.PropagationAutoConfiguration,\
 io.opentelemetry.instrumentation.spring.autoconfigure.resources.OtelResourceAutoConfiguration,\

diff --git a/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/...esources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
@@ -9,6 +9,7 @@ io.opentelemetry.instrumentation.spring.autoconfigure.exporters.zipkin.ZipkinSpa
 io.opentelemetry.instrumentation.spring.autoconfigure.httpclients.resttemplate.RestTemplateAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.httpclients.webclient.WebClientAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.kafka.KafkaInstrumentationAutoConfiguration
+io.opentelemetry.instrumentation.spring.autoconfigure.logging.OpenTelemetryAppenderAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.metrics.MicrometerShimAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.propagators.PropagationAutoConfiguration
 io.opentelemetry.instrumentation.spring.autoconfigure.resources.OtelResourceAutoConfiguration

diff --git a/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java b/...pentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfigurationTest.java
@@ -8,7 +8,6 @@
 import static io.opentelemetry.semconv.resource.attributes.ResourceAttributes.SERVICE_NAME;
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.instrumentation.spring.autoconfigure.resources.OtelResourceAutoConfiguration;
@@ -17,7 +16,6 @@
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.resources.Resource;
 import io.opentelemetry.sdk.trace.SdkTracerProvider;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
@@ -37,11 +35,6 @@ public OpenTelemetry customOpenTelemetry() {
 
   private final ApplicationContextRunner contextRunner = new ApplicationContextRunner();
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   @DisplayName(
       "when Application Context contains OpenTelemetry bean should NOT initialize openTelemetry")

diff --git a/...emetry/instrumentation/spring/autoconfigure/aspects/TraceAspectAutoConfigurationTest.java b/...emetry/instrumentation/spring/autoconfigure/aspects/TraceAspectAutoConfigurationTest.java
@@ -7,9 +7,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
@@ -24,11 +22,6 @@ public class TraceAspectAutoConfigurationTest {
               AutoConfigurations.of(
                   OpenTelemetryAutoConfiguration.class, TraceAspectAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   @DisplayName("when aspects are ENABLED should initialize WithSpanAspect bean")
   void aspectsEnabled() {

diff --git a/...tation/spring/autoconfigure/exporters/jaeger/JaegerSpanExporterAutoConfigurationTest.java b/...tation/spring/autoconfigure/exporters/jaeger/JaegerSpanExporterAutoConfigurationTest.java
@@ -7,9 +7,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
@@ -28,11 +26,6 @@ class JaegerSpanExporterAutoConfigurationTest {
               AutoConfigurations.of(
                   OpenTelemetryAutoConfiguration.class, JaegerSpanExporterAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   @DisplayName("when exporters are ENABLED should initialize JaegerGrpcSpanExporter bean")
   void exportersEnabled() {

diff --git a/...on/spring/autoconfigure/exporters/logging/LoggingMetricExporterAutoConfigurationTest.java b/...on/spring/autoconfigure/exporters/logging/LoggingMetricExporterAutoConfigurationTest.java
@@ -7,10 +7,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.exporter.logging.LoggingMetricExporter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -24,11 +22,6 @@ class LoggingMetricExporterAutoConfigurationTest {
                   OpenTelemetryAutoConfiguration.class,
                   LoggingMetricExporterAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   void loggingEnabled() {
     runner

diff --git a/...tion/spring/autoconfigure/exporters/logging/LoggingSpanExporterAutoConfigurationTest.java b/...tion/spring/autoconfigure/exporters/logging/LoggingSpanExporterAutoConfigurationTest.java
@@ -7,10 +7,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.exporter.logging.LoggingSpanExporter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
@@ -26,11 +24,6 @@ class LoggingSpanExporterAutoConfigurationTest {
                   OpenTelemetryAutoConfiguration.class,
                   LoggingSpanExporterAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   @DisplayName("when exporters are ENABLED should initialize LoggingSpanExporter bean")
   void loggingEnabled() {

diff --git a/...rumentation/spring/autoconfigure/exporters/otlp/OtlpLogExporterAutoConfigurationTest.java b/...rumentation/spring/autoconfigure/exporters/otlp/OtlpLogExporterAutoConfigurationTest.java
@@ -7,10 +7,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.exporter.otlp.logs.OtlpGrpcLogRecordExporter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -23,11 +21,6 @@ class OtlpLogExporterAutoConfigurationTest {
               AutoConfigurations.of(
                   OpenTelemetryAutoConfiguration.class, OtlpLoggerExporterAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   void otlpEnabled() {
     runner

diff --git a/...entation/spring/autoconfigure/exporters/otlp/OtlpMetricExporterAutoConfigurationTest.java b/...entation/spring/autoconfigure/exporters/otlp/OtlpMetricExporterAutoConfigurationTest.java
@@ -7,10 +7,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -23,11 +21,6 @@ class OtlpMetricExporterAutoConfigurationTest {
               AutoConfigurations.of(
                   OpenTelemetryAutoConfiguration.class, OtlpMetricExporterAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   void otlpEnabled() {
     runner

diff --git a/...umentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfigurationTest.java b/...umentation/spring/autoconfigure/exporters/otlp/OtlpSpanExporterAutoConfigurationTest.java
@@ -7,10 +7,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
@@ -25,11 +23,6 @@ class OtlpSpanExporterAutoConfigurationTest {
               AutoConfigurations.of(
                   OpenTelemetryAutoConfiguration.class, OtlpSpanExporterAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   @DisplayName("when exporters are ENABLED should initialize OtlpGrpcSpanExporter bean")
   void otlpEnabled() {

diff --git a/...tation/spring/autoconfigure/exporters/zipkin/ZipkinSpanExporterAutoConfigurationTest.java b/...tation/spring/autoconfigure/exporters/zipkin/ZipkinSpanExporterAutoConfigurationTest.java
@@ -7,10 +7,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.exporter.zipkin.ZipkinSpanExporter;
 import io.opentelemetry.instrumentation.spring.autoconfigure.OpenTelemetryAutoConfiguration;
-import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
@@ -25,11 +23,6 @@ class ZipkinSpanExporterAutoConfigurationTest {
               AutoConfigurations.of(
                   OpenTelemetryAutoConfiguration.class, ZipkinSpanExporterAutoConfiguration.class));
 
-  @BeforeEach
-  void resetGlobalLoggerProvider() {
-    GlobalOpenTelemetry.resetForTest();
-  }
-
   @Test
   @DisplayName("when exporters are ENABLED should initialize ZipkinSpanExporter bean")
   void exportersEnabled() {