Implement NamingConvention support in Micrometer bridge (#5328)

* Implement NamingConvention support in Micrometer bridge * default naming convention
open-telemetry · Feb 10, 2022 · 956b566 · 956b566
1 parent 2cf853d
commit 956b566
Show file tree

Hide file tree

Showing 11 changed files with 352 additions and 31 deletions.
diff --git a/...-1.5/library/src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/Bridging.java b/...-1.5/library/src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/Bridging.java
@@ -8,6 +8,7 @@
 import io.micrometer.core.instrument.Meter;
 import io.micrometer.core.instrument.Statistic;
 import io.micrometer.core.instrument.Tag;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
@@ -17,18 +18,28 @@ final class Bridging {
 
   private static final Cache<String, AttributeKey<String>> tagsCache = Cache.bounded(1024);
 
-  static Attributes tagsAsAttributes(Meter.Id id) {
+  static Attributes tagsAsAttributes(Meter.Id id, NamingConvention namingConvention) {
     Iterable<Tag> tags = id.getTagsAsIterable();
     if (!tags.iterator().hasNext()) {
       return Attributes.empty();
     }
     AttributesBuilder builder = Attributes.builder();
     for (Tag tag : tags) {
-      builder.put(tagsCache.computeIfAbsent(tag.getKey(), AttributeKey::stringKey), tag.getValue());
+      String tagKey = namingConvention.tagKey(tag.getKey());
+      String tagValue = namingConvention.tagValue(tag.getValue());
+      builder.put(tagsCache.computeIfAbsent(tagKey, AttributeKey::stringKey), tagValue);
     }
     return builder.build();
   }
 
+  static String name(Meter.Id id, NamingConvention namingConvention) {
+    return name(id.getName(), id, namingConvention);
+  }
+
+  private static String name(String name, Meter.Id id, NamingConvention namingConvention) {
+    return namingConvention.name(name, id.getType(), id.getBaseUnit());
+  }
+
   static String description(Meter.Id id) {
     String description = id.getDescription();
     return description == null ? "" : description;
@@ -39,12 +50,13 @@ static String baseUnit(Meter.Id id) {
     return baseUnit == null ? "1" : baseUnit;
   }
 
-  static String statisticInstrumentName(Meter.Id id, Statistic statistic) {
+  static String statisticInstrumentName(
+      Meter.Id id, Statistic statistic, NamingConvention namingConvention) {
     String prefix = id.getName() + ".";
     // use "total_time" instead of "total" to avoid clashing with Statistic.TOTAL
     String statisticStr =
         statistic == Statistic.TOTAL_TIME ? "total_time" : statistic.getTagValueRepresentation();
-    return prefix + statisticStr;
+    return name(prefix + statisticStr, id, namingConvention);
   }
 
   private Bridging() {}

diff --git a/.../src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryCounter.java b/.../src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryCounter.java
@@ -7,10 +7,12 @@
 
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.baseUnit;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.description;
+import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.name;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.tagsAsAttributes;
 
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.Measurement;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.micrometer.core.instrument.util.MeterEquivalence;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.metrics.DoubleCounter;
@@ -28,16 +30,17 @@ final class OpenTelemetryCounter implements Counter, RemovableMeter {
 
   private volatile boolean removed = false;
 
-  OpenTelemetryCounter(Id id, Meter otelMeter) {
+  OpenTelemetryCounter(Id id, NamingConvention namingConvention, Meter otelMeter) {
     this.id = id;
+
+    this.attributes = tagsAsAttributes(id, namingConvention);
     this.otelCounter =
         otelMeter
-            .counterBuilder(id.getName())
+            .counterBuilder(name(id, namingConvention))
             .setDescription(description(id))
             .setUnit(baseUnit(id))
             .ofDoubles()
             .build();
-    this.attributes = tagsAsAttributes(id);
   }
 
   @Override

diff --git a/...va/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryDistributionSummary.java b/...va/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryDistributionSummary.java
@@ -7,6 +7,7 @@
 
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.baseUnit;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.description;
+import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.name;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.statisticInstrumentName;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.tagsAsAttributes;
 
@@ -15,6 +16,7 @@
 import io.micrometer.core.instrument.DistributionSummary;
 import io.micrometer.core.instrument.Measurement;
 import io.micrometer.core.instrument.Statistic;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.micrometer.core.instrument.distribution.DistributionStatisticConfig;
 import io.micrometer.core.instrument.distribution.NoopHistogram;
 import io.micrometer.core.instrument.distribution.TimeWindowMax;
@@ -41,6 +43,7 @@ final class OpenTelemetryDistributionSummary extends AbstractDistributionSummary
 
   OpenTelemetryDistributionSummary(
       Id id,
+      NamingConvention namingConvention,
       Clock clock,
       DistributionStatisticConfig distributionStatisticConfig,
       double scale,
@@ -55,16 +58,16 @@ final class OpenTelemetryDistributionSummary extends AbstractDistributionSummary
     }
     max = new TimeWindowMax(clock, distributionStatisticConfig);
 
-    this.attributes = tagsAsAttributes(id);
+    this.attributes = tagsAsAttributes(id, namingConvention);
     this.otelHistogram =
         otelMeter
-            .histogramBuilder(id.getName())
+            .histogramBuilder(name(id, namingConvention))
             .setDescription(description(id))
             .setUnit(baseUnit(id))
             .build();
     this.maxHandle =
         asyncInstrumentRegistry.buildGauge(
-            statisticInstrumentName(id, Statistic.MAX),
+            statisticInstrumentName(id, Statistic.MAX, namingConvention),
             description(id),
             baseUnit(id),
             attributes,

diff --git a/...n/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryFunctionCounter.java b/...n/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryFunctionCounter.java
@@ -7,10 +7,12 @@
 
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.baseUnit;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.description;
+import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.name;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.tagsAsAttributes;
 
 import io.micrometer.core.instrument.FunctionCounter;
 import io.micrometer.core.instrument.Measurement;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.micrometer.core.instrument.util.MeterEquivalence;
 import io.opentelemetry.instrumentation.api.internal.AsyncInstrumentRegistry;
 import io.opentelemetry.instrumentation.api.internal.AsyncInstrumentRegistry.AsyncMeasurementHandle;
@@ -26,14 +28,20 @@ final class OpenTelemetryFunctionCounter<T> implements FunctionCounter, Removabl
 
   OpenTelemetryFunctionCounter(
       Id id,
+      NamingConvention namingConvention,
       T obj,
       ToDoubleFunction<T> countFunction,
       AsyncInstrumentRegistry asyncInstrumentRegistry) {
     this.id = id;
 
     countMeasurementHandle =
         asyncInstrumentRegistry.buildDoubleCounter(
-            id.getName(), description(id), baseUnit(id), tagsAsAttributes(id), obj, countFunction);
+            name(id, namingConvention),
+            description(id),
+            baseUnit(id),
+            tagsAsAttributes(id, namingConvention),
+            obj,
+            countFunction);
   }
 
   @Override

diff --git a/...ain/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryFunctionTimer.java b/...ain/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryFunctionTimer.java
@@ -13,6 +13,7 @@
 import io.micrometer.core.instrument.FunctionTimer;
 import io.micrometer.core.instrument.Measurement;
 import io.micrometer.core.instrument.Statistic;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.micrometer.core.instrument.util.MeterEquivalence;
 import io.micrometer.core.instrument.util.TimeUtils;
 import io.opentelemetry.api.common.Attributes;
@@ -34,6 +35,7 @@ final class OpenTelemetryFunctionTimer<T> implements FunctionTimer, RemovableMet
 
   OpenTelemetryFunctionTimer(
       Id id,
+      NamingConvention namingConvention,
       T obj,
       ToLongFunction<T> countFunction,
       ToDoubleFunction<T> totalTimeFunction,
@@ -44,9 +46,9 @@ final class OpenTelemetryFunctionTimer<T> implements FunctionTimer, RemovableMet
     this.id = id;
     this.baseTimeUnit = baseTimeUnit;
 
-    String countMeterName = statisticInstrumentName(id, Statistic.COUNT);
-    String totalTimeMeterName = statisticInstrumentName(id, Statistic.TOTAL_TIME);
-    Attributes attributes = tagsAsAttributes(id);
+    String countMeterName = statisticInstrumentName(id, Statistic.COUNT, namingConvention);
+    String totalTimeMeterName = statisticInstrumentName(id, Statistic.TOTAL_TIME, namingConvention);
+    Attributes attributes = tagsAsAttributes(id, namingConvention);
 
     countMeasurementHandle =
         asyncInstrumentRegistry.buildLongCounter(

diff --git a/...ry/src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryGauge.java b/...ry/src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryGauge.java
@@ -7,10 +7,12 @@
 
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.baseUnit;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.description;
+import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.name;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.tagsAsAttributes;
 
 import io.micrometer.core.instrument.Gauge;
 import io.micrometer.core.instrument.Measurement;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.micrometer.core.instrument.util.MeterEquivalence;
 import io.opentelemetry.instrumentation.api.internal.AsyncInstrumentRegistry;
 import io.opentelemetry.instrumentation.api.internal.AsyncInstrumentRegistry.AsyncMeasurementHandle;
@@ -26,14 +28,21 @@ final class OpenTelemetryGauge<T> implements Gauge, RemovableMeter {
 
   OpenTelemetryGauge(
       Id id,
+      NamingConvention namingConvention,
       @Nullable T obj,
       ToDoubleFunction<T> objMetric,
       AsyncInstrumentRegistry asyncInstrumentRegistry) {
+
     this.id = id;
 
     gaugeMeasurementHandle =
         asyncInstrumentRegistry.buildGauge(
-            id.getName(), description(id), baseUnit(id), tagsAsAttributes(id), obj, objMetric);
+            name(id, namingConvention),
+            description(id),
+            baseUnit(id),
+            tagsAsAttributes(id, namingConvention),
+            obj,
+            objMetric);
   }
 
   @Override

diff --git a/...ain/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryLongTaskTimer.java b/...ain/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryLongTaskTimer.java
@@ -6,13 +6,15 @@
 package io.opentelemetry.instrumentation.micrometer.v1_5;
 
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.description;
+import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.name;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.statisticInstrumentName;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.Bridging.tagsAsAttributes;
 import static io.opentelemetry.instrumentation.micrometer.v1_5.TimeUnitHelper.getUnitString;
 
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.core.instrument.Measurement;
 import io.micrometer.core.instrument.Statistic;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.micrometer.core.instrument.distribution.DistributionStatisticConfig;
 import io.micrometer.core.instrument.internal.DefaultLongTaskTimer;
 import io.micrometer.core.instrument.util.TimeUtils;
@@ -36,6 +38,7 @@ final class OpenTelemetryLongTaskTimer extends DefaultLongTaskTimer implements R
 
   OpenTelemetryLongTaskTimer(
       Id id,
+      NamingConvention namingConvention,
       Clock clock,
       TimeUnit baseTimeUnit,
       DistributionStatisticConfig distributionStatisticConfig,
@@ -47,17 +50,18 @@ final class OpenTelemetryLongTaskTimer extends DefaultLongTaskTimer implements R
 
     this.otelHistogram =
         otelMeter
-            .histogramBuilder(id.getName())
+            .histogramBuilder(name(id, namingConvention))
             .setDescription(description(id))
             .setUnit(getUnitString(baseTimeUnit))
             .build();
     this.otelActiveTasksCounter =
         otelMeter
-            .upDownCounterBuilder(statisticInstrumentName(id, Statistic.ACTIVE_TASKS))
+            .upDownCounterBuilder(
+                statisticInstrumentName(id, Statistic.ACTIVE_TASKS, namingConvention))
             .setDescription(description(id))
             .setUnit("tasks")
             .build();
-    this.attributes = tagsAsAttributes(id);
+    this.attributes = tagsAsAttributes(id, namingConvention);
   }
 
   @Override

diff --git a/...ry/src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryMeter.java b/...ry/src/main/java/io/opentelemetry/instrumentation/micrometer/v1_5/OpenTelemetryMeter.java
@@ -12,6 +12,7 @@
 
 import io.micrometer.core.instrument.Measurement;
 import io.micrometer.core.instrument.Meter;
+import io.micrometer.core.instrument.config.NamingConvention;
 import io.micrometer.core.instrument.util.MeterEquivalence;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.instrumentation.api.internal.AsyncInstrumentRegistry;
@@ -28,13 +29,16 @@ final class OpenTelemetryMeter implements Meter, RemovableMeter {
   private final List<AsyncMeasurementHandle> measurementHandles;
 
   OpenTelemetryMeter(
-      Id id, Iterable<Measurement> measurements, AsyncInstrumentRegistry asyncInstrumentRegistry) {
+      Id id,
+      NamingConvention namingConvention,
+      Iterable<Measurement> measurements,
+      AsyncInstrumentRegistry asyncInstrumentRegistry) {
     this.id = id;
-    Attributes attributes = tagsAsAttributes(id);
+    Attributes attributes = tagsAsAttributes(id, namingConvention);
 
     List<AsyncMeasurementHandle> measurementHandles = new ArrayList<>();
     for (Measurement measurement : measurements) {
-      String name = statisticInstrumentName(id, measurement.getStatistic());
+      String name = statisticInstrumentName(id, measurement.getStatistic(), namingConvention);
       String description = description(id);
       String baseUnit = baseUnit(id);