update config bridge from agent

Author: zeitlinger

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

@@ -5,14 +5,19 @@
 
 package io.opentelemetry.contrib.sdk.autoconfigure;
 
-/**
- * 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() {}
 
   public static String propertyYamlPath(String propertyName) {
-    return DeclarativeConfigPropertiesBridge.yamlPath(propertyName);
+    return yamlPath(propertyName);
   }
+
+  static String yamlPath(String property) {
+     String[] segments = DeclarativeConfigPropertiesBridge.getSegments(property);
+     if (segments.length == 0) {
+       throw new IllegalArgumentException("Invalid property: " + property);
+     }
+
+     return "'instrumentation/development' / 'java' / '" + String.join("' / '", segments) + "'";
+   }
 }

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

@@ -14,6 +14,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.function.BiFunction;
 import javax.annotation.Nullable;
 
@@ -45,81 +46,60 @@
  *       common:
  *         string_key: value
  * </pre>
- *
- * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
- * at any time.
  */
 final class DeclarativeConfigPropertiesBridge implements ConfigProperties {
 
   private static final String OTEL_INSTRUMENTATION_PREFIX = "otel.instrumentation.";
 
-  private final ConfigPropertiesTranslator translator;
-  @Nullable private final DeclarativeConfigProperties baseNode;
+  private final DeclarativeConfigProperties baseNode;
+
+  // lookup order matters - we choose the first match
+  private final Map<String, String> mappings;
+  private final Map<String, Object> overrideValues;
 
   DeclarativeConfigPropertiesBridge(
-      @Nullable DeclarativeConfigProperties baseNode, ConfigPropertiesTranslator translator) {
-    this.baseNode = baseNode;
-    this.translator = translator;
+      DeclarativeConfigProperties baseNode,
+      Map<String, String> mappings,
+      Map<String, Object> overrideValues) {
+    this.baseNode = Objects.requireNonNull(baseNode);
+    this.mappings = mappings;
+    this.overrideValues = overrideValues;
   }
 
   @Nullable
   @Override
   public String getString(String propertyName) {
-    Object value = translator.get(propertyName);
-    if (value != null) {
-      return value.toString();
-    }
-    return getPropertyValue(propertyName, DeclarativeConfigProperties::getString);
+    return getPropertyValue(propertyName, String.class, DeclarativeConfigProperties::getString);
   }
 
   @Nullable
   @Override
   public Boolean getBoolean(String propertyName) {
-    Object value = translator.get(propertyName);
-    if (value != null) {
-      return (Boolean) value;
-    }
-    return getPropertyValue(propertyName, DeclarativeConfigProperties::getBoolean);
+    return getPropertyValue(propertyName, Boolean.class, DeclarativeConfigProperties::getBoolean);
   }
 
   @Nullable
   @Override
   public Integer getInt(String propertyName) {
-    Object value = translator.get(propertyName);
-    if (value != null) {
-      return (Integer) value;
-    }
-    return getPropertyValue(propertyName, DeclarativeConfigProperties::getInt);
+    return getPropertyValue(propertyName, Integer.class, 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);
+    return getPropertyValue(propertyName, Long.class, 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);
+    return getPropertyValue(propertyName, Double.class, 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);
+    Long millis = getPropertyValue(propertyName, Long.class, DeclarativeConfigProperties::getLong);
     if (millis == null) {
       return null;
     }
@@ -129,26 +109,22 @@ public Duration getDuration(String propertyName) {
   @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,
+            List.class,
             (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);
+        getPropertyValue(
+            propertyName,
+            DeclarativeConfigProperties.class,
+            DeclarativeConfigProperties::getStructured);
     if (propertyValue == null) {
       return Collections.emptyMap();
     }
@@ -168,12 +144,15 @@ public Map<String, String> getMap(String propertyName) {
 
   @Nullable
   private <T> T getPropertyValue(
-      String property, BiFunction<DeclarativeConfigProperties, String, T> extractor) {
-    if (baseNode == null) {
-      return null;
+      String property,
+      Class<T> clazz,
+      BiFunction<DeclarativeConfigProperties, String, T> extractor) {
+    T override = clazz.cast(overrideValues.get(property));
+    if (override != null) {
+      return override;
     }
 
-    String[] segments = getSegments(translator.translateProperty(property));
+    String[] segments = getSegments(translateProperty(property));
     if (segments.length == 0) {
       return null;
     }
@@ -190,20 +169,20 @@ private <T> T getPropertyValue(
     return extractor.apply(target, lastPart);
   }
 
-  private static String[] getSegments(String property) {
+  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("\\.");
   }
 
-  static String yamlPath(String property) {
-    String[] segments = getSegments(property);
-    if (segments.length == 0) {
-      throw new IllegalArgumentException("Invalid property: " + property);
+  private String translateProperty(String property) {
+    for (Map.Entry<String, String> entry : mappings.entrySet()) {
+      if (property.startsWith(entry.getKey())) {
+        return entry.getValue() + property.substring(entry.getKey().length());
+      }
     }
-
-    return "'instrumentation/development' / 'java' / '" + String.join("' / '", segments) + "'";
+    return property;
   }
 }

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

@@ -13,39 +13,57 @@
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import javax.annotation.Nullable;
 
 /**
  * A builder for {@link DeclarativeConfigPropertiesBridge} that allows adding translations and fixed
  * values for properties.
- *
- * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
- * at any time.
  */
 public class DeclarativeConfigPropertiesBridgeBuilder {
-  private final LinkedHashMap<String, String> translationMap = new LinkedHashMap<>();
-  private final Map<String, Object> fixedValues = new LinkedHashMap<>();
+  /**
+   * order is important here, so we use LinkedHashMap - see {@link #addMapping(String, String)} for
+   * more details
+   */
+  private final Map<String, String> mappings = new LinkedHashMap<>();
+
+  private final Map<String, Object> overrideValues = new HashMap<>();
 
   public DeclarativeConfigPropertiesBridgeBuilder() {}
 
+  /**
+   * Adds a mapping 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);
+  public DeclarativeConfigPropertiesBridgeBuilder addMapping(
+      String propertyPrefix, String yamlPath) {
+    mappings.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;
   }
 
-  /** Resolve {@link ConfigProperties} from the {@code autoConfiguredOpenTelemetrySdk}. */
-  public ConfigProperties resolveConfigProperties(
-      AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
+  /** Build {@link ConfigProperties} from the {@code autoConfiguredOpenTelemetrySdk}. */
+  public ConfigProperties build(AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
     ConfigProperties sdkConfigProperties =
         AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk);
     if (sdkConfigProperties != null) {
@@ -54,23 +72,31 @@ public ConfigProperties resolveConfigProperties(
     ConfigProvider configProvider =
         AutoConfigureUtil.getConfigProvider(autoConfiguredOpenTelemetrySdk);
     if (configProvider != null) {
-      return resolveInstrumentationConfig(configProvider.getInstrumentationConfig());
+      return buildFromInstrumentationConfig(configProvider.getInstrumentationConfig());
     }
     // Should never happen
     throw new IllegalStateException(
         "AutoConfiguredOpenTelemetrySdk does not have ConfigProperties or DeclarativeConfigProperties. This is likely a programming error in opentelemetry-java");
   }
 
-  public ConfigProperties resolveInstrumentationConfig(
+  /**
+   * Build {@link ConfigProperties} from the {@link DeclarativeConfigProperties} provided by the
+   * instrumentation configuration.
+   *
+   * <p>If the provided {@code instrumentationConfig} is null, an empty {@link
+   * DeclarativeConfigProperties} will be used.
+   *
+   * @param instrumentationConfig the instrumentation configuration to build from
+   * @return a new instance of {@link ConfigProperties}
+   */
+  public ConfigProperties buildFromInstrumentationConfig(
       @Nullable DeclarativeConfigProperties instrumentationConfig) {
+    // leave the name "build" for a future method that builds from a DeclarativeConfigProperties
+    // instance that doesn't come from the top-level instrumentation config
     if (instrumentationConfig == null) {
       instrumentationConfig = DeclarativeConfigProperties.empty();
     }
-    return resolveConfig(instrumentationConfig.getStructured("java", empty()));
-  }
-
-  public ConfigProperties resolveConfig(@Nullable DeclarativeConfigProperties config) {
     return new DeclarativeConfigPropertiesBridge(
-        config, new ConfigPropertiesTranslator(translationMap, fixedValues));
+        instrumentationConfig.getStructured("java", empty()), mappings, overrideValues);
   }
 }

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

@@ -33,7 +33,7 @@ void shouldUseConfigPropertiesForAutoConfiguration() {
           .thenReturn(configPropertiesMock);
 
       ConfigProperties configProperties =
-          new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
+          new DeclarativeConfigPropertiesBridgeBuilder().build(sdkMock);
 
       assertThat(configProperties).isSameAs(configPropertiesMock);
     }
@@ -62,7 +62,7 @@ void shouldUseConfigProviderForDeclarativeConfiguration() {
           .thenReturn(configProviderMock);
 
       ConfigProperties configProperties =
-          new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
+          new DeclarativeConfigPropertiesBridgeBuilder().build(sdkMock);
 
       assertThat(configProperties.getString(propertyName)).isEqualTo(expectedValue);
     }
@@ -82,9 +82,9 @@ void shouldUseConfigProviderForDeclarativeConfiguration_noInstrumentationConfig(
           .thenReturn(configProviderMock);
 
       ConfigProperties configProperties =
-          new DeclarativeConfigPropertiesBridgeBuilder().resolveConfigProperties(sdkMock);
+          new DeclarativeConfigPropertiesBridgeBuilder().build(sdkMock);
 
-      assertThat(configProperties.getString("testProperty")).isEqualTo(null);
+      assertThat(configProperties.getString("testProperty")).isNull();
     }
   }
 }