add declarative config for baggage (#2031)

Author: zeitlinger

baggage-processor/build.gradle.kts

@@ -8,11 +8,19 @@ description = "OpenTelemetry Baggage Span Processor"
 otelJava.moduleName.set("io.opentelemetry.contrib.baggage.processor")
 
 dependencies {
+  annotationProcessor("com.google.auto.service:auto-service")
+  compileOnly("com.google.auto.service:auto-service-annotations")
   api("io.opentelemetry:opentelemetry-api")
   api("io.opentelemetry:opentelemetry-sdk")
   implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
+  compileOnly("io.opentelemetry:opentelemetry-sdk-common")
+  compileOnly("io.opentelemetry:opentelemetry-sdk-extension-incubator")
 
+  testAnnotationProcessor("com.google.auto.service:auto-service")
+  testCompileOnly("com.google.auto.service:auto-service-annotations")
+  testImplementation("io.opentelemetry:opentelemetry-sdk-common")
   testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  testImplementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
   testImplementation("org.mockito:mockito-inline")
   testImplementation("com.google.guava:guava")

baggage-processor/src/main/java/io/opentelemetry/contrib/baggage/processor/BaggageLogRecordComponentProvider.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.baggage.processor;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.internal.IncludeExcludePredicate;
+import io.opentelemetry.sdk.logs.LogRecordProcessor;
+
+@SuppressWarnings("rawtypes")
+@AutoService(ComponentProvider.class)
+public class BaggageLogRecordComponentProvider implements ComponentProvider<LogRecordProcessor> {
+  @Override
+  public String getName() {
+    return "baggage";
+  }
+
+  @Override
+  public LogRecordProcessor create(DeclarativeConfigProperties config) {
+    return new BaggageLogRecordProcessor(
+        IncludeExcludePredicate.createPatternMatching(
+            config.getScalarList("included", String.class),
+            config.getScalarList("excluded", String.class)));
+  }
+
+  @Override
+  public Class<LogRecordProcessor> getType() {
+    return LogRecordProcessor.class;
+  }
+}

baggage-processor/src/main/java/io/opentelemetry/contrib/baggage/processor/BaggageProcessorCustomizer.java

@@ -5,13 +5,15 @@
 
 package io.opentelemetry.contrib.baggage.processor;
 
+import com.google.auto.service.AutoService;
 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.logs.SdkLoggerProviderBuilder;
 import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder;
 import java.util.List;
 
+@AutoService(AutoConfigurationCustomizerProvider.class)
 public class BaggageProcessorCustomizer implements AutoConfigurationCustomizerProvider {
   @Override
   public void customize(AutoConfigurationCustomizer autoConfigurationCustomizer) {

baggage-processor/src/main/java/io/opentelemetry/contrib/baggage/processor/BaggageSpanComponentProvider.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.baggage.processor;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.internal.IncludeExcludePredicate;
+import io.opentelemetry.sdk.trace.SpanProcessor;
+
+@SuppressWarnings("rawtypes")
+@AutoService(ComponentProvider.class)
+public class BaggageSpanComponentProvider implements ComponentProvider<SpanProcessor> {
+  @Override
+  public String getName() {
+    return "baggage";
+  }
+
+  @Override
+  public SpanProcessor create(DeclarativeConfigProperties config) {
+    return new BaggageSpanProcessor(
+        IncludeExcludePredicate.createPatternMatching(
+            config.getScalarList("included", String.class),
+            config.getScalarList("excluded", String.class)));
+  }
+
+  @Override
+  public Class<SpanProcessor> getType() {
+    return SpanProcessor.class;
+  }
+}

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

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.baggage.processor;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+import org.junit.jupiter.api.Test;
+
+class BaggageLogRecordComponentProviderTest {
+
+  @Test
+  void declarativeConfig() {
+    String yaml =
+        "file_format: 0.4\n"
+            + "logger_provider:\n"
+            + "  processors:\n"
+            + "    - baggage:\n"
+            + "        included: [foo]\n"
+            + "        excluded: [bar]\n";
+
+    OpenTelemetrySdk sdk =
+        DeclarativeConfiguration.parseAndCreate(
+            new ByteArrayInputStream(yaml.getBytes(StandardCharsets.UTF_8)));
+
+    assertThat(sdk).asString().contains("BaggageLogRecordProcessor");
+  }
+}

baggage-processor/src/test/java/io/opentelemetry/contrib/baggage/processor/BaggageLogRecordComponentProviderTest.java

@@ -48,11 +48,15 @@ class BaggageProcessorCustomizerTest {
   private static final String MEMORY_EXPORTER = "memory";
 
   @Test
-  void test_customizer() {
+  void test_empty_customizer() {
     assertCustomizer(
         Collections.emptyMap(),
         span -> assertThat(span).hasTotalAttributeCount(0),
         logRecord -> assertThat(logRecord).hasTotalAttributeCount(0));
+  }
+
+  @Test
+  void test_customizer() {
     Map<String, String> properties = new HashMap<>();
     properties.put("otel.java.experimental.span-attributes.copy-from-baggage.include", "key");
     properties.put("otel.java.experimental.log-attributes.copy-from-baggage.include", "key");
@@ -117,7 +121,7 @@ private static OpenTelemetrySdk getOpenTelemetrySdk(
                 new ComponentLoader() {
                   @Override
                   public <T> List<T> load(Class<T> spiClass) {
-                    if (spiClass == ConfigurableSpanExporterProvider.class) {
+                    if (spiClass.equals(ConfigurableSpanExporterProvider.class)) {
                       return Collections.singletonList(
                           spiClass.cast(
                               new ConfigurableSpanExporterProvider() {
@@ -132,7 +136,7 @@ public String getName() {
                                   return MEMORY_EXPORTER;
                                 }
                               }));
-                    } else if (spiClass == ConfigurableLogRecordExporterProvider.class) {
+                    } else if (spiClass.equals(ConfigurableLogRecordExporterProvider.class)) {
                       return Collections.singletonList(
                           spiClass.cast(
                               new ConfigurableLogRecordExporterProvider() {

baggage-processor/src/test/java/io/opentelemetry/contrib/baggage/processor/BaggageProcessorCustomizerTest.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.baggage.processor;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfiguration;
+import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
+import org.junit.jupiter.api.Test;
+
+class BaggageSpanComponentProviderTest {
+
+  @Test
+  void declarativeConfig() {
+    String yaml =
+        "file_format: 0.4\n"
+            + "tracer_provider:\n"
+            + "  processors:\n"
+            + "    - baggage:\n"
+            + "        included: [foo]\n"
+            + "        excluded: [bar]\n";
+
+    OpenTelemetrySdk sdk =
+        DeclarativeConfiguration.parseAndCreate(
+            new ByteArrayInputStream(yaml.getBytes(StandardCharsets.UTF_8)));
+
+    assertThat(sdk).asString().contains("BaggageSpanProcessor");
+  }
+}