map agent props

Author: zeitlinger

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

@@ -8,6 +8,7 @@
 import static io.opentelemetry.api.incubator.config.DeclarativeConfigProperties.empty;
 
 import io.opentelemetry.api.incubator.config.ConfigProvider;
+import io.opentelemetry.api.incubator.config.DeclarativeConfigException;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import java.time.Duration;
@@ -64,13 +65,23 @@ public final class DeclarativeConfigPropertiesBridge implements ConfigProperties
 
   static {
     JAVA_MAPPING_RULES.put("otel.instrumentation.common.default-enabled", "common.default.enabled");
+    JAVA_MAPPING_RULES.put("otel.javaagent.logging.application.logs-buffer-max-records", "agent.logging.output.application.logs_buffer_max_records");
 
     // not supported in SDK yet (this is strictly typed)
-//    GENERAL_MAPPING_RULES.put("otel.instrumentation.http.known-methods", "http.known_methods");
-    GENERAL_MAPPING_RULES.put("otel.instrumentation.http.client.capture-request-headers", "http.client.request_captured_headers");
-    GENERAL_MAPPING_RULES.put("otel.instrumentation.http.client.capture-response-headers", "http.client.response_captured_headers");
-    GENERAL_MAPPING_RULES.put("otel.instrumentation.http.server.capture-request-headers", "http.server.request_captured_headers");
-    GENERAL_MAPPING_RULES.put("otel.instrumentation.http.server.capture-response-headers", "http.server.response_captured_headers");
+    //    GENERAL_MAPPING_RULES.put("otel.instrumentation.http.known-methods",
+    // "http.known_methods");
+    GENERAL_MAPPING_RULES.put(
+        "otel.instrumentation.http.client.capture-request-headers",
+        "http.client.request_captured_headers");
+    GENERAL_MAPPING_RULES.put(
+        "otel.instrumentation.http.client.capture-response-headers",
+        "http.client.response_captured_headers");
+    GENERAL_MAPPING_RULES.put(
+        "otel.instrumentation.http.server.capture-request-headers",
+        "http.server.request_captured_headers");
+    GENERAL_MAPPING_RULES.put(
+        "otel.instrumentation.http.server.capture-response-headers",
+        "http.server.response_captured_headers");
   }
 
   private static Map<String, String> getPeerServiceMapping(
@@ -99,6 +110,10 @@ public DeclarativeConfigPropertiesBridge(ConfigProvider configProvider) {
   @Nullable
   @Override
   public String getString(String propertyName) {
+    if ("otel.javaagent.logging".equals(propertyName)) {
+      return agentLoggerName();
+    }
+
     return getPropertyValue(propertyName, DeclarativeConfigProperties::getString);
   }
 
@@ -215,4 +230,28 @@ private static String getJavaPath(String property) {
     }
     return null;
   }
+
+  private String agentLoggerName() {
+    DeclarativeConfigProperties logOutput = getLogOutput();
+    DeclarativeConfigProperties application = logOutput.getStructured("application");
+    DeclarativeConfigProperties simple = logOutput.getStructured("simple");
+    if (application != null) {
+      if (simple != null) {
+        throw new DeclarativeConfigException(
+            "Both 'application' and 'simple' log output are configured. "
+                + "Please choose one of them.");
+      }
+      return "application";
+    }
+    // simple is the default
+    return "simple";
+  }
+
+  private DeclarativeConfigProperties getLogOutput() {
+    return getAgent().getStructured("logging", empty()).getStructured("output", empty());
+  }
+
+  private DeclarativeConfigProperties getAgent() {
+    return instrumentationJavaNode.getStructured("agent", empty());
+  }
 }

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

@@ -19,6 +19,7 @@
 import java.util.Map;
 import java.util.Objects;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 class DeclarativeConfigPropertiesBridgeTest {
@@ -107,15 +108,18 @@ void getProperties() {
         .isEqualTo(Arrays.asList("value1", "value2"));
     assertThat(bridge.getMap("otel.instrumentation.other-instrumentation.map_key", expectedMap))
         .isEqualTo(expectedMap);
+  }
 
-    // specific property mappings
-    assertThat(bridge.getBoolean("otel.javaagent.experimental.indy")).isTrue();
-    assertThat(bridge.getBoolean("otel.instrumentation.common.default-enabled")).isFalse();
+  // tests for specific properties
+
+  @DisplayName("properties from the general instrumentation section in config.yaml")
+  @Test
+  void general() {
     assertThat(bridge.getMap("otel.instrumentation.common.peer-service-mapping"))
         .containsOnly(entry("1.2.3.4", "FooService"), entry("2.3.4.5", "BarService"));
     // not supported in SDK yet (this is strictly typed)
-//    assertThat(bridge.getList("otel.instrumentation.http.known-methods"))
-//        .containsExactly("GET", "POST", "PUT");
+    //    assertThat(bridge.getList("otel.instrumentation.http.known-methods"))
+    //        .containsExactly("GET", "POST", "PUT");
     assertThat(bridge.getList("otel.instrumentation.http.client.capture-request-headers"))
         .containsExactly("Content-Type", "Accept");
     assertThat(bridge.getList("otel.instrumentation.http.client.capture-response-headers"))
@@ -125,4 +129,17 @@ void getProperties() {
     assertThat(bridge.getList("otel.instrumentation.http.server.capture-response-headers"))
         .containsExactly("Content-Type", "Content-Encoding");
   }
+
+  @Test
+  void common() {
+    assertThat(bridge.getBoolean("otel.instrumentation.common.default-enabled")).isFalse();
+  }
+
+  @Test
+  void agent() {
+    assertThat(bridge.getBoolean("otel.javaagent.experimental.indy")).isTrue();
+    assertThat(bridge.getString("otel.javaagent.logging")).isEqualTo("application");
+    assertThat(bridge.getInt("otel.javaagent.logging.application.logs-buffer-max-records"))
+        .isEqualTo(1000);
+  }
 }

javaagent-extension-api/src/test/resources/config.yaml

@@ -31,6 +31,10 @@ instrumentation/development:
     agent:
       experimental:
         indy: true
+      logging:
+        output:
+          application:
+            logs_buffer_max_records: 1000
     common:
       default:
         enabled: false