Add support for live metrics (Azure#44653)

Author: jeanbisutti

eng/versioning/external_dependencies.txt

@@ -129,7 +129,7 @@ io.opentelemetry:opentelemetry-bom;1.48.0
 io.opentelemetry.instrumentation:opentelemetry-runtime-telemetry-java8;2.14.0-alpha
 io.opentelemetry.instrumentation:opentelemetry-spring-boot-starter;2.14.0
 io.opentelemetry.instrumentation:opentelemetry-logback-appender-1.0;2.14.0-alpha
-io.opentelemetry.semconv:opentelemetry-semconv-incubating;1.26.0-alpha
+io.opentelemetry:opentelemetry-semconv;0.14.1
 io.projectreactor:reactor-test;3.4.41
 io.github.hakky54:logcaptor;2.9.3
 com.squareup.okio:okio;3.9.1

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/README.md

@@ -141,14 +141,19 @@ For more information on the OpenTelemetry project, please review the [OpenTeleme
 
 ### Enabling Logging
 
-You can leverage [Azure SDK logging](logging].
+You can leverage [Azure SDK logging][logging].
 
 Examples:
 * [Log4j][log4j]
 * [Logback][logback]
 
 Learn more about [OpenTelemetry SDK logging][logging_otel_sdk].
 
+### Disable live metrics
+
+You can disable the [live metrics][live_metrics] by setting the `APPLICATIONINSIGHTS_LIVE_METRICS_ENABLED` environment variable to false, the `applicationinsights.live.metrics.enabled` Java system property to false,
+or programmatically with a properties supplier: `sdkBuilder.addPropertiesSupplier(() -> Collections.singletonMap("applicationinsights.live.metrics.enabled", "false"))`.
+
 ## Next steps
 Learn more about [OpenTelemetry][opentelemetry_io]
 
@@ -182,6 +187,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
 [log4j]: https://github.com/Azure-Samples/ApplicationInsights-Java-Samples/blob/9a7344eeb44525dfc83df3a1bd59460b8a7d93c6/opentelemetry-api/exporter/TrackTrace/Log4j2/src/main/resources/log4j2.xml#L16
 [logback]: https://github.com/Azure-Samples/ApplicationInsights-Java-Samples/blob/9a7344eeb44525dfc83df3a1bd59460b8a7d93c6/opentelemetry-api/exporter/TrackTrace/Logback/src/main/resources/logback.xml#L22
 [logging_otel_sdk]: https://opentelemetry.io/docs/languages/java/sdk/#internal-logging
+[live_metrics]: https://learn.microsoft.com/azure/azure-monitor/app/live-stream
 [opentelemetry_specification]: https://github.com/open-telemetry/opentelemetry-specification
 [application_insights_resource]: https://learn.microsoft.com/azure/azure-monitor/app/create-new-resource
 [application_insights_intro]: https://learn.microsoft.com/azure/azure-monitor/app/app-insights-overview

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/checkstyle-suppressions.xml

@@ -70,6 +70,7 @@
   <suppress files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorAutoConfigure.java" checks="IllegalImportCheck" />
   <suppress files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorAutoConfigureTest.java" checks="IllegalImportCheck" />
   <suppress files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorExporterBuilder.java" checks="IllegalImportCheck" />
+  <suppress files="com.azure.monitor.opentelemetry.autoconfigure.LiveMetrics.java" checks="IllegalImportCheck" />
   <suppress files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorExportersEndToEndTest.java" checks="IllegalImportCheck" />
   <suppress files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorLogRecordExporter.java" checks="IllegalImportCheck" />
   <suppress files="com.azure.monitor.opentelemetry.autoconfigure.AzureMonitorMetricExporter.java" checks="IllegalImportCheck" />

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/pom.xml

@@ -92,9 +92,9 @@
       <version>1.48.0</version> <!-- {x-version-update;io.opentelemetry:opentelemetry-sdk-extension-autoconfigure;external_dependency} -->
     </dependency>
     <dependency>
-      <groupId>io.opentelemetry.semconv</groupId>
-      <artifactId>opentelemetry-semconv-incubating</artifactId>
-      <version>1.26.0-alpha</version> <!-- {x-version-update;io.opentelemetry.semconv:opentelemetry-semconv-incubating;external_dependency} -->
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-semconv</artifactId>
+      <version>0.14.1</version> <!-- {x-version-update;io.opentelemetry:opentelemetry-semconv;external_dependency} -->
     </dependency>
 
     <!-- Added this dependency to include necessary annotations used by reactor core.
@@ -194,13 +194,13 @@
           <rules>
             <bannedDependencies>
               <includes>
+                <include>io.opentelemetry:opentelemetry-semconv:[0.14.1]</include> <!-- {x-include-update;io.opentelemetry:opentelemetry-semconv;external_dependency} -->
                 <include>io.opentelemetry:opentelemetry-api:[1.48.0]</include> <!-- {x-include-update;io.opentelemetry:opentelemetry-api;external_dependency} -->
                 <include>io.opentelemetry:opentelemetry-sdk:[1.48.0]</include> <!-- {x-include-update;io.opentelemetry:opentelemetry-sdk;external_dependency} -->
                 <include>io.opentelemetry:opentelemetry-sdk-metrics:[1.48.0]</include> <!-- {x-include-update;io.opentelemetry:opentelemetry-sdk-metrics;external_dependency} -->
                 <include>io.opentelemetry:opentelemetry-sdk-logs:[1.48.0]</include> <!-- {x-include-update;io.opentelemetry:opentelemetry-sdk-logs;external_dependency} -->
                 <include>io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi:[1.48.0]</include> <!-- {x-include-update;io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi;external_dependency} -->
                 <include>io.opentelemetry:opentelemetry-sdk-extension-autoconfigure:[1.48.0]</include> <!-- {x-include-update;io.opentelemetry:opentelemetry-sdk-extension-autoconfigure;external_dependency} -->
-                <include>io.opentelemetry.semconv:opentelemetry-semconv-incubating:[1.26.0-alpha]</include> <!-- {x-include-update;io.opentelemetry.semconv:opentelemetry-semconv-incubating;external_dependency} -->
                 <include>com.squareup.okio:okio:[3.9.1]</include> <!-- {x-include-update;com.squareup.okio:okio;external_dependency} -->
               </includes>
             </bannedDependencies>

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/AzureMonitorAutoConfigure.java

@@ -3,17 +3,19 @@
 
 package com.azure.monitor.opentelemetry.autoconfigure;
 
+import com.azure.monitor.opentelemetry.autoconfigure.implementation.AzureMonitorExporterProviderKeys;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.AzureMonitorLogRecordExporterProvider;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.AzureMonitorMetricExporterProvider;
-import com.azure.monitor.opentelemetry.autoconfigure.implementation.AzureMonitorExporterProviderKeys;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.AzureMonitorSpanExporterProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
 import io.opentelemetry.sdk.metrics.Aggregation;
 import io.opentelemetry.sdk.metrics.InstrumentSelector;
 import io.opentelemetry.sdk.metrics.View;
+import io.opentelemetry.sdk.resources.Resource;
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.atomic.AtomicReference;
 
 /**
  * Class to enable Azure Monitor for OpenTelemetry autoconfiguration.
@@ -59,33 +61,40 @@ public static void customize(AutoConfigurationCustomizer autoConfigurationCustom
             props.put(AzureMonitorExporterProviderKeys.INTERNAL_USING_AZURE_MONITOR_EXPORTER_BUILDER, "true");
             return props;
         });
+        final AtomicReference<Resource> otelResource = new AtomicReference<>();
+        autoConfigurationCustomizer.addResourceCustomizer((resource, configProperties) -> {
+            otelResource.set(resource);
+            return resource;
+        });
         AzureMonitorExporterBuilder azureMonitorExporterBuilder = new AzureMonitorExporterBuilder();
         autoConfigurationCustomizer.addSpanExporterCustomizer((spanExporter, configProperties) -> {
             if (spanExporter instanceof AzureMonitorSpanExporterProvider.MarkerSpanExporter) {
-                azureMonitorExporterBuilder.initializeIfNot(autoConfigureOptions, configProperties);
+                azureMonitorExporterBuilder.initializeIfNot(autoConfigureOptions, configProperties, otelResource.get());
                 spanExporter = azureMonitorExporterBuilder.buildSpanExporter();
             }
             return spanExporter;
         });
         autoConfigurationCustomizer.addMetricExporterCustomizer((metricExporter, configProperties) -> {
             if (metricExporter instanceof AzureMonitorMetricExporterProvider.MarkerMetricExporter) {
-                azureMonitorExporterBuilder.initializeIfNot(autoConfigureOptions, configProperties);
+                azureMonitorExporterBuilder.initializeIfNot(autoConfigureOptions, configProperties, otelResource.get());
                 metricExporter = azureMonitorExporterBuilder.buildMetricExporter();
             }
             return metricExporter;
         });
         autoConfigurationCustomizer.addLogRecordExporterCustomizer((logRecordExporter, configProperties) -> {
             if (logRecordExporter instanceof AzureMonitorLogRecordExporterProvider.MarkerLogRecordExporter) {
-                azureMonitorExporterBuilder.initializeIfNot(autoConfigureOptions, configProperties);
+                azureMonitorExporterBuilder.initializeIfNot(autoConfigureOptions, configProperties, otelResource.get());
                 logRecordExporter = azureMonitorExporterBuilder.buildLogRecordExporter();
             }
             return logRecordExporter;
         });
-        // TODO (trask)
-        //        sdkBuilder.addTracerProviderCustomizer((sdkTracerProviderBuilder, configProperties) -> {
-        //            QuickPulse quickPulse = QuickPulse.create(getHttpPipeline());
-        //            return sdkTracerProviderBuilder.addSpanProcessor(
-        //                ne
+        autoConfigurationCustomizer.addTracerProviderCustomizer((sdkTracerProviderBuilder, configProperties) -> {
+            azureMonitorExporterBuilder.initializeIfNot(autoConfigureOptions, configProperties, otelResource.get());
+            if (LiveMetrics.isEnabled(configProperties)) {
+                sdkTracerProviderBuilder.addSpanProcessor(azureMonitorExporterBuilder.buildLiveMetricsSpanProcesor());
+            }
+            return sdkTracerProviderBuilder;
+        });
         autoConfigurationCustomizer
             .addMeterProviderCustomizer((sdkMeterProviderBuilder, config) -> sdkMeterProviderBuilder
                 .registerView(InstrumentSelector.builder().setMeterName("io.opentelemetry.sdk.trace").build(),

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/AzureMonitorExporterBuilder.java

@@ -13,28 +13,32 @@
 import com.azure.core.util.Configuration;
 import com.azure.core.util.CoreUtils;
 import com.azure.core.util.logging.ClientLogger;
-import com.azure.monitor.opentelemetry.autoconfigure.implementation.configuration.ConnectionString;
-import com.azure.monitor.opentelemetry.autoconfigure.implementation.localstorage.LocalStorageStats;
+import com.azure.monitor.opentelemetry.autoconfigure.implementation.LiveMetricsSpanProcessor;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.LogDataMapper;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.MetricDataMapper;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.NoopTracer;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.SpanDataMapper;
+import com.azure.monitor.opentelemetry.autoconfigure.implementation.configuration.ConnectionString;
+import com.azure.monitor.opentelemetry.autoconfigure.implementation.localstorage.LocalStorageStats;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.builders.AbstractTelemetryBuilder;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.configuration.StatsbeatConnectionString;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.heartbeat.HeartbeatExporter;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.models.ContextTagKeys;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.pipeline.TelemetryItemExporter;
+import com.azure.monitor.opentelemetry.autoconfigure.implementation.quickpulse.QuickPulse;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.statsbeat.Feature;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.statsbeat.StatsbeatModule;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.utils.AzureMonitorHelper;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.utils.PropertyHelper;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.utils.ResourceParser;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.utils.TempDirs;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.utils.VersionGenerator;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import io.opentelemetry.sdk.logs.export.LogRecordExporter;
 import io.opentelemetry.sdk.metrics.export.MetricExporter;
 import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.trace.SpanProcessor;
 import io.opentelemetry.sdk.trace.export.SpanExporter;
 
 import java.io.File;
@@ -68,32 +72,51 @@ class AzureMonitorExporterBuilder {
 
     private ConfigProperties configProperties;
 
+    private HttpPipeline httpPipeline;
+
+    private QuickPulse quickPulse;
+
+    private SpanDataMapper spanDataMapper;
+
     private boolean initialized;
 
-    void initializeIfNot(AzureMonitorAutoConfigureOptions exporterOptions, ConfigProperties configProperties) {
+    void initializeIfNot(AzureMonitorAutoConfigureOptions exporterOptions, ConfigProperties configProperties,
+        Resource resource) {
         if (initialized) {
             return;
         }
-        initialized = true;
+        this.initialized = true;
         this.exporterOptions = exporterOptions;
         this.configProperties = configProperties;
-        HttpPipeline httpPipeline = createHttpPipeline();
-        statsbeatModule = initStatsbeatModule(configProperties);
+        this.httpPipeline = createHttpPipeline();
+        this.statsbeatModule = initStatsbeatModule(configProperties);
+        this.spanDataMapper = createSpanDataMapper();
         File tempDir = TempDirs.getApplicationInsightsTempDir(LOGGER,
             "Telemetry will not be stored to disk and retried on sporadic network failures");
         // TODO (heya) change LocalStorageStats.noop() to statsbeatModule.getNonessentialStatsbeat() when we decide to collect non-essential Statsbeat by default.
-        builtTelemetryItemExporter = AzureMonitorHelper.createTelemetryItemExporter(httpPipeline, statsbeatModule,
+        this.builtTelemetryItemExporter = AzureMonitorHelper.createTelemetryItemExporter(httpPipeline, statsbeatModule,
             tempDir, LocalStorageStats.noop());
+        if (LiveMetrics.isEnabled(configProperties)) {
+            this.quickPulse = createQuickPulse(resource);
+        }
         startStatsbeatModule(statsbeatModule, configProperties, tempDir); // wait till TelemetryItemExporter has been initialized before starting StatsbeatModule
     }
 
+    private QuickPulse createQuickPulse(Resource resource) {
+        String roleName = resource.getAttribute(AttributeKey.stringKey("service.name"));
+        String roleInstance = resource.getAttribute(AttributeKey.stringKey("service.instance.id"));
+        ConnectionString connectionString = getConnectionString();
+        return QuickPulse.create(httpPipeline, () -> connectionString.getLiveEndpoint(),
+            () -> connectionString.getInstrumentationKey(), roleName, roleInstance, VersionGenerator.getSdkVersion());
+    }
+
     SpanExporter buildSpanExporter() {
-        return new AzureMonitorTraceExporter(createSpanDataMapper(), builtTelemetryItemExporter, statsbeatModule);
+        return new AzureMonitorTraceExporter(spanDataMapper, builtTelemetryItemExporter, statsbeatModule);
     }
 
     LogRecordExporter buildLogRecordExporter() {
         return new AzureMonitorLogRecordExporter(new LogDataMapper(true, false, createDefaultsPopulator()),
-            builtTelemetryItemExporter);
+            builtTelemetryItemExporter, quickPulse);
     }
 
     MetricExporter buildMetricExporter() {
@@ -102,6 +125,10 @@ MetricExporter buildMetricExporter() {
             builtTelemetryItemExporter);
     }
 
+    public SpanProcessor buildLiveMetricsSpanProcesor() {
+        return new LiveMetricsSpanProcessor(quickPulse, spanDataMapper);
+    }
+
     private Set<Feature> initStatsbeatFeatures() {
         if (System.getProperty("org.graalvm.nativeimage.imagecode") != null) {
             return Collections.singleton(Feature.GRAAL_VM_NATIVE);

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/AzureMonitorLogRecordExporter.java

@@ -9,6 +9,7 @@
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.logging.OperationLogger;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.models.TelemetryItem;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.pipeline.TelemetryItemExporter;
+import com.azure.monitor.opentelemetry.autoconfigure.implementation.quickpulse.QuickPulse;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.utils.AzureMonitorMsgId;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import io.opentelemetry.sdk.logs.data.LogRecordData;
@@ -33,14 +34,17 @@ class AzureMonitorLogRecordExporter implements LogRecordExporter {
     private final AtomicBoolean stopped = new AtomicBoolean();
     private final LogDataMapper mapper;
     private final TelemetryItemExporter telemetryItemExporter;
+    private final QuickPulse quickPulse;
 
     /**
      * Creates an instance of log exporter that is configured with given exporter client that sends
      * telemetry events to Application Insights resource identified by the instrumentation key.
      */
-    AzureMonitorLogRecordExporter(LogDataMapper mapper, TelemetryItemExporter telemetryItemExporter) {
+    AzureMonitorLogRecordExporter(LogDataMapper mapper, TelemetryItemExporter telemetryItemExporter,
+        QuickPulse quickPulse) {
         this.mapper = mapper;
         this.telemetryItemExporter = telemetryItemExporter;
+        this.quickPulse = quickPulse;
     }
 
     /**
@@ -61,7 +65,11 @@ public CompletableResultCode export(Collection<LogRecordData> logs) {
             LOGGER.verbose("exporting log: {}", log);
             try {
                 String stack = log.getAttributes().get(SemanticAttributes.EXCEPTION_STACKTRACE);
-                telemetryItems.add(mapper.map(log, stack, null));
+                TelemetryItem telemetryItem = mapper.map(log, stack, null);
+                telemetryItems.add(telemetryItem);
+                if (quickPulse != null && quickPulse.isEnabled()) {
+                    quickPulse.add(telemetryItem);
+                }
                 OPERATION_LOGGER.recordSuccess();
             } catch (Throwable t) {
                 OPERATION_LOGGER.recordFailure(t.getMessage(), t, AzureMonitorMsgId.EXPORTER_MAPPING_ERROR);

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/LiveMetrics.java

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.monitor.opentelemetry.autoconfigure;
+
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+
+class LiveMetrics {
+
+    static boolean isEnabled(ConfigProperties configProperties) {
+        return configProperties.getBoolean("applicationinsights.live.metrics.enabled", true);
+    }
+}

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/implementation/LiveMetricsSpanProcessor.java

@@ -30,7 +30,7 @@ public boolean isStartRequired() {
 
     @Override
     public void onEnd(ReadableSpan readableSpan) {
-        if (quickPulse.isEnabled()) {
+        if (quickPulse != null && quickPulse.isEnabled()) {
             // TODO (trask) can we do anything better here in terms of double conversion?
             quickPulse.add(mapper.map(readableSpan.toSpanData()));
         }