add property translation for inferred spans

Author: zeitlinger

declarative-config-bridge/src/main/java/io/opentelemetry/contrib/sdk/autoconfigure/ConfigPropertiesUtil.java

@@ -12,6 +12,8 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.SdkConfigProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTelemetryConfigurationModel;
+import java.util.Collections;
+import java.util.Map;
 
 public class ConfigPropertiesUtil {
   private ConfigPropertiesUtil() {}
@@ -33,21 +35,25 @@ public static ConfigProperties resolveConfigProperties(
         instrumentationConfig = DeclarativeConfigProperties.empty();
       }
 
-      return new DeclarativeConfigPropertiesBridge(instrumentationConfig);
+      return new DeclarativeConfigPropertiesBridge(instrumentationConfig, Collections.emptyMap());
     }
     // Should never happen
     throw new IllegalStateException(
         "AutoConfiguredOpenTelemetrySdk does not have ConfigProperties or DeclarativeConfigProperties. This is likely a programming error in opentelemetry-java");
   }
 
   public static ConfigProperties resolveModel(OpenTelemetryConfigurationModel model) {
+    return resolveModel(model, Collections.emptyMap());
+  }
+
+  public static ConfigProperties resolveModel(OpenTelemetryConfigurationModel model, Map<String, String> translationMap) {
     SdkConfigProvider configProvider = SdkConfigProvider.create(model);
     DeclarativeConfigProperties instrumentationConfig = configProvider.getInstrumentationConfig();
     if (instrumentationConfig == null) {
       instrumentationConfig = DeclarativeConfigProperties.empty();
     }
 
-    return new DeclarativeConfigPropertiesBridge(instrumentationConfig);
+    return new DeclarativeConfigPropertiesBridge(instrumentationConfig, translationMap);
   }
 
   public static String propertyYamlPath(String propertyName) {

declarative-config-bridge/src/main/java/io/opentelemetry/contrib/sdk/autoconfigure/DeclarativeConfigPropertiesBridge.java

@@ -52,9 +52,12 @@ final class DeclarativeConfigPropertiesBridge implements ConfigProperties {
 
   // The node at .instrumentation.java
   private final DeclarativeConfigProperties instrumentationJavaNode;
+  private final Map<String, String> translationMap;
 
-  DeclarativeConfigPropertiesBridge(DeclarativeConfigProperties instrumentationNode) {
+  DeclarativeConfigPropertiesBridge(DeclarativeConfigProperties instrumentationNode,
+      Map<String, String> translationMap) {
     instrumentationJavaNode = instrumentationNode.getStructured("java", empty());
+    this.translationMap = translationMap;
   }
 
   @Nullable
@@ -134,7 +137,7 @@ private <T> T getPropertyValue(
       return null;
     }
 
-    String[] segments = getSegments(property);
+    String[] segments = getSegments(translate(property));
     if (segments.length == 0) {
       return null;
     }
@@ -151,6 +154,15 @@ private <T> T getPropertyValue(
     return extractor.apply(target, lastPart);
   }
 
+  private String translate(String property) {
+    for (Map.Entry<String, String> entry : translationMap.entrySet()) {
+      if (property.startsWith(entry.getKey())) {
+        return entry.getValue() + property.substring(entry.getKey().length());
+      }
+    }
+    return property;
+  }
+
   private static String[] getSegments(String property) {
     if (property.startsWith(OTEL_INSTRUMENTATION_PREFIX)) {
       property = property.substring(OTEL_INSTRUMENTATION_PREFIX.length());

declarative-config-bridge/src/test/java/io/opentelemetry/contrib/sdk/autoconfigure/DeclarativeConfigPropertiesBridgeTest.java

@@ -4,9 +4,9 @@
  */
 
 package io.opentelemetry.contrib.sdk.autoconfigure; /*
-                                                     * Copyright The OpenTelemetry Authors
-                                                     * SPDX-License-Identifier: Apache-2.0
-                                                     */
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -19,6 +19,7 @@
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
@@ -57,21 +58,26 @@ class DeclarativeConfigPropertiesBridgeTest {
 
   @BeforeEach
   void setup() {
-    OpenTelemetryConfigurationModel model =
-        DeclarativeConfiguration.parse(
-            new ByteArrayInputStream(YAML.getBytes(StandardCharsets.UTF_8)));
-    SdkConfigProvider configProvider = SdkConfigProvider.create(model);
-    bridge =
-        new DeclarativeConfigPropertiesBridge(
-            Objects.requireNonNull(configProvider.getInstrumentationConfig()));
+    bridge = createBridge(Collections.emptyMap());
 
     OpenTelemetryConfigurationModel emptyModel =
         new OpenTelemetryConfigurationModel()
             .withAdditionalProperty("instrumentation/development", new InstrumentationModel());
     SdkConfigProvider emptyConfigProvider = SdkConfigProvider.create(emptyModel);
     emptyBridge =
         new DeclarativeConfigPropertiesBridge(
-            Objects.requireNonNull(emptyConfigProvider.getInstrumentationConfig()));
+            Objects.requireNonNull(emptyConfigProvider.getInstrumentationConfig()),
+            Collections.emptyMap());
+  }
+
+  private static DeclarativeConfigPropertiesBridge createBridge(
+      Map<String, String> translationMap) {
+    OpenTelemetryConfigurationModel model =
+        DeclarativeConfiguration.parse(
+            new ByteArrayInputStream(YAML.getBytes(StandardCharsets.UTF_8)));
+    return new DeclarativeConfigPropertiesBridge(
+        Objects.requireNonNull(SdkConfigProvider.create(model).getInstrumentationConfig()),
+        translationMap);
   }
 
   @Test
@@ -126,21 +132,31 @@ void getProperties() {
     assertThat(bridge.getLong("otel.instrumentation.other-instrumentation.int_key", 1L))
         .isEqualTo(1L);
     assertThat(
-            bridge.getDuration(
-                "otel.instrumentation.other-instrumentation.int_key", Duration.ofMillis(1)))
+        bridge.getDuration(
+            "otel.instrumentation.other-instrumentation.int_key", Duration.ofMillis(1)))
         .isEqualTo(Duration.ofMillis(1));
     assertThat(bridge.getDouble("otel.instrumentation.other-instrumentation.double_key", 1.1))
         .isEqualTo(1.1);
     assertThat(
-            bridge.getList(
-                "otel.instrumentation.other-instrumentation.list_key",
-                Arrays.asList("value1", "value2")))
+        bridge.getList(
+            "otel.instrumentation.other-instrumentation.list_key",
+            Arrays.asList("value1", "value2")))
         .isEqualTo(Arrays.asList("value1", "value2"));
     assertThat(bridge.getMap("otel.instrumentation.other-instrumentation.map_key", expectedMap))
         .isEqualTo(expectedMap);
+  }
 
+  @Test
+  void vendor() {
     // verify vendor specific property names are preserved in unchanged form (prefix is not stripped
     // as for otel.instrumentation.*)
     assertThat(bridge.getBoolean("acme.full_name.preserved")).isTrue();
   }
+
+  @Test
+  void translation() {
+    DeclarativeConfigPropertiesBridge propertiesBridge = createBridge(
+        Collections.singletonMap("acme", "acme.full_name"));
+    assertThat(propertiesBridge.getBoolean("acme.preserved")).isTrue();
+  }
 }

inferred-spans/build.gradle.kts

@@ -9,10 +9,13 @@ description = "OpenTelemetry Java profiling based inferred spans module"
 otelJava.moduleName.set("io.opentelemetry.contrib.inferredspans")
 
 dependencies {
+  implementation(project(":declarative-config-bridge"))
+
   annotationProcessor("com.google.auto.service:auto-service")
   compileOnly("com.google.auto.service:auto-service-annotations")
   compileOnly("io.opentelemetry:opentelemetry-sdk")
   compileOnly("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
+  compileOnly("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   compileOnly("io.opentelemetry.semconv:opentelemetry-semconv")
   implementation("com.lmax:disruptor")
   implementation("org.jctools:jctools-core")
@@ -25,6 +28,7 @@ dependencies {
   testImplementation("io.opentelemetry.semconv:opentelemetry-semconv")
   testImplementation("io.opentelemetry:opentelemetry-sdk")
   testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
+  testImplementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
   testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
   testImplementation("io.opentelemetry:opentelemetry-api-incubator")
   testImplementation("io.opentelemetry:opentelemetry-exporter-logging")

inferred-spans/src/main/java/io/opentelemetry/contrib/inferredspans/InferredSpansCustomizerProvider.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.contrib.inferredspans;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.contrib.sdk.autoconfigure.ConfigPropertiesUtil;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizer;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizerProvider;
+import java.util.Collections;
+
+@AutoService(DeclarativeConfigurationCustomizerProvider.class)
+public class InferredSpansCustomizerProvider implements DeclarativeConfigurationCustomizerProvider {
+
+  @Override
+  public void customize(DeclarativeConfigurationCustomizer customizer) {
+    customizer.addModelCustomizer(
+        model -> {
+          ConfigProperties configProperties = ConfigPropertiesUtil.resolveModel(model,
+              Collections.singletonMap("otel.inferred.spans", "inferred_spans"));
+
+          return model;
+        });
+  }
+
+}