Set instrumentation version on emitted Meter scopes (#18866)

Author: trask

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbConnectionPoolMetrics.java

@@ -37,13 +37,24 @@ public final class DbConnectionPoolMetrics {
 
   public static DbConnectionPoolMetrics create(
       OpenTelemetry openTelemetry, String instrumentationName, String poolName) {
-
     MeterBuilder meterBuilder = openTelemetry.getMeterProvider().meterBuilder(instrumentationName);
     String version = EmbeddedInstrumentationProperties.findVersion(instrumentationName);
     if (version != null) {
       meterBuilder.setInstrumentationVersion(version);
     }
-    return new DbConnectionPoolMetrics(meterBuilder.build(), Attributes.of(POOL_NAME, poolName));
+    return create(meterBuilder.build(), poolName);
+  }
+
+  /**
+   * Like {@link #create(OpenTelemetry, String, String)}, but accepts a pre-built {@link Meter}.
+   *
+   * @deprecated Exists only so the {@code tomcat-jdbc-8.5} javaagent can emit the pre-rename {@code
+   *     io.opentelemetry.tomcat-jdbc} scope by default; to be removed in 3.0 once v3-preview
+   *     becomes the default.
+   */
+  @Deprecated
+  public static DbConnectionPoolMetrics create(Meter meter, String poolName) {
+    return new DbConnectionPoolMetrics(meter, Attributes.of(POOL_NAME, poolName));
   }
 
   private final Meter meter;

instrumentation/dropwizard/dropwizard-metrics-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/dropwizardmetrics/v4_0/DropwizardMetricsAdapter.java

@@ -19,7 +19,9 @@
 import io.opentelemetry.api.metrics.LongCounter;
 import io.opentelemetry.api.metrics.LongHistogram;
 import io.opentelemetry.api.metrics.LongUpDownCounter;
+import io.opentelemetry.api.metrics.MeterBuilder;
 import io.opentelemetry.api.metrics.ObservableDoubleGauge;
+import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
 import io.opentelemetry.instrumentation.api.util.VirtualField;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
@@ -57,7 +59,13 @@ public class DropwizardMetricsAdapter implements MetricRegistryListener {
   private final Map<String, Timer> dropwizardTimers = new ConcurrentHashMap<>();
 
   public DropwizardMetricsAdapter(OpenTelemetry openTelemetry) {
-    this.otelMeter = openTelemetry.getMeter("io.opentelemetry.dropwizard-metrics-4.0");
+    String instrumentationName = "io.opentelemetry.dropwizard-metrics-4.0";
+    MeterBuilder meterBuilder = openTelemetry.getMeterProvider().meterBuilder(instrumentationName);
+    String version = EmbeddedInstrumentationProperties.findVersion(instrumentationName);
+    if (version != null) {
+      meterBuilder.setInstrumentationVersion(version);
+    }
+    this.otelMeter = meterBuilder.build();
   }
 
   /**

instrumentation/failsafe-3.0/library/src/main/java/io/opentelemetry/instrumentation/failsafe/v3_0/FailsafeTelemetry.java

@@ -22,6 +22,8 @@
 import io.opentelemetry.api.metrics.LongCounter;
 import io.opentelemetry.api.metrics.LongHistogram;
 import io.opentelemetry.api.metrics.Meter;
+import io.opentelemetry.api.metrics.MeterBuilder;
+import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
 
 /** Entrypoint for instrumenting Failsafe components. */
 public final class FailsafeTelemetry {
@@ -53,7 +55,7 @@ private FailsafeTelemetry(OpenTelemetry openTelemetry) {
   public <R> CircuitBreaker<R> createCircuitBreaker(
       CircuitBreaker<R> delegate, String circuitBreakerName) {
     CircuitBreakerConfig<R> userConfig = delegate.getConfig();
-    Meter meter = openTelemetry.getMeter(INSTRUMENTATION_NAME);
+    Meter meter = getMeter();
     LongCounter executionCounter =
         meter
             .counterBuilder("failsafe.circuit_breaker.execution.count")
@@ -86,7 +88,7 @@ public <R> CircuitBreaker<R> createCircuitBreaker(
    */
   public <R> RetryPolicy<R> createRetryPolicy(RetryPolicy<R> delegate, String retryPolicyName) {
     RetryPolicyConfig<R> userConfig = delegate.getConfig();
-    Meter meter = openTelemetry.getMeter(INSTRUMENTATION_NAME);
+    Meter meter = getMeter();
     LongCounter executionCounter =
         meter
             .counterBuilder("failsafe.retry_policy.execution.count")
@@ -113,4 +115,13 @@ public <R> RetryPolicy<R> createRetryPolicy(RetryPolicy<R> delegate, String retr
                 userConfig, executionCounter, attemptsHistogram, attributes))
         .build();
   }
+
+  private Meter getMeter() {
+    MeterBuilder meterBuilder = openTelemetry.getMeterProvider().meterBuilder(INSTRUMENTATION_NAME);
+    String version = EmbeddedInstrumentationProperties.findVersion(INSTRUMENTATION_NAME);
+    if (version != null) {
+      meterBuilder.setInstrumentationVersion(version);
+    }
+    return meterBuilder.build();
+  }
 }

instrumentation/iceberg-1.8/library/src/main/java/io/opentelemetry/instrumentation/iceberg/v1_8/IcebergMetricsReporter.java

@@ -15,6 +15,8 @@
 import io.opentelemetry.api.metrics.LongCounter;
 import io.opentelemetry.api.metrics.LongCounterBuilder;
 import io.opentelemetry.api.metrics.Meter;
+import io.opentelemetry.api.metrics.MeterBuilder;
+import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
 import java.util.List;
 import org.apache.iceberg.metrics.CounterResult;
 import org.apache.iceberg.metrics.MetricsReport;
@@ -48,7 +50,12 @@ final class IcebergMetricsReporter implements MetricsReporter {
   private final LongCounter deleteManifestsCount;
 
   IcebergMetricsReporter(OpenTelemetry openTelemetry) {
-    Meter meter = openTelemetry.getMeter(INSTRUMENTATION_NAME);
+    MeterBuilder meterBuilder = openTelemetry.getMeterProvider().meterBuilder(INSTRUMENTATION_NAME);
+    String version = EmbeddedInstrumentationProperties.findVersion(INSTRUMENTATION_NAME);
+    if (version != null) {
+      meterBuilder.setInstrumentationVersion(version);
+    }
+    Meter meter = meterBuilder.build();
 
     planningDuration =
         applyAdvice(BASE_ADVICE, ScanMetricsBuilderFactory.totalPlanningDuration(meter, "s"))

instrumentation/jmx-metrics/library/src/main/java/io/opentelemetry/instrumentation/jmx/internal/engine/JmxMetricInsight.java

@@ -25,6 +25,9 @@ public class JmxMetricInsight {
   private static final Logger logger = Logger.getLogger(JmxMetricInsight.class.getName());
 
   private static final String INSTRUMENTATION_SCOPE = "io.opentelemetry.jmx";
+  // version file is generated from the gradle module name; look it up explicitly so the legacy
+  // scope name still resolves to a version
+  private static final String VERSION_LOOKUP_NAME = "io.opentelemetry.jmx-metrics";
 
   private final OpenTelemetry openTelemetry;
   private final long discoveryDelay;
@@ -77,7 +80,8 @@ public void start(
           "Empty JMX configuration, no metrics will be collected for InstrumentationScope "
               + INSTRUMENTATION_SCOPE);
     } else {
-      MetricRegistrar registrar = new MetricRegistrar(openTelemetry, INSTRUMENTATION_SCOPE);
+      MetricRegistrar registrar =
+          new MetricRegistrar(openTelemetry, INSTRUMENTATION_SCOPE, VERSION_LOOKUP_NAME);
       BeanFinder finder = new BeanFinder(registrar, discoveryDelay);
       finder.discoverBeans(conf, connections);
     }

instrumentation/jmx-metrics/library/src/main/java/io/opentelemetry/instrumentation/jmx/internal/engine/MetricRegistrar.java

@@ -14,8 +14,10 @@
 import io.opentelemetry.api.metrics.LongCounterBuilder;
 import io.opentelemetry.api.metrics.LongUpDownCounterBuilder;
 import io.opentelemetry.api.metrics.Meter;
+import io.opentelemetry.api.metrics.MeterBuilder;
 import io.opentelemetry.api.metrics.ObservableDoubleMeasurement;
 import io.opentelemetry.api.metrics.ObservableLongMeasurement;
+import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
 import java.util.Collection;
 import java.util.Optional;
 import java.util.function.Consumer;
@@ -31,8 +33,14 @@ class MetricRegistrar {
 
   private final Meter meter;
 
-  MetricRegistrar(OpenTelemetry openTelemetry, String instrumentationScope) {
-    meter = openTelemetry.getMeter(instrumentationScope);
+  MetricRegistrar(
+      OpenTelemetry openTelemetry, String instrumentationScope, String versionLookupName) {
+    MeterBuilder meterBuilder = openTelemetry.getMeterProvider().meterBuilder(instrumentationScope);
+    String version = EmbeddedInstrumentationProperties.findVersion(versionLookupName);
+    if (version != null) {
+      meterBuilder.setInstrumentationVersion(version);
+    }
+    meter = meterBuilder.build();
   }
 
   /**

instrumentation/micrometer/micrometer-1.5/library/src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryMeterRegistryBuilder.java

@@ -15,6 +15,8 @@
 import io.micrometer.core.instrument.Timer;
 import io.micrometer.core.instrument.config.NamingConvention;
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.metrics.MeterBuilder;
+import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
 import java.util.concurrent.TimeUnit;
 
 /** A builder of {@link OpenTelemetryMeterRegistry}. */
@@ -95,11 +97,12 @@ public MeterRegistry build() {
             ? DistributionStatisticConfigModifier.IDENTITY
             : DistributionStatisticConfigModifier.DISABLE_HISTOGRAM_GAUGES;
 
+    MeterBuilder meterBuilder = openTelemetry.getMeterProvider().meterBuilder(INSTRUMENTATION_NAME);
+    String version = EmbeddedInstrumentationProperties.findVersion(INSTRUMENTATION_NAME);
+    if (version != null) {
+      meterBuilder.setInstrumentationVersion(version);
+    }
     return new OpenTelemetryMeterRegistry(
-        clock,
-        baseTimeUnit,
-        namingConvention,
-        modifier,
-        openTelemetry.getMeterProvider().get(INSTRUMENTATION_NAME));
+        clock, baseTimeUnit, namingConvention, modifier, meterBuilder.build());
   }
 }

instrumentation/oshi-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/oshi/v5_0/MetricsRegistration.java

@@ -6,33 +6,60 @@
 package io.opentelemetry.javaagent.instrumentation.oshi.v5_0;
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.api.metrics.Meter;
+import io.opentelemetry.api.metrics.MeterBuilder;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil;
+import io.opentelemetry.instrumentation.api.internal.EmbeddedInstrumentationProperties;
 import io.opentelemetry.instrumentation.oshi.v5_0.ProcessMetrics;
 import io.opentelemetry.instrumentation.oshi.v5_0.SystemMetrics;
+import io.opentelemetry.javaagent.bootstrap.internal.AgentCommonConfig;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 public class MetricsRegistration {
 
+  // version file is generated from the gradle module name; look it up explicitly so the legacy
+  // scope name still resolves to a version
+  private static final String VERSION_LOOKUP_NAME = "io.opentelemetry.oshi-5.0";
+  // under v3-preview switch the emitted scope name to match the gradle module name, otherwise
+  // keep the pre-rename scope so existing dashboards/filters on
+  // otel.scope.name="io.opentelemetry.oshi" continue to work
+  private static final String INSTRUMENTATION_NAME =
+      AgentCommonConfig.get().isV3Preview() ? VERSION_LOOKUP_NAME : "io.opentelemetry.oshi";
+
   private static final AtomicBoolean registered = new AtomicBoolean();
 
+  // deprecated registerObservers(Meter) overloads exist solely so we can keep emitting the legacy
+  // io.opentelemetry.oshi scope by default; both go away in 3.0 once v3-preview becomes default
+  @SuppressWarnings("deprecation")
   public static void register() {
     if (registered.compareAndSet(false, true)) {
+      Meter meter = buildMeter();
       List<AutoCloseable> observables = new ArrayList<>();
-      observables.addAll(SystemMetrics.registerObservers(GlobalOpenTelemetry.get()));
+      observables.addAll(SystemMetrics.registerObservers(meter));
 
       // ProcessMetrics don't follow the spec
       if (DeclarativeConfigUtil.getInstrumentationConfig(GlobalOpenTelemetry.get(), "oshi")
           .get("experimental_metrics/development")
           .getBoolean("enabled", false)) {
-        observables.addAll(ProcessMetrics.registerObservers(GlobalOpenTelemetry.get()));
+        observables.addAll(ProcessMetrics.registerObservers(meter));
       }
       Thread cleanupTelemetry = new Thread(() -> MetricsRegistration.closeObservables(observables));
       Runtime.getRuntime().addShutdownHook(cleanupTelemetry);
     }
   }
 
+  private static Meter buildMeter() {
+    MeterBuilder meterBuilder =
+        GlobalOpenTelemetry.get().getMeterProvider().meterBuilder(INSTRUMENTATION_NAME);
+    String version = EmbeddedInstrumentationProperties.findVersion(VERSION_LOOKUP_NAME);
+    if (version != null) {
+      meterBuilder.setInstrumentationVersion(version);
+    }
+    return meterBuilder.build();
+  }
+
   private static void closeObservables(List<AutoCloseable> observables) {
     observables.forEach(MetricsRegistration::closeObservable);
   }

instrumentation/oshi-5.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/oshi/v5_0/ProcessMetricsTest.java

@@ -22,4 +22,10 @@ protected void registerMetrics() {}
   protected InstrumentationExtension testing() {
     return testing;
   }
+
+  @Override
+  @SuppressWarnings("deprecation") // overriding a deprecated abstract method
+  protected String scopeName() {
+    return "io.opentelemetry.oshi";
+  }
 }

instrumentation/oshi-5.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/oshi/v5_0/SystemMetricsTest.java

@@ -22,4 +22,10 @@ protected void registerMetrics() {}
   protected InstrumentationExtension testing() {
     return testing;
   }
+
+  @Override
+  @SuppressWarnings("deprecation") // overriding a deprecated abstract method
+  protected String scopeName() {
+    return "io.opentelemetry.oshi";
+  }
 }