use unified config bridge

Author: zeitlinger

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/ConfigPropertiesUtil.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.extension.internal;
+
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+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 final class ConfigPropertiesUtil {
+  private ConfigPropertiesUtil() {}
+
+  /** Resolve {@link ConfigProperties} from the {@code autoConfiguredOpenTelemetrySdk}. */
+  public static ConfigProperties resolveConfigProperties(
+      AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
+    ConfigProperties sdkConfigProperties =
+        AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk);
+    if (sdkConfigProperties != null) {
+      return sdkConfigProperties;
+    }
+    ConfigProvider configProvider =
+        AutoConfigureUtil.getConfigProvider(autoConfiguredOpenTelemetrySdk);
+    if (configProvider != null) {
+      return resolveInstrumentationConfig(
+          configProvider.getInstrumentationConfig(), propertyTranslatorBuilder());
+    }
+    // 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 resolveInstrumentationConfig(
+      @Nullable DeclarativeConfigProperties instrumentationConfig) {
+    return resolveInstrumentationConfig(instrumentationConfig, propertyTranslatorBuilder());
+  }
+
+  public static ConfigProperties resolveInstrumentationConfig(
+      @Nullable DeclarativeConfigProperties instrumentationConfig,
+      PropertyTranslatorBuilder builder) {
+    return DeclarativeConfigPropertiesBridge.fromInstrumentationConfig(
+        instrumentationConfig, builder.build());
+  }
+
+  public static ConfigProperties resolveConfig(
+      @Nullable DeclarativeConfigProperties config, PropertyTranslatorBuilder builder) {
+    return DeclarativeConfigPropertiesBridge.create(config, builder.build());
+  }
+
+  public static String propertyYamlPath(String propertyName) {
+    return DeclarativeConfigPropertiesBridge.yamlPath(propertyName);
+  }
+
+  public static PropertyTranslatorBuilder propertyTranslatorBuilder() {
+    return new PropertyTranslatorBuilder();
+  }
+}

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridge.java

@@ -7,7 +7,6 @@
 
 import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
 
-import io.opentelemetry.api.incubator.config.ConfigProvider;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import java.time.Duration;
@@ -50,36 +49,37 @@
  * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
  * at any time.
  */
-public final class DeclarativeConfigPropertiesBridge implements ConfigProperties {
+final class DeclarativeConfigPropertiesBridge implements ConfigProperties {
 
   private static final String OTEL_INSTRUMENTATION_PREFIX = "otel.instrumentation.";
-  private static final String OTEL_JAVA_AGENT_PREFIX = "otel.javaagent.";
 
-  private static final Map<String, String> JAVA_MAPPING_RULES = new HashMap<>();
+  private final PropertyTranslator translator;
+  @Nullable private final DeclarativeConfigProperties baseNode;
 
-  // The node at .instrumentation.java
-  private final DeclarativeConfigProperties instrumentationJavaNode;
-
-  static {
-    JAVA_MAPPING_RULES.put("otel.instrumentation.common.default-enabled", "common.default.enabled");
+  static DeclarativeConfigPropertiesBridge fromInstrumentationConfig(
+      @Nullable DeclarativeConfigProperties instrumentationConfig, PropertyTranslator translator) {
+    if (instrumentationConfig == null) {
+      instrumentationConfig = DeclarativeConfigProperties.empty();
+    }
+    return new DeclarativeConfigPropertiesBridge(
+        instrumentationConfig.getStructured("java", empty()), translator);
   }
 
-  private final Map<String, Object> earlyInitProperties;
+  static DeclarativeConfigPropertiesBridge create(
+      @Nullable DeclarativeConfigProperties node, PropertyTranslator translator) {
+    return new DeclarativeConfigPropertiesBridge(node, translator);
+  }
 
-  public DeclarativeConfigPropertiesBridge(
-      ConfigProvider configProvider, Map<String, Object> earlyInitProperties) {
-    this.earlyInitProperties = earlyInitProperties;
-    DeclarativeConfigProperties inst = configProvider.getInstrumentationConfig();
-    if (inst == null) {
-      inst = DeclarativeConfigProperties.empty();
-    }
-    instrumentationJavaNode = inst.getStructured("java", empty());
+  private DeclarativeConfigPropertiesBridge(
+      @Nullable DeclarativeConfigProperties baseNode, PropertyTranslator translator) {
+    this.baseNode = baseNode;
+    this.translator = translator;
   }
 
   @Nullable
   @Override
   public String getString(String propertyName) {
-    Object value = earlyInitProperties.get(propertyName);
+    Object value = translator.get(propertyName);
     if (value != null) {
       return value.toString();
     }
@@ -89,7 +89,7 @@ public String getString(String propertyName) {
   @Nullable
   @Override
   public Boolean getBoolean(String propertyName) {
-    Object value = earlyInitProperties.get(propertyName);
+    Object value = translator.get(propertyName);
     if (value != null) {
       return (Boolean) value;
     }
@@ -99,42 +99,68 @@ public Boolean getBoolean(String propertyName) {
   @Nullable
   @Override
   public Integer getInt(String propertyName) {
+    Object value = translator.get(propertyName);
+    if (value != null) {
+      return (Integer) value;
+    }
     return getPropertyValue(propertyName, DeclarativeConfigProperties::getInt);
   }
 
   @Nullable
   @Override
   public Long getLong(String propertyName) {
+    Object value = translator.get(propertyName);
+    if (value != null) {
+      return (Long) value;
+    }
     return getPropertyValue(propertyName, DeclarativeConfigProperties::getLong);
   }
 
   @Nullable
   @Override
   public Double getDouble(String propertyName) {
+    Object value = translator.get(propertyName);
+    if (value != null) {
+      return (Double) value;
+    }
     return getPropertyValue(propertyName, DeclarativeConfigProperties::getDouble);
   }
 
   @Nullable
   @Override
   public Duration getDuration(String propertyName) {
+    Object value = translator.get(propertyName);
+    if (value != null) {
+      return (Duration) value;
+    }
     Long millis = getPropertyValue(propertyName, DeclarativeConfigProperties::getLong);
     if (millis == null) {
       return null;
     }
     return Duration.ofMillis(millis);
   }
 
+  @SuppressWarnings("unchecked")
   @Override
   public List<String> getList(String propertyName) {
+    Object value = translator.get(propertyName);
+    if (value != null) {
+      return (List<String>) value;
+    }
     List<String> propertyValue =
         getPropertyValue(
             propertyName,
             (properties, lastPart) -> properties.getScalarList(lastPart, String.class));
     return propertyValue == null ? Collections.emptyList() : propertyValue;
   }
 
+  @SuppressWarnings("unchecked")
   @Override
   public Map<String, String> getMap(String propertyName) {
+    Object fixed = translator.get(propertyName);
+    if (fixed != null) {
+      return (Map<String, String>) fixed;
+    }
     DeclarativeConfigProperties propertyValue =
         getPropertyValue(propertyName, DeclarativeConfigProperties::getStructured);
     if (propertyValue == null) {
@@ -157,38 +183,41 @@ public Map<String, String> getMap(String propertyName) {
   @Nullable
   private <T> T getPropertyValue(
       String property, BiFunction<DeclarativeConfigProperties, String, T> extractor) {
-    return splitOnDot(getJavaPath(property), instrumentationJavaNode, extractor);
-  }
+    if (baseNode == null) {
+      return null;
+    }
 
-  private static <T> T splitOnDot(
-      String path,
-      DeclarativeConfigProperties target,
-      BiFunction<DeclarativeConfigProperties, String, T> extractor) {
-    // Split the remainder of the property on ".", and walk to the N-1 entry
-    String[] segments = path.split("\\.");
+    String[] segments = getSegments(translator.translateProperty(property));
     if (segments.length == 0) {
       return null;
     }
+
+    // Extract the value by walking to the N-1 entry
+    DeclarativeConfigProperties target = baseNode;
     if (segments.length > 1) {
       for (int i = 0; i < segments.length - 1; i++) {
         target = target.getStructured(segments[i], empty());
       }
     }
     String lastPart = segments[segments.length - 1];
+
     return extractor.apply(target, lastPart);
   }
 
-  private static String getJavaPath(String property) {
-    String special = JAVA_MAPPING_RULES.get(property);
-    if (special != null) {
-      return special;
+  private static String[] getSegments(String property) {
+    if (property.startsWith(OTEL_INSTRUMENTATION_PREFIX)) {
+      property = property.substring(OTEL_INSTRUMENTATION_PREFIX.length());
     }
+    // Split the remainder of the property on "."
+    return property.replace('-', '_').split("\\.");
+  }
 
-    if (property.startsWith(OTEL_INSTRUMENTATION_PREFIX)) {
-      return property.substring(OTEL_INSTRUMENTATION_PREFIX.length()).replace('-', '_');
-    } else if (property.startsWith(OTEL_JAVA_AGENT_PREFIX)) {
-      return "agent." + property.substring(OTEL_JAVA_AGENT_PREFIX.length()).replace('-', '_');
+  static String yamlPath(String property) {
+    String[] segments = getSegments(property);
+    if (segments.length == 0) {
+      throw new IllegalArgumentException("Invalid property: " + property);
     }
-    return property;
+
+    return "'instrumentation/development' / 'java' / '" + String.join("' / '", segments) + "'";
   }
 }

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/PropertyTranslator.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.extension.internal;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+class PropertyTranslator {
+  // lookup order matters - we choose the first match
+  private final LinkedHashMap<String, String> translationMap;
+  private final Map<String, Object> fixedValues;
+
+  PropertyTranslator(
+      LinkedHashMap<String, String> translationMap, Map<String, Object> fixedValues) {
+    this.translationMap = translationMap;
+    this.fixedValues = fixedValues;
+  }
+
+  String translateProperty(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;
+  }
+
+  public Object get(String propertyName) {
+    return fixedValues.get(propertyName);
+  }
+}

javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/extension/internal/PropertyTranslatorBuilder.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.extension.internal;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class PropertyTranslatorBuilder {
+  private final LinkedHashMap<String, String> translationMap = new LinkedHashMap<>();
+  private final Map<String, Object> fixedValues = new LinkedHashMap<>();
+
+  PropertyTranslatorBuilder() {}
+
+  public PropertyTranslatorBuilder addTranslation(String propertyName, String yamlPath) {
+    translationMap.put(propertyName, yamlPath);
+    return this;
+  }
+
+  public PropertyTranslatorBuilder addFixedValue(String propertyName, Object value) {
+    fixedValues.put(propertyName, value);
+    return this;
+  }
+
+  PropertyTranslator build() {
+    return new PropertyTranslator(translationMap, fixedValues);
+  }
+}