enable java experimental runtime metrics by default (elastic#1056)

Author: SylvainJuge

custom/src/main/java/co/elastic/otel/declarativeconfig/ElasticDeclarativeConfigurationCustomizer.java

@@ -29,6 +29,9 @@
 import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizerProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchLogRecordProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchSpanProcessorModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalInstrumentationModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalLanguageSpecificInstrumentationModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalLanguageSpecificInstrumentationPropertyModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalResourceDetectionModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalResourceDetectorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.LogRecordExporterModel;
@@ -58,16 +61,49 @@
 public class ElasticDeclarativeConfigurationCustomizer
     implements DeclarativeConfigurationCustomizerProvider {
 
+  private static final String RUNTIME_TELEMETRY = "runtime_telemetry";
+  private static final String EMIT_EXPERIMENTAL_METRICS_DEVELOPMENT =
+      "emit_experimental_metrics/development";
+
   @Override
   public void customize(DeclarativeConfigurationCustomizer customizer) {
     customizer.addModelCustomizer(
         model -> {
           customizeResources(model);
           customizeUserAgent(model);
+          customizeExperimentalRuntimeTelemetryMetrics(model);
           return model;
         });
   }
 
+  private static void customizeExperimentalRuntimeTelemetryMetrics(
+      OpenTelemetryConfigurationModel model) {
+
+    ExperimentalInstrumentationModel instrumentationDevelopment =
+        model.getInstrumentationDevelopment();
+    if (instrumentationDevelopment == null) {
+      instrumentationDevelopment = new ExperimentalInstrumentationModel();
+      model.withInstrumentationDevelopment(instrumentationDevelopment);
+    }
+
+    ExperimentalLanguageSpecificInstrumentationModel java = instrumentationDevelopment.getJava();
+    if (java == null) {
+      java = new ExperimentalLanguageSpecificInstrumentationModel();
+      instrumentationDevelopment.withJava(java);
+    }
+
+    ExperimentalLanguageSpecificInstrumentationPropertyModel runtimeTelemetry =
+        java.getAdditionalProperties().get(RUNTIME_TELEMETRY);
+    if (runtimeTelemetry == null) {
+      runtimeTelemetry = new ExperimentalLanguageSpecificInstrumentationPropertyModel();
+      java.withAdditionalProperty(RUNTIME_TELEMETRY, runtimeTelemetry);
+    }
+    if (runtimeTelemetry.getAdditionalProperties().get(EMIT_EXPERIMENTAL_METRICS_DEVELOPMENT)
+        == null) {
+      runtimeTelemetry.withAdditionalProperty(EMIT_EXPERIMENTAL_METRICS_DEVELOPMENT, true);
+    }
+  }
+
   private static void customizeResources(OpenTelemetryConfigurationModel model) {
     // this is equivalent to adding the following explicitly in declarative configuration
     //

custom/src/test/java/co/elastic/otel/declarativeconfig/ElasticDeclarativeConfigurationCustomizerTest.java

@@ -29,6 +29,9 @@
 import io.opentelemetry.sdk.extension.incubator.fileconfig.DeclarativeConfigurationCustomizerProvider;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchLogRecordProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BatchSpanProcessorModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalInstrumentationModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalLanguageSpecificInstrumentationModel;
+import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.ExperimentalLanguageSpecificInstrumentationPropertyModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.LogRecordExporterModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.LogRecordProcessorModel;
 import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.LoggerProviderModel;
@@ -80,6 +83,12 @@ void defaultConfig() {
     assertThat(model.getTracerProvider()).isNull();
     assertThat(model.getMeterProvider()).isNull();
     assertThat(model.getLoggerProvider()).isNull();
+
+    // java experimental runtime metrics enabled by default
+    assertThatJson(json(model.getInstrumentationDevelopment()))
+        .inPath("java.runtime_telemetry.emit_experimental_metrics/development")
+        .isBoolean()
+        .isTrue();
   }
 
   @ParameterizedTest
@@ -236,6 +245,28 @@ void addUserAgentPriority() {
         .contains("user-agent", "custom-user-Agent");
   }
 
+  @Test
+  void optOutExperimentalRuntimeMetrics() {
+    OpenTelemetryConfigurationModel model =
+        new OpenTelemetryConfigurationModel()
+            .withInstrumentationDevelopment(
+                new ExperimentalInstrumentationModel()
+                    .withJava(
+                        new ExperimentalLanguageSpecificInstrumentationModel()
+                            .withAdditionalProperty(
+                                "runtime_telemetry",
+                                new ExperimentalLanguageSpecificInstrumentationPropertyModel()
+                                    .withAdditionalProperty(
+                                        "emit_experimental_metrics/development", false))));
+
+    model = applyConfigCustomize(model, new ElasticDeclarativeConfigurationCustomizer());
+
+    assertThatJson(json(model.getInstrumentationDevelopment()))
+        .inPath("java.runtime_telemetry.emit_experimental_metrics/development")
+        .isBoolean()
+        .isFalse();
+  }
+
   @NotNull
   private static Map<String, String> userAgentHeader(String value) {
     Map<String, String> header = new HashMap<>();