Adds support to provide tags with value in Gauge metric

Signed-off-by: Gagan Juneja <[email protected]>
Gaganjuneja · Jun 5, 2024 · af14596 · af14596
1 parent f9f85cf
commit af14596
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 17 deletions.
diff --git a/libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/DefaultMetricsRegistry.java b/libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/DefaultMetricsRegistry.java
@@ -49,7 +49,7 @@ public Closeable createGauge(String name, String description, String unit, Suppl
     }
 
     @Override
-    public Closeable createGauge(String name, String description, String unit, Supplier<ObservableMeasurement> value) {
+    public Closeable createGauge(String name, String description, String unit, Supplier<TaggedMeasurement> value) {
         return metricsTelemetry.createGauge(name, description, unit, value);
     }
 

diff --git a/libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/MetricsRegistry.java b/libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/MetricsRegistry.java
@@ -73,6 +73,6 @@ public interface MetricsRegistry extends Closeable {
      * @param value       value provider.
      * @return closeable to dispose/close the Gauge metric.
      */
-    Closeable createGauge(String name, String description, String unit, Supplier<ObservableMeasurement> value);
+    Closeable createGauge(String name, String description, String unit, Supplier<TaggedMeasurement> value);
 
 }
diff --git a/...emetry/metrics/ObservableMeasurement.java → .../telemetry/metrics/TaggedMeasurement.java b/...emetry/metrics/ObservableMeasurement.java → .../telemetry/metrics/TaggedMeasurement.java
@@ -16,21 +16,21 @@
  * @opensearch.experimental
  */
 @ExperimentalApi
-public class ObservableMeasurement {
+public class TaggedMeasurement {
     private final Double value;
     private final Tags tags;
 
     /**
-     * Factory method to create the {@link ObservableMeasurement} object.
+     * Factory method to create the {@link TaggedMeasurement} object.
      * @param value value.
      * @param tags tags to be added per value.
-     * @return ObservableMeasurement
+     * @return tagged measurement TaggedMeasurement
      */
-    public static ObservableMeasurement create(double value, Tags tags) {
-        return new ObservableMeasurement(value, tags);
+    public static TaggedMeasurement create(double value, Tags tags) {
+        return new TaggedMeasurement(value, tags);
     }
 
-    private ObservableMeasurement(double value, Tags tags) {
+    private TaggedMeasurement(double value, Tags tags) {
         this.value = value;
         this.tags = tags;
     }

diff --git a/libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/noop/NoopMetricsRegistry.java b/libs/telemetry/src/main/java/org/opensearch/telemetry/metrics/noop/NoopMetricsRegistry.java
@@ -12,7 +12,7 @@
 import org.opensearch.telemetry.metrics.Counter;
 import org.opensearch.telemetry.metrics.Histogram;
 import org.opensearch.telemetry.metrics.MetricsRegistry;
-import org.opensearch.telemetry.metrics.ObservableMeasurement;
+import org.opensearch.telemetry.metrics.TaggedMeasurement;
 import org.opensearch.telemetry.metrics.tags.Tags;
 
 import java.io.Closeable;
@@ -54,7 +54,7 @@ public Closeable createGauge(String name, String description, String unit, Suppl
     }
 
     @Override
-    public Closeable createGauge(String name, String description, String unit, Supplier<ObservableMeasurement> value) {
+    public Closeable createGauge(String name, String description, String unit, Supplier<TaggedMeasurement> value) {
         return () -> {};
     }
 

diff --git a/...telemetry/src/test/java/org/opensearch/telemetry/metrics/DefaultMetricsRegistryTests.java b/...telemetry/src/test/java/org/opensearch/telemetry/metrics/DefaultMetricsRegistryTests.java
@@ -88,7 +88,7 @@ public void testGaugeWithValueAndTagSupplier() {
             "org.opensearch.telemetry.metrics.DefaultMeterRegistryTests.testObservableGauge",
             "test observable gauge",
             "ms",
-            () -> ObservableMeasurement.create(1.0, Tags.EMPTY)
+            () -> TaggedMeasurement.create(1.0, Tags.EMPTY)
         );
         assertSame(mockCloseable, closeable);
     }

diff --git a/...nalClusterTest/java/org/opensearch/telemetry/metrics/TelemetryMetricsEnabledSanityIT.java b/...nalClusterTest/java/org/opensearch/telemetry/metrics/TelemetryMetricsEnabledSanityIT.java
@@ -156,8 +156,8 @@ public void testGaugeWithValueAndTagSupplier() throws Exception {
         InMemorySingletonMetricsExporter.INSTANCE.reset();
         Tags tags = Tags.create().addTag("test", "integ-test");
         final AtomicInteger testValue = new AtomicInteger(0);
-        Supplier<ObservableMeasurement> valueProvider = () -> {
-            return ObservableMeasurement.create(Double.valueOf(testValue.incrementAndGet()), tags);
+        Supplier<TaggedMeasurement> valueProvider = () -> {
+            return TaggedMeasurement.create(Double.valueOf(testValue.incrementAndGet()), tags);
         };
         Closeable gaugeCloseable = metricsRegistry.createGauge(metricName, "test", "ms", valueProvider);
         // Sleep for about 2.2s to wait for metrics to be published.

diff --git a/...s/telemetry-otel/src/main/java/org/opensearch/telemetry/metrics/OTelMetricsTelemetry.java b/...s/telemetry-otel/src/main/java/org/opensearch/telemetry/metrics/OTelMetricsTelemetry.java
@@ -102,7 +102,7 @@ public Closeable createGauge(String name, String description, String unit, Suppl
     }
 
     @Override
-    public Closeable createGauge(String name, String description, String unit, Supplier<ObservableMeasurement> value) {
+    public Closeable createGauge(String name, String description, String unit, Supplier<TaggedMeasurement> value) {
         ObservableDoubleGauge doubleObservableGauge = AccessController.doPrivileged(
             (PrivilegedAction<ObservableDoubleGauge>) () -> otelMeter.gaugeBuilder(name)
                 .setUnit(unit)

diff --git a/...emetry-otel/src/test/java/org/opensearch/telemetry/metrics/OTelMetricsTelemetryTests.java b/...emetry-otel/src/test/java/org/opensearch/telemetry/metrics/OTelMetricsTelemetryTests.java
@@ -204,7 +204,7 @@ public void testGaugeWithValueAndTagsSupplier() throws Exception {
             observableGaugeName,
             description,
             unit,
-            () -> ObservableMeasurement.create(1.0, Tags.EMPTY)
+            () -> TaggedMeasurement.create(1.0, Tags.EMPTY)
         );
         closeable.close();
         verify(observableDoubleGauge).close();

diff --git a/test/framework/src/main/java/org/opensearch/test/telemetry/MockTelemetry.java b/test/framework/src/main/java/org/opensearch/test/telemetry/MockTelemetry.java
@@ -13,7 +13,7 @@
 import org.opensearch.telemetry.metrics.Counter;
 import org.opensearch.telemetry.metrics.Histogram;
 import org.opensearch.telemetry.metrics.MetricsTelemetry;
-import org.opensearch.telemetry.metrics.ObservableMeasurement;
+import org.opensearch.telemetry.metrics.TaggedMeasurement;
 import org.opensearch.telemetry.metrics.noop.NoopCounter;
 import org.opensearch.telemetry.metrics.noop.NoopHistogram;
 import org.opensearch.telemetry.metrics.tags.Tags;
@@ -64,7 +64,7 @@ public Closeable createGauge(String name, String description, String unit, Suppl
             }
 
             @Override
-            public Closeable createGauge(String name, String description, String unit, Supplier<ObservableMeasurement> value) {
+            public Closeable createGauge(String name, String description, String unit, Supplier<TaggedMeasurement> value) {
                 return () -> {};
             }