Update configuration schema

Author: trask

agent/agent-bootstrap/src/main/java/com/microsoft/applicationinsights/agent/bootstrap/MainEntryPoint.java

@@ -26,6 +26,8 @@
 
 import com.microsoft.applicationinsights.agent.bootstrap.configuration.Configuration;
 import com.microsoft.applicationinsights.agent.bootstrap.configuration.ConfigurationBuilder;
+import com.microsoft.applicationinsights.agent.bootstrap.configuration.InstrumentationSettings;
+import com.microsoft.applicationinsights.agent.bootstrap.configuration.InstrumentationSettings.SelfDiagnostics;
 import com.microsoft.applicationinsights.agent.bootstrap.diagnostics.DiagnosticsHelper;
 import com.microsoft.applicationinsights.agent.bootstrap.diagnostics.status.StatusFile;
 import io.opentelemetry.auto.bootstrap.Agent;
@@ -37,12 +39,12 @@
 // this class has one purpose, start diagnostics before passing control to opentelemetry-auto-instr-java
 public class MainEntryPoint {
 
-    private static Configuration configuration;
+    private static InstrumentationSettings configuration;
 
     private MainEntryPoint() {
     }
 
-    public static Configuration getConfiguration() {
+    public static InstrumentationSettings getConfiguration() {
         return configuration;
     }
 
@@ -53,8 +55,8 @@ public static void start(Instrumentation instrumentation, URL bootstrapURL) {
             File agentJarFile = new File(bootstrapURL.toURI());
             DiagnosticsHelper.setAgentJarFile(agentJarFile);
             // configuration is only read this early in order to extract logging configuration
-            configuration = ConfigurationBuilder.create(agentJarFile.toPath());
-            startupLogger = configureLogging(configuration);
+            configuration = ConfigurationBuilder.create(agentJarFile.toPath()).instrumentationSettings;
+            startupLogger = configureLogging(configuration.preview.selfDiagnostics);
             ConfigurationBuilder.logConfigurationMessages();
             MDC.put("microsoft.ai.operationName", "Startup");
             Agent.start(instrumentation, bootstrapURL);
@@ -79,9 +81,9 @@ public static void start(Instrumentation instrumentation, URL bootstrapURL) {
         }
     }
 
-    private static Logger configureLogging(Configuration configuration) {
+    private static Logger configureLogging(SelfDiagnostics selfDiagnostics) {
         String logbackXml;
-        String destination = configuration.preview.selfDiagnostics.destination;
+        String destination = selfDiagnostics.destination;
         boolean logUnknownDestination = false;
         if (DiagnosticsHelper.isAppServiceCodeless()) {
             logbackXml = "applicationinsights.appsvc.logback.xml";
@@ -100,9 +102,9 @@ private static Logger configureLogging(Configuration configuration) {
         final URL configurationFile = cl.getResource(logbackXml);
         System.setProperty("applicationinsights.logback.configurationFile", configurationFile.toString());
 
-        String logbackDirectory = configuration.preview.selfDiagnostics.directory;
-        String logbackLevel = configuration.preview.selfDiagnostics.level;
-        int logbackMaxFileSizeMB = configuration.preview.selfDiagnostics.maxSizeMB;
+        String logbackDirectory = selfDiagnostics.directory;
+        String logbackLevel = selfDiagnostics.level;
+        int logbackMaxFileSizeMB = selfDiagnostics.maxSizeMB;
 
         if (logbackDirectory == null) {
             logbackDirectory = System.getProperty("java.io.tmpdir");

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

@@ -21,72 +21,7 @@
 
 package com.microsoft.applicationinsights.agent.bootstrap.configuration;
 
-import java.util.Collections;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.TimeUnit;
-
 public class Configuration {
 
-    public String connectionString;
-    public String instrumentationKey;
-    public PreviewConfiguration preview = new PreviewConfiguration();
-
-    public static class PreviewConfiguration {
-
-        public String roleName;
-        public String roleInstance;
-        public SelfDiagnostics selfDiagnostics = new SelfDiagnostics();
-        public Sampling sampling = new Sampling();
-        public Heartbeat heartbeat = new Heartbeat();
-        public HttpProxy httpProxy = new HttpProxy();
-        public LiveMetrics liveMetrics = new LiveMetrics();
-        public boolean developerMode;
-
-        public List<JmxMetric> jmxMetrics = Collections.emptyList();
-
-        public Map<String, Map<String, Object>> instrumentation = Collections.emptyMap();
-    }
-
-    public static class SelfDiagnostics {
-
-        public String destination;
-        public String directory;
-        public String level = "error";
-        public int maxSizeMB = 10;
-    }
-
-    public static class Sampling {
-
-        public FixedRateSampling fixedRate;
-    }
-
-    public static class FixedRateSampling {
-
-        public Double percentage;
-    }
-
-    public static class Heartbeat {
-
-        public boolean enabled = true;
-        public long intervalSeconds = TimeUnit.MINUTES.toSeconds(15);
-    }
-
-    public static class HttpProxy {
-
-        public String host;
-        public int port = 80;
-    }
-
-    public static class LiveMetrics {
-
-        public boolean enabled = true;
-    }
-
-    public static class JmxMetric {
-
-        public String objectName;
-        public String attribute;
-        public String display;
-    }
+    public InstrumentationSettings instrumentationSettings = new InstrumentationSettings();
 }

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

@@ -31,6 +31,7 @@
 import java.util.Map;
 import java.util.concurrent.CopyOnWriteArrayList;
 
+import com.microsoft.applicationinsights.agent.bootstrap.configuration.InstrumentationSettings.PreviewConfiguration;
 import com.microsoft.applicationinsights.agent.bootstrap.diagnostics.DiagnosticsHelper;
 import com.squareup.moshi.JsonAdapter;
 import com.squareup.moshi.Moshi;
@@ -55,10 +56,11 @@ public class ConfigurationBuilder {
     public static Configuration create(Path agentJarPath) throws IOException {
 
         Configuration config = loadConfigurationFile(agentJarPath);
+        PreviewConfiguration preview = config.instrumentationSettings.preview;
 
-        config.preview.roleName = overlayWithEnvVar(APPLICATIONINSIGHTS_ROLE_NAME, WEBSITE_SITE_NAME, config.preview.roleName);
-        config.preview.roleInstance =
-                overlayWithEnvVar(APPLICATIONINSIGHTS_ROLE_INSTANCE, WEBSITE_INSTANCE_ID, config.preview.roleInstance);
+        preview.roleName = overlayWithEnvVar(APPLICATIONINSIGHTS_ROLE_NAME, WEBSITE_SITE_NAME, preview.roleName);
+        preview.roleInstance =
+                overlayWithEnvVar(APPLICATIONINSIGHTS_ROLE_INSTANCE, WEBSITE_INSTANCE_ID, preview.roleInstance);
 
         return config;
     }

agent/agent-bootstrap/src/main/java/com/microsoft/applicationinsights/agent/bootstrap/configuration/InstrumentationSettings.java

@@ -0,0 +1,92 @@
+/*
+ * ApplicationInsights-Java
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the ""Software""), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package com.microsoft.applicationinsights.agent.bootstrap.configuration;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+public class InstrumentationSettings {
+
+    public String connectionString;
+    public String instrumentationKey;
+    public PreviewConfiguration preview = new PreviewConfiguration();
+
+    public static class PreviewConfiguration {
+
+        public String roleName;
+        public String roleInstance;
+        public SelfDiagnostics selfDiagnostics = new SelfDiagnostics();
+        public Sampling sampling = new Sampling();
+        public Heartbeat heartbeat = new Heartbeat();
+        public HttpProxy httpProxy = new HttpProxy();
+        public LiveMetrics liveMetrics = new LiveMetrics();
+        public boolean developerMode;
+
+        public List<JmxMetric> jmxMetrics = Collections.emptyList();
+
+        public Map<String, Map<String, Object>> instrumentation = Collections.emptyMap();
+    }
+
+    public static class SelfDiagnostics {
+
+        public String destination;
+        public String directory;
+        public String level = "error";
+        public int maxSizeMB = 10;
+    }
+
+    public static class Sampling {
+
+        public FixedRateSampling fixedRate;
+    }
+
+    public static class FixedRateSampling {
+
+        public Double percentage;
+    }
+
+    public static class Heartbeat {
+
+        public boolean enabled = true;
+        public long intervalSeconds = TimeUnit.MINUTES.toSeconds(15);
+    }
+
+    public static class HttpProxy {
+
+        public String host;
+        public int port = 80;
+    }
+
+    public static class LiveMetrics {
+
+        public boolean enabled = true;
+    }
+
+    public static class JmxMetric {
+
+        public String objectName;
+        public String attribute;
+        public String display;
+    }
+}

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

@@ -7,6 +7,7 @@
 import com.google.common.collect.ImmutableMap;
 import com.google.common.io.CharSource;
 import com.google.common.io.Resources;
+import com.microsoft.applicationinsights.agent.bootstrap.configuration.InstrumentationSettings.PreviewConfiguration;
 import com.squareup.moshi.JsonAdapter;
 import com.squareup.moshi.Moshi;
 import org.junit.*;
@@ -23,19 +24,22 @@ public void shouldParse() throws IOException {
         JsonAdapter<Configuration> jsonAdapter = moshi.adapter(Configuration.class);
         Configuration configuration = jsonAdapter.fromJson(json.read());
 
-        assertEquals("InstrumentationKey=00000000-0000-0000-0000-000000000000", configuration.connectionString);
-        assertEquals("Something Good", configuration.preview.roleName);
-        assertEquals("xyz123", configuration.preview.roleInstance);
-        assertEquals((Double) 10.0, configuration.preview.sampling.fixedRate.percentage);
-        assertEquals(false, configuration.preview.liveMetrics.enabled);
-        assertEquals(3, configuration.preview.jmxMetrics.size());
-        assertEquals("java.lang:type=Threading", configuration.preview.jmxMetrics.get(0).objectName);
-        assertEquals("ThreadCount", configuration.preview.jmxMetrics.get(0).attribute);
-        assertEquals("Thread Count", configuration.preview.jmxMetrics.get(0).display);
+        InstrumentationSettings instrumentationSettings = configuration.instrumentationSettings;
+        PreviewConfiguration preview = instrumentationSettings.preview;
+
+        assertEquals("InstrumentationKey=00000000-0000-0000-0000-000000000000", instrumentationSettings.connectionString);
+        assertEquals("Something Good", preview.roleName);
+        assertEquals("xyz123", preview.roleInstance);
+        assertEquals((Double) 10.0, preview.sampling.fixedRate.percentage);
+        assertEquals(false, preview.liveMetrics.enabled);
+        assertEquals(3, preview.jmxMetrics.size());
+        assertEquals("java.lang:type=Threading", preview.jmxMetrics.get(0).objectName);
+        assertEquals("ThreadCount", preview.jmxMetrics.get(0).attribute);
+        assertEquals("Thread Count", preview.jmxMetrics.get(0).display);
         assertEquals(ImmutableMap.of("__comment",
                 Arrays.asList("this sets the explain plan threshold ...", "this is a multi-line comment"),
-                "explainPlanThresholdInMS", 20000.0), configuration.preview.instrumentation.get("jdbc"));
-        assertEquals(ImmutableMap.of("enabled", false), configuration.preview.instrumentation.get("logging"));
+                "explainPlanThresholdInMS", 20000.0), preview.instrumentation.get("jdbc"));
+        assertEquals(ImmutableMap.of("enabled", false), preview.instrumentation.get("logging"));
     }
 
     @Test
@@ -45,11 +49,14 @@ public void shouldUseDefaults() throws IOException {
         JsonAdapter<Configuration> jsonAdapter = moshi.adapter(Configuration.class);
         Configuration configuration = jsonAdapter.fromJson("{}");
 
-        assertEquals(null, configuration.connectionString);
-        assertEquals(null, configuration.preview.roleName);
-        assertEquals(null, configuration.preview.roleInstance);
-        assertEquals(true, configuration.preview.liveMetrics.enabled);
-        assertEquals(0, configuration.preview.jmxMetrics.size());
-        assertEquals(0, configuration.preview.instrumentation.size());
+        InstrumentationSettings instrumentationSettings = configuration.instrumentationSettings;
+        PreviewConfiguration preview = instrumentationSettings.preview;
+
+        assertEquals(null, instrumentationSettings.connectionString);
+        assertEquals(null, preview.roleName);
+        assertEquals(null, preview.roleInstance);
+        assertEquals(true, preview.liveMetrics.enabled);
+        assertEquals(0, preview.jmxMetrics.size());
+        assertEquals(0, preview.instrumentation.size());
     }
 }