Update default configuration (#1888)

* Enable AzureSdk and OTel instrumentation by default

* Disable controller spans by default

Author: trask

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/configuration/Configuration.java

@@ -134,6 +134,7 @@ public static class JmxMetric {
 
   public static class Instrumentation {
 
+    public EnabledByDefaultInstrumentation azureSdk = new EnabledByDefaultInstrumentation();
     public EnabledByDefaultInstrumentation cassandra = new EnabledByDefaultInstrumentation();
     public EnabledByDefaultInstrumentation jdbc = new EnabledByDefaultInstrumentation();
     public EnabledByDefaultInstrumentation jms = new EnabledByDefaultInstrumentation();
@@ -184,7 +185,8 @@ public static class PreviewConfiguration {
 
     public SamplingPreview sampling = new SamplingPreview();
     public List<ProcessorConfig> processors = new ArrayList<>();
-    public boolean openTelemetryApiSupport;
+    // this is just here to detect if using this old setting in order to give a helpful message
+    @Deprecated public boolean openTelemetryApiSupport;
     public PreviewInstrumentation instrumentation = new PreviewInstrumentation();
     // applies to perf counters, default custom metrics, jmx metrics, and micrometer metrics
     // not sure if we'll be able to have different metric intervals in future OpenTelemetry metrics
@@ -194,7 +196,7 @@ public static class PreviewConfiguration {
     // ignoreRemoteParentNotSampled is currently needed
     // because .NET SDK always propagates trace flags "00" (not sampled)
     public boolean ignoreRemoteParentNotSampled = true;
-    public boolean captureControllerSpans = true;
+    public boolean captureControllerSpans;
     // this is just here to detect if using this old setting in order to give a helpful message
     @Deprecated public boolean httpMethodInOperationName;
     public LiveMetrics liveMetrics = new LiveMetrics();
@@ -264,6 +266,8 @@ public static class InternalConfiguration {
   }
 
   public static class PreviewInstrumentation {
+    // this is just here to detect if using this old setting in order to give a helpful message
+    @Deprecated
     public DisabledByDefaultInstrumentation azureSdk = new DisabledByDefaultInstrumentation();
 
     public DisabledByDefaultInstrumentation grizzly = new DisabledByDefaultInstrumentation();

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/configuration/ConfigurationBuilder.java

@@ -80,10 +80,6 @@ public class ConfigurationBuilder {
   public static final String APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_FILE_PATH =
       "APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_FILE_PATH";
 
-  private static final String APPLICATIONINSIGHTS_PREVIEW_OTEL_API_SUPPORT =
-      "APPLICATIONINSIGHTS_PREVIEW_OTEL_API_SUPPORT";
-  private static final String APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_AZURE_SDK_ENABLED =
-      "APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_AZURE_SDK_ENABLED";
   private static final String
       APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_SPRING_INTEGRATION_ENABLED =
           "APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_SPRING_INTEGRATION_ENABLED";
@@ -125,7 +121,19 @@ public static Configuration create(Path agentJarPath, RpConfiguration rpConfigur
     }
     if (config.preview.httpMethodInOperationName) {
       configurationLogger.warn(
-          "\"httpMethodInOperationName\" preview setting is now the (one and only) default behavior");
+          "\"httpMethodInOperationName\" is no longer in preview and it is now the"
+              + " (one and only) default behavior");
+    }
+    if (config.preview.openTelemetryApiSupport) {
+      configurationLogger.warn(
+          "\"openTelemetryApiSupport\" is no longer in preview and it is now the"
+              + " (one and only) default behavior");
+    }
+    if (config.preview.instrumentation.azureSdk.enabled) {
+      configurationLogger.warn(
+          "\"azureSdk\" instrumentation is no longer in preview"
+              + " and it is now enabled by default,"
+              + " so no need to enable it under preview configuration");
     }
     if (config.preview.instrumentation.javaHttpClient.enabled) {
       configurationLogger.warn(
@@ -145,6 +153,7 @@ public static Configuration create(Path agentJarPath, RpConfiguration rpConfigur
               + " and it is now enabled by default,"
               + " so no need to enable it under preview configuration");
     }
+
     overlayEnvVars(config);
     applySamplingPercentageRounding(config);
     // rp configuration should always be last (so it takes precedence)
@@ -249,6 +258,10 @@ private static boolean jmxMetricExists(
   }
 
   private static void overlayInstrumentationEnabledEnvVars(Configuration config) {
+    config.instrumentation.azureSdk.enabled =
+        overlayWithEnvVar(
+            "APPLICATIONINSIGHTS_INSTRUMENTATION_AZURE_SDK_ENABLED",
+            config.instrumentation.azureSdk.enabled);
     config.instrumentation.cassandra.enabled =
         overlayWithEnvVar(
             "APPLICATIONINSIGHTS_INSTRUMENTATION_CASSANDRA_ENABLED",
@@ -383,13 +396,6 @@ static void overlayEnvVars(Configuration config) throws IOException {
                 APPLICATIONINSIGHTS_PREVIEW_METRIC_INTERVAL_SECONDS,
                 config.preview.metricIntervalSeconds);
 
-    config.preview.openTelemetryApiSupport =
-        overlayWithEnvVar(
-            APPLICATIONINSIGHTS_PREVIEW_OTEL_API_SUPPORT, config.preview.openTelemetryApiSupport);
-    config.preview.instrumentation.azureSdk.enabled =
-        overlayWithEnvVar(
-            APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_AZURE_SDK_ENABLED,
-            config.preview.instrumentation.azureSdk.enabled);
     config.preview.instrumentation.springIntegration.enabled =
         overlayWithEnvVar(
             APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_SPRING_INTEGRATION_ENABLED,

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/init/ConfigOverride.java

@@ -42,6 +42,9 @@ static Config getConfig(Configuration config) {
       properties.put("otel.instrumentation.micrometer.enabled", "false");
       properties.put("otel.instrumentation.actuator-metrics.enabled", "false");
     }
+    if (!config.instrumentation.azureSdk.enabled) {
+      properties.put("otel.instrumentation.azure-core.enabled", "false");
+    }
     if (!config.instrumentation.cassandra.enabled) {
       properties.put("otel.instrumentation.cassandra.enabled", "false");
     }
@@ -68,17 +71,6 @@ static Config getConfig(Configuration config) {
     if (!config.instrumentation.springScheduling.enabled) {
       properties.put("otel.instrumentation.spring-scheduling.enabled", "false");
     }
-    if (!config.preview.openTelemetryApiSupport) {
-      properties.put("otel.instrumentation.opentelemetry-api.enabled", "false");
-      properties.put("otel.instrumentation.opentelemetry-api-metrics.enabled", "false");
-      // TODO (trask) this is old name, remove after updating to version that has
-      //  this: https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/3611
-      properties.put("otel.instrumentation.opentelemetry-metrics-api.enabled", "false");
-      properties.put("otel.instrumentation.opentelemetry-annotations.enabled", "false");
-    }
-    if (!config.preview.instrumentation.azureSdk.enabled) {
-      properties.put("otel.instrumentation.azure-core.enabled", "false");
-    }
     if (config.preview.instrumentation.grizzly.enabled) {
       // grizzly instrumentation is off by default
       // TODO (trask) investigate if grizzly instrumentation can be enabled upstream by default now

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/statsbeat/FeatureStatsbeat.java

@@ -97,6 +97,9 @@ void trackConfigurationOptions(Configuration config) {
     }
 
     // disabled instrumentations
+    if (!config.instrumentation.azureSdk.enabled) {
+      featureList.add(Feature.AZURE_SDK_DISABLED);
+    }
     if (!config.instrumentation.cassandra.enabled) {
       featureList.add(Feature.CASSANDRA_DISABLED);
     }
@@ -126,9 +129,6 @@ void trackConfigurationOptions(Configuration config) {
     }
 
     // preview instrumentation
-    if (!config.preview.instrumentation.azureSdk.enabled) {
-      featureList.add(Feature.AZURE_SDK_DISABLED);
-    }
     if (!config.preview.instrumentation.grizzly.enabled) {
       featureList.add(Feature.GRIZZLY_DISABLED);
     }

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/configuration/ConfigurationTest.java

@@ -481,43 +481,33 @@ void shouldOverrideSelfDiagnosticsFilePath() throws IOException {
   }
 
   @Test
-  void shouldOverridePreviewOtelApiSupport() throws IOException {
-    envVars.set("APPLICATIONINSIGHTS_PREVIEW_OTEL_API_SUPPORT", "true");
-
-    Configuration configuration = loadConfiguration();
-    ConfigurationBuilder.overlayEnvVars(configuration);
-
-    assertThat(configuration.preview.openTelemetryApiSupport).isTrue();
-  }
-
-  @Test
-  void shouldOverridePreviewAzureSdkInstrumentation() throws IOException {
-    envVars.set("APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_AZURE_SDK_ENABLED", "true");
+  void shouldOverridePreviewSpringIntegrationInstrumentation() throws IOException {
+    envVars.set("APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_SPRING_INTEGRATION_ENABLED", "true");
 
     Configuration configuration = loadConfiguration();
     ConfigurationBuilder.overlayEnvVars(configuration);
 
-    assertThat(configuration.preview.instrumentation.azureSdk.enabled).isTrue();
+    assertThat(configuration.preview.instrumentation.springIntegration.enabled).isTrue();
   }
 
   @Test
-  void shouldOverridePreviewSpringIntegrationInstrumentation() throws IOException {
-    envVars.set("APPLICATIONINSIGHTS_PREVIEW_INSTRUMENTATION_SPRING_INTEGRATION_ENABLED", "true");
+  void shouldOverridePreviewLiveMetricsEnabled() throws IOException {
+    envVars.set("APPLICATIONINSIGHTS_PREVIEW_LIVE_METRICS_ENABLED", "false");
 
     Configuration configuration = loadConfiguration();
     ConfigurationBuilder.overlayEnvVars(configuration);
 
-    assertThat(configuration.preview.instrumentation.springIntegration.enabled).isTrue();
+    assertThat(configuration.preview.liveMetrics.enabled).isFalse();
   }
 
   @Test
-  void shouldOverridePreviewLiveMetricsEnabled() throws IOException {
-    envVars.set("APPLICATIONINSIGHTS_PREVIEW_LIVE_METRICS_ENABLED", "false");
+  void shouldOverrideInstrumentationAzureSdkEnabled() throws IOException {
+    envVars.set("APPLICATIONINSIGHTS_INSTRUMENTATION_AZURE_SDK_ENABLED", "false");
 
     Configuration configuration = loadConfiguration();
     ConfigurationBuilder.overlayEnvVars(configuration);
 
-    assertThat(configuration.preview.liveMetrics.enabled).isFalse();
+    assertThat(configuration.instrumentation.azureSdk.enabled).isFalse();
   }
 
   @Test

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/statsbeat/FeatureStatsbeatTest.java

@@ -151,7 +151,6 @@ private static Configuration newConfiguration() {
     config.preview = new Configuration.PreviewConfiguration();
     config.preview.instrumentation = new Configuration.PreviewInstrumentation();
     // preview instrumentation is disabled by default
-    config.preview.instrumentation.azureSdk.enabled = true;
     config.preview.instrumentation.springIntegration.enabled = true;
     return config;
   }

test/smoke/appServers/global-resources/controller_spans_disabled_azuresdk_applicationinsights.json

@@ -5,6 +5,6 @@
     "instance": "testroleinstance"
   },
   "preview": {
-    "openTelemetryApiSupport": true
+    "captureControllerSpans": true
   }
 }