Add micrometer auto-instrumentation

Author: trask

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

@@ -23,6 +23,9 @@
 import java.net.URI;
 import java.util.Map;
 
+import io.opentelemetry.auto.bootstrap.instrumentation.aisdk.MicrometerUtil;
+import io.opentelemetry.auto.bootstrap.instrumentation.aisdk.MicrometerUtil.MicrometerUtilDelegate;
+
 import static java.util.concurrent.TimeUnit.DAYS;
 import static java.util.concurrent.TimeUnit.HOURS;
 import static java.util.concurrent.TimeUnit.MINUTES;
@@ -33,9 +36,15 @@ public class BytecodeUtil {
 
     private static BytecodeUtilDelegate delegate;
 
-    public static void setDelegate(BytecodeUtilDelegate delegate) {
+    public static void setDelegate(final BytecodeUtilDelegate delegate) {
         if (BytecodeUtil.delegate == null) {
             BytecodeUtil.delegate = delegate;
+            MicrometerUtil.setDelegate(new MicrometerUtilDelegate() {
+                @Override
+                public void trackMetric(String name, double value, Integer count, Double min, Double max, Map<String, String> properties) {
+                    delegate.trackMetric(name, value, count, min, max, null, properties);
+                }
+            });
         }
     }
 

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

@@ -32,12 +32,14 @@
 import com.google.common.base.Strings;
 import com.microsoft.applicationinsights.TelemetryClient;
 import com.microsoft.applicationinsights.TelemetryConfiguration;
+import com.microsoft.applicationinsights.agent.bootstrap.BytecodeUtil;
 import com.microsoft.applicationinsights.agent.bootstrap.MainEntryPoint;
 import com.microsoft.applicationinsights.agent.bootstrap.configuration.ConfigurationBuilder.ConfigurationException;
 import com.microsoft.applicationinsights.agent.bootstrap.configuration.InstrumentationSettings;
 import com.microsoft.applicationinsights.agent.bootstrap.configuration.InstrumentationSettings.FixedRateSampling;
 import com.microsoft.applicationinsights.agent.bootstrap.configuration.InstrumentationSettings.JmxMetric;
 import com.microsoft.applicationinsights.agent.bootstrap.diagnostics.DiagnosticsHelper;
+import com.microsoft.applicationinsights.agent.internal.instrumentation.sdk.BytecodeUtilImpl;
 import com.microsoft.applicationinsights.agent.internal.instrumentation.sdk.DependencyTelemetryClassFileTransformer;
 import com.microsoft.applicationinsights.agent.internal.instrumentation.sdk.HeartBeatModuleClassFileTransformer;
 import com.microsoft.applicationinsights.agent.internal.instrumentation.sdk.PerformanceCounterModuleClassFileTransformer;
@@ -103,6 +105,7 @@ private static void start(Instrumentation instrumentation, File agentJarFile) th
         Properties properties = new Properties();
         properties.put("additional.bootstrap.package.prefixes", "com.microsoft.applicationinsights.agent.bootstrap");
         properties.put("experimental.log.capture.threshold", getThreshold(config, "WARN"));
+        properties.put("micrometer.step.millis", Integer.toString(getReportingIntervalMillis(config, 60000)));
         properties.put("experimental.controller-and-view.spans.enabled", "false");
         properties.put("http.server.error.statuses", "400-599");
         ConfigOverride.set(properties);
@@ -143,6 +146,8 @@ private static void start(Instrumentation instrumentation, File agentJarFile) th
         TelemetryClient telemetryClient = new TelemetryClient();
         Global.setTelemetryClient(telemetryClient);
         AiAppId.setSupplier(new AppIdSupplier());
+        // this is currently used by Micrometer instrumentation in addition to 2.x SDK
+        BytecodeUtil.setDelegate(new BytecodeUtilImpl());
     }
 
     @Nullable
@@ -195,6 +200,22 @@ private static String getThreshold(InstrumentationSettings config, String defaul
         return threshold;
     }
 
+    private static int getReportingIntervalMillis(InstrumentationSettings config, int defaultValue) {
+        Map<String, Object> micrometer = config.preview.instrumentation.get("micrometer");
+        if (micrometer == null) {
+            return defaultValue;
+        }
+        Object reportingIntervalMillisObj = micrometer.get("reportingIntervalMillis");
+        if (reportingIntervalMillisObj == null) {
+            return defaultValue;
+        }
+        if (!(reportingIntervalMillisObj instanceof Number)) {
+            startupLogger.warn("micrometer reportingIntervalMillis must be a number, but found: {}", reportingIntervalMillisObj.getClass());
+            return defaultValue;
+        }
+        return ((Number) reportingIntervalMillisObj).intValue();
+    }
+
     private static ApplicationInsightsXmlConfiguration buildXmlConfiguration(InstrumentationSettings config) {
 
         ApplicationInsightsXmlConfiguration xmlConfiguration = new ApplicationInsightsXmlConfiguration();

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/instrumentation/sdk/TelemetryClientClassFileTransformer.java

@@ -86,8 +86,6 @@ public class TelemetryClientClassFileTransformer implements ClassFileTransformer
         }
         // FIXME why isn't this being called for internal TelemetryClient (which is good, but why)?
 
-        BytecodeUtil.setDelegate(new BytecodeUtilImpl());
-
         StatusFile.putValueAndWrite("SDKPresent", true);
         try {
             ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);

agent/instrumentation/build.gradle

@@ -36,6 +36,7 @@ dependencies {
     compile group: 'io.opentelemetry.auto.instrumentation', name: 'instrumentation-log4j-1.1', version: instrumentationVersion
     compile group: 'io.opentelemetry.auto.instrumentation', name: 'instrumentation-log4j-2.0', version: instrumentationVersion
     compile group: 'io.opentelemetry.auto.instrumentation', name: 'instrumentation-logback-1.0', version: instrumentationVersion
+    compile group: 'io.opentelemetry.auto.instrumentation', name: 'instrumentation-micrometer-1.0', version: instrumentationVersion
     compile group: 'io.opentelemetry.auto.instrumentation', name: 'instrumentation-mongo-3.1', version: instrumentationVersion
     compile group: 'io.opentelemetry.auto.instrumentation', name: 'instrumentation-mongo-3.7', version: instrumentationVersion
     compile group: 'io.opentelemetry.auto.instrumentation', name: 'instrumentation-mongo-async-3.3', version: instrumentationVersion

settings.gradle

@@ -80,6 +80,7 @@ include ':test:smoke:testApps:Netty'
 include ':test:smoke:testApps:JMS'
 include ':test:smoke:testApps:Kafka'
 include ':test:smoke:testApps:SpringCloudStream'
+include ':test:smoke:testApps:Micrometer'
 include ':test:smoke:testApps:VerifyShading'
 include ':test:smoke:testApps:VerifyJava7'
 

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

@@ -0,0 +1,12 @@
+{
+  "instrumentationSettings": {
+    "connectionString": "InstrumentationKey=00000000-0000-0000-0000-0FEEDDADBEEF;IngestionEndpoint=http://fakeingestion:60606/",
+    "preview": {
+      "instrumentation": {
+        "micrometer": {
+          "reportingIntervalMillis": 5000
+        }
+      }
+    }
+  }
+}

test/smoke/testApps/Micrometer/build.gradle

@@ -0,0 +1,19 @@
+plugins {
+    id 'java'
+    id 'org.springframework.boot' version '2.1.7.RELEASE'
+}
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+compileSmokeTestJava.sourceCompatibility = 1.8
+compileSmokeTestJava.targetCompatibility = 1.8
+
+ext.testAppArtifactDir = jar.destinationDirectory
+ext.testAppArtifactFilename = jar.archiveFileName.get()
+
+dependencies {
+    compileOnly aiAgentJar // this is just to force building the agent first
+
+    compile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '2.1.7.RELEASE'
+    compile group: 'io.micrometer', name: 'micrometer-core', version: '1.4.1'
+}

test/smoke/testApps/Micrometer/src/main/java/com/microsoft/ajl/simple/SpringBootApp.java

@@ -0,0 +1,13 @@
+package com.microsoft.ajl.simple;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class SpringBootApp {
+
+    public static void main(String[] args) {
+
+        SpringApplication.run(SpringBootApp.class, args);
+    }
+}

test/smoke/testApps/Micrometer/src/main/java/com/microsoft/ajl/simple/TestController.java

@@ -0,0 +1,23 @@
+package com.microsoft.ajl.simple;
+
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.Metrics;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class TestController {
+
+    private final Counter counter = Metrics.counter("test_counter");
+
+    @GetMapping("/")
+    public String root() {
+        return "OK";
+    }
+
+    @GetMapping("/test")
+    public String test() {
+        counter.increment();
+        return "OK!";
+    }
+}

test/smoke/testApps/Micrometer/src/main/resources/application.properties

@@ -0,0 +1 @@
+management.metrics.export.azuremonitor.instrumentation-key=00000000-0000-0000-0000-000000000000