baggage processor

Author: zeitlinger

baggage-processor/build.gradle.kts

@@ -8,11 +8,17 @@ description = "OpenTelemetry Baggage Span Processor"
 otelJava.moduleName.set("io.opentelemetry.contrib.baggage.processor")
 
 dependencies {
+  implementation(project(":declarative-config-bridge"))
+
+  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-extension-incubator")
 
   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,33 @@
+/*
+ * 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.contrib.sdk.autoconfigure.ConfigPropertiesUtil;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.logs.LogRecordProcessor;
+import java.util.Collections;
+
+@SuppressWarnings("rawtypes")
+@AutoService(ComponentProvider.class)
+public class BaggageLogRecordComponentProvider implements ComponentProvider<LogRecordProcessor> {
+  @Override
+  public String getName() {
+    return "baggage";
+  }
+
+  @Override
+  public LogRecordProcessor create(DeclarativeConfigProperties config) {
+    return BaggageProcessorCustomizer.createBaggageLogRecordProcessor(ConfigPropertiesUtil.resolveConfig(
+        config, Collections.singletonMap(BaggageProcessorCustomizer.LOG_PREFIX, "")));
+  }
+
+  @Override
+  public Class<LogRecordProcessor> getType() {
+    return LogRecordProcessor.class;
+  }
+}

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

@@ -23,17 +23,23 @@ public class BaggageLogRecordProcessor implements LogRecordProcessor {
    * created log record.
    */
   public static BaggageLogRecordProcessor allowAllBaggageKeys() {
-    return new BaggageLogRecordProcessor(baggageKey -> true);
+    return new BaggageLogRecordProcessor(baggageKey -> true, false);
   }
 
   private final Predicate<String> baggageKeyPredicate;
+  private boolean empty;
 
   /**
    * Creates a new {@link BaggageLogRecordProcessor} that copies only baggage entries with keys that
    * pass the provided filter into the newly created log record.
    */
   public BaggageLogRecordProcessor(Predicate<String> baggageKeyPredicate) {
+    this(baggageKeyPredicate, false); // we don't know if the predicate matches any keys
+  }
+
+  BaggageLogRecordProcessor(Predicate<String> baggageKeyPredicate, boolean empty) {
     this.baggageKeyPredicate = baggageKeyPredicate;
+    this.empty = empty;
   }
 
   @Override
@@ -46,4 +52,8 @@ public void onEmit(Context context, ReadWriteLogRecord logRecord) {
               }
             });
   }
+
+  boolean isEmpty() {
+    return empty;
+  }
 }

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

@@ -5,14 +5,19 @@
 
 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 {
+  static final String SPAN_PREFIX = "otel.java.experimental.span-attributes.";
+  static final String LOG_PREFIX = "otel.java.experimental.log-attributes.";
+
   @Override
   public void customize(AutoConfigurationCustomizer autoConfigurationCustomizer) {
     autoConfigurationCustomizer
@@ -30,39 +35,47 @@ public void customize(AutoConfigurationCustomizer autoConfigurationCustomizer) {
 
   private static void addSpanProcessor(
       SdkTracerProviderBuilder sdkTracerProviderBuilder, ConfigProperties config) {
-    List<String> keys =
-        config.getList("otel.java.experimental.span-attributes.copy-from-baggage.include");
-
-    if (keys.isEmpty()) {
+    BaggageSpanProcessor processor = createBaggageSpanProcessor(config);
+    if (processor.isEmpty()) {
       return;
     }
+    sdkTracerProviderBuilder.addSpanProcessor(processor);
+  }
 
-    sdkTracerProviderBuilder.addSpanProcessor(createBaggageSpanProcessor(keys));
+  static BaggageSpanProcessor createBaggageSpanProcessor(ConfigProperties config) {
+    return createBaggageSpanProcessor(
+        config.getList(SPAN_PREFIX + "copy-from-baggage.include"));
   }
 
   static BaggageSpanProcessor createBaggageSpanProcessor(List<String> keys) {
-    if (keys.size() == 1 && keys.get(0).equals("*")) {
+    if (matchAll(keys)) {
       return BaggageSpanProcessor.allowAllBaggageKeys();
     }
-    return new BaggageSpanProcessor(keys::contains);
+    return new BaggageSpanProcessor(keys::contains, keys.isEmpty());
   }
 
   private static void addLogRecordProcessor(
       SdkLoggerProviderBuilder sdkLoggerProviderBuilder, ConfigProperties config) {
-    List<String> keys =
-        config.getList("otel.java.experimental.log-attributes.copy-from-baggage.include");
-
-    if (keys.isEmpty()) {
+    BaggageLogRecordProcessor processor = createBaggageLogRecordProcessor(config);
+    if (processor.isEmpty()) {
       return;
     }
+    sdkLoggerProviderBuilder.addLogRecordProcessor(processor);
+  }
 
-    sdkLoggerProviderBuilder.addLogRecordProcessor(createBaggageLogRecordProcessor(keys));
+  static BaggageLogRecordProcessor createBaggageLogRecordProcessor(ConfigProperties config) {
+    return createBaggageLogRecordProcessor(
+        config.getList(LOG_PREFIX + "copy-from-baggage.include"));
   }
 
   static BaggageLogRecordProcessor createBaggageLogRecordProcessor(List<String> keys) {
-    if (keys.size() == 1 && keys.get(0).equals("*")) {
+    if (matchAll(keys)) {
       return BaggageLogRecordProcessor.allowAllBaggageKeys();
     }
-    return new BaggageLogRecordProcessor(keys::contains);
+    return new BaggageLogRecordProcessor(keys::contains, keys.isEmpty());
+  }
+
+  private static boolean matchAll(List<String> keys) {
+    return keys.size() == 1 && keys.get(0).equals("*");
   }
 }

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

@@ -0,0 +1,33 @@
+/*
+ * 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.contrib.sdk.autoconfigure.ConfigPropertiesUtil;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
+import io.opentelemetry.sdk.trace.SpanProcessor;
+import java.util.Collections;
+
+@SuppressWarnings("rawtypes")
+@AutoService(ComponentProvider.class)
+public class BaggageSpanComponentProvider implements ComponentProvider<SpanProcessor> {
+  @Override
+  public String getName() {
+    return "baggage";
+  }
+
+  @Override
+  public SpanProcessor create(DeclarativeConfigProperties config) {
+    return BaggageProcessorCustomizer.createBaggageSpanProcessor(ConfigPropertiesUtil.resolveConfig(
+        config, Collections.singletonMap(BaggageProcessorCustomizer.SPAN_PREFIX, "")));
+  }
+
+  @Override
+  public Class<SpanProcessor> getType() {
+    return SpanProcessor.class;
+  }
+}

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

@@ -18,21 +18,27 @@
  */
 public class BaggageSpanProcessor implements SpanProcessor {
   private final Predicate<String> baggageKeyPredicate;
+  private boolean empty;
 
   /**
    * Creates a new {@link BaggageSpanProcessor} that copies only baggage entries with keys that pass
    * the provided filter into the newly created {@link io.opentelemetry.api.trace.Span}.
    */
   public BaggageSpanProcessor(Predicate<String> baggageKeyPredicate) {
+    this(baggageKeyPredicate, false); // we don't know if the predicate matches any keys
+  }
+
+  BaggageSpanProcessor(Predicate<String> baggageKeyPredicate, boolean empty) {
     this.baggageKeyPredicate = baggageKeyPredicate;
+    this.empty = empty;
   }
 
   /**
    * Creates a new {@link BaggageSpanProcessor} that copies all baggage entries into the newly
    * created {@link io.opentelemetry.api.trace.Span}.
    */
   public static BaggageSpanProcessor allowAllBaggageKeys() {
-    return new BaggageSpanProcessor(baggageKey -> true);
+    return new BaggageSpanProcessor(baggageKey -> true, false);
   }
 
   @Override
@@ -58,4 +64,8 @@ public void onEnd(ReadableSpan span) {}
   public boolean isEndRequired() {
     return false;
   }
+
+  boolean isEmpty() {
+    return empty;
+  }
 }