pr review

Author: zeitlinger

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

@@ -53,19 +53,25 @@ final class DeclarativeConfigPropertiesBridge implements ConfigProperties {
 
   private static final String OTEL_INSTRUMENTATION_PREFIX = "otel.instrumentation.";
 
-  private final ConfigPropertiesTranslator translator;
   @Nullable private final DeclarativeConfigProperties baseNode;
 
+  // lookup order matters - we choose the first match
+  private final Map<String, String> translationMap;
+  private final Map<String, Object> overrideValues;
+
   DeclarativeConfigPropertiesBridge(
-      @Nullable DeclarativeConfigProperties baseNode, ConfigPropertiesTranslator translator) {
+      @Nullable DeclarativeConfigProperties baseNode,
+      Map<String, String> translationMap,
+      Map<String, Object> overrideValues) {
     this.baseNode = baseNode;
-    this.translator = translator;
+    this.translationMap = translationMap;
+    this.overrideValues = overrideValues;
   }
 
   @Nullable
   @Override
   public String getString(String propertyName) {
-    Object value = translator.get(propertyName);
+    Object value = getOverride(propertyName);
     if (value != null) {
       return value.toString();
     }
@@ -75,7 +81,7 @@ public String getString(String propertyName) {
   @Nullable
   @Override
   public Boolean getBoolean(String propertyName) {
-    Object value = translator.get(propertyName);
+    Object value = getOverride(propertyName);
     if (value != null) {
       return (Boolean) value;
     }
@@ -85,7 +91,7 @@ public Boolean getBoolean(String propertyName) {
   @Nullable
   @Override
   public Integer getInt(String propertyName) {
-    Object value = translator.get(propertyName);
+    Object value = getOverride(propertyName);
     if (value != null) {
       return (Integer) value;
     }
@@ -95,7 +101,7 @@ public Integer getInt(String propertyName) {
   @Nullable
   @Override
   public Long getLong(String propertyName) {
-    Object value = translator.get(propertyName);
+    Object value = getOverride(propertyName);
     if (value != null) {
       return (Long) value;
     }
@@ -105,7 +111,7 @@ public Long getLong(String propertyName) {
   @Nullable
   @Override
   public Double getDouble(String propertyName) {
-    Object value = translator.get(propertyName);
+    Object value = getOverride(propertyName);
     if (value != null) {
       return (Double) value;
     }
@@ -115,7 +121,7 @@ public Double getDouble(String propertyName) {
   @Nullable
   @Override
   public Duration getDuration(String propertyName) {
-    Object value = translator.get(propertyName);
+    Object value = getOverride(propertyName);
     if (value != null) {
       return (Duration) value;
     }
@@ -129,7 +135,7 @@ public Duration getDuration(String propertyName) {
   @SuppressWarnings("unchecked")
   @Override
   public List<String> getList(String propertyName) {
-    Object value = translator.get(propertyName);
+    Object value = getOverride(propertyName);
     if (value != null) {
       return (List<String>) value;
     }
@@ -143,7 +149,7 @@ public List<String> getList(String propertyName) {
   @SuppressWarnings("unchecked")
   @Override
   public Map<String, String> getMap(String propertyName) {
-    Object fixed = translator.get(propertyName);
+    Object fixed = getOverride(propertyName);
     if (fixed != null) {
       return (Map<String, String>) fixed;
     }
@@ -173,7 +179,7 @@ private <T> T getPropertyValue(
       return null;
     }
 
-    String[] segments = getSegments(translator.translateProperty(property));
+    String[] segments = getSegments(translateProperty(property));
     if (segments.length == 0) {
       return null;
     }
@@ -197,4 +203,18 @@ private static String[] getSegments(String property) {
     // Split the remainder of the property on "."
     return property.replace('-', '_').split("\\.");
   }
+
+  private 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;
+  }
+
+  @Nullable
+  private Object getOverride(String propertyName) {
+    return overrideValues.get(propertyName);
+  }
 }

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

@@ -26,20 +26,36 @@
  */
 public class DeclarativeConfigPropertiesBridgeBuilder {
   private final LinkedHashMap<String, String> translationMap = new LinkedHashMap<>();
-  private final Map<String, Object> fixedValues = new LinkedHashMap<>();
+  private final Map<String, Object> overrideValues = new LinkedHashMap<>();
 
   public DeclarativeConfigPropertiesBridgeBuilder() {}
 
+  /**
+   * Adds a translation from a property prefix to a YAML path.
+   *
+   * <p>For example, if the property prefix is "otel.javaagent" and the YAML path is "agent", then
+   * any property starting with "otel.javaagent." will be resolved against the "agent" node in the
+   * instrumentation/java section of the YAML configuration.
+   *
+   * @param propertyPrefix the prefix of the property to translate
+   * @param yamlPath the YAML path to resolve the property against
+   */
   @CanIgnoreReturnValue
   public DeclarativeConfigPropertiesBridgeBuilder addTranslation(
-      String propertyName, String yamlPath) {
-    translationMap.put(propertyName, yamlPath);
+      String propertyPrefix, String yamlPath) {
+    translationMap.put(propertyPrefix, yamlPath);
     return this;
   }
 
+  /**
+   * Adds a fixed override value for a property.
+   *
+   * @param propertyName the name of the property to override
+   * @param value the value to return when the property is requested
+   */
   @CanIgnoreReturnValue
-  public DeclarativeConfigPropertiesBridgeBuilder addFixedValue(String propertyName, Object value) {
-    fixedValues.put(propertyName, value);
+  public DeclarativeConfigPropertiesBridgeBuilder addOverride(String propertyName, Object value) {
+    overrideValues.put(propertyName, value);
     return this;
   }
 
@@ -67,7 +83,6 @@ public ConfigProperties resolveInstrumentationConfig(
       instrumentationConfig = DeclarativeConfigProperties.empty();
     }
     return new DeclarativeConfigPropertiesBridge(
-        instrumentationConfig.getStructured("java", empty()),
-        new ConfigPropertiesTranslator(translationMap, fixedValues));
+        instrumentationConfig.getStructured("java", empty()), translationMap, overrideValues);
   }
 }

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

@@ -148,8 +148,8 @@ void agentTranslation() {
         create(
             new DeclarativeConfigPropertiesBridgeBuilder()
                 .addTranslation("otel.javaagent", "agent")
-                .addFixedValue("otel.javaagent.debug", true)
-                .addFixedValue("otel.javaagent.logging", "application"));
+                .addOverride("otel.javaagent.debug", true)
+                .addOverride("otel.javaagent.logging", "application"));
 
     assertThat(bridge.getBoolean("otel.javaagent.debug")).isTrue();
     assertThat(bridge.getBoolean("otel.javaagent.experimental.indy")).isTrue();

javaagent-extension-api/src/test/java/io/opentelemetry/javaagent/extension/internal/DeclarativeConfigPropertiesBridgeTest.java

@@ -54,9 +54,9 @@ public static AutoConfiguredOpenTelemetrySdk installOpenTelemetrySdk(
               // these properties are used to initialize the SDK before the configuration file
               // is loaded for consistency, we pass them to the bridge, so that they can be read
               // later with the same value from the {@link DeclarativeConfigPropertiesBridge}
-              .addFixedValue(
+              .addOverride(
                   "otel.javaagent.debug", earlyConfig.getBoolean("otel.javaagent.debug", false))
-              .addFixedValue(
+              .addOverride(
                   "otel.javaagent.logging", earlyConfig.getString("otel.javaagent.logging"))
               .resolveInstrumentationConfig(configProvider.getInstrumentationConfig()),
           configProvider);