Test OM2 original names through builders

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>

Author: zeitlinger

prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/OpenMetrics2TextFormatWriterTest.java

@@ -0,0 +1,89 @@
+package io.prometheus.metrics.core.metrics;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.prometheus.metrics.config.EscapingScheme;
+import io.prometheus.metrics.config.OpenMetrics2Properties;
+import io.prometheus.metrics.expositionformats.ExpositionFormatWriter;
+import io.prometheus.metrics.expositionformats.OpenMetrics2TextFormatWriter;
+import io.prometheus.metrics.expositionformats.OpenMetricsTextFormatWriter;
+import io.prometheus.metrics.model.snapshots.MetricSnapshots;
+import io.prometheus.metrics.model.snapshots.Unit;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import org.junit.jupiter.api.Test;
+
+class OpenMetrics2TextFormatWriterTest {
+
+  @Test
+  void counterPreservesOriginalNameWhenUnitIsConfigured() throws IOException {
+    Counter counter =
+        Counter.builder()
+            .name("my_counter")
+            .unit(Unit.SECONDS)
+            .help("Test counter")
+            .labelNames("method")
+            .build();
+    counter.labelValues("GET").inc(42.0);
+    MetricSnapshots snapshots = MetricSnapshots.of(counter.collect());
+
+    String om1Output = writeWithOM1(snapshots);
+    String om2Output = writeWithOM2(snapshots);
+
+    assertThat(om1Output).contains("my_counter_seconds_total{method=\"GET\"} 42.0");
+    assertThat(om2Output)
+        .contains("# TYPE my_counter counter\n")
+        .contains("# UNIT my_counter seconds\n")
+        .contains("# HELP my_counter Test counter\n")
+        .containsPattern("(?m)^my_counter\\{method=\"GET\"} 42\\.0 st@\\d+\\.\\d{3}$")
+        .doesNotContain("my_counter_seconds");
+  }
+
+  @Test
+  void nativeHistogramPreservesOriginalNameWhenUnitIsConfigured() throws IOException {
+    Histogram histogram =
+        Histogram.builder()
+            .name("my.request.duration")
+            .unit(Unit.SECONDS)
+            .help("Request duration in seconds")
+            .labelNames("http.path")
+            .nativeOnly()
+            .build();
+    histogram.labelValues("/hello").observe(3.2);
+    MetricSnapshots snapshots = MetricSnapshots.of(histogram.collect());
+
+    String om2Output = writeWithNativeHistograms(snapshots);
+
+    assertThat(om2Output)
+        .contains("# TYPE \"my.request.duration\" histogram\n")
+        .contains("# UNIT \"my.request.duration\" seconds\n")
+        .contains("# HELP \"my.request.duration\" Request duration in seconds\n")
+        .contains("{\"my.request.duration\",\"http.path\"=\"/hello\"} {count:1,sum:3.2,")
+        .doesNotContain("my.request.duration_seconds");
+  }
+
+  private String writeWithOM1(MetricSnapshots snapshots) throws IOException {
+    return write(snapshots, OpenMetricsTextFormatWriter.create());
+  }
+
+  private String writeWithOM2(MetricSnapshots snapshots) throws IOException {
+    return write(snapshots, OpenMetrics2TextFormatWriter.create());
+  }
+
+  private String writeWithNativeHistograms(MetricSnapshots snapshots) throws IOException {
+    OpenMetrics2TextFormatWriter writer =
+        OpenMetrics2TextFormatWriter.builder()
+            .setOpenMetrics2Properties(
+                OpenMetrics2Properties.builder().nativeHistograms(true).build())
+            .build();
+    return write(snapshots, writer);
+  }
+
+  private String write(MetricSnapshots snapshots, ExpositionFormatWriter writer)
+      throws IOException {
+    ByteArrayOutputStream out = new ByteArrayOutputStream();
+    writer.write(out, snapshots, EscapingScheme.ALLOW_UTF8);
+    return out.toString(StandardCharsets.UTF_8.name());
+  }
+}

prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/OpenMetrics2TextFormatWriterTest.java

@@ -12,17 +12,14 @@
 import io.prometheus.metrics.model.snapshots.HistogramSnapshot;
 import io.prometheus.metrics.model.snapshots.InfoSnapshot;
 import io.prometheus.metrics.model.snapshots.Labels;
-import io.prometheus.metrics.model.snapshots.MetricMetadata;
 import io.prometheus.metrics.model.snapshots.MetricSnapshots;
 import io.prometheus.metrics.model.snapshots.NativeHistogramBuckets;
 import io.prometheus.metrics.model.snapshots.Quantiles;
 import io.prometheus.metrics.model.snapshots.StateSetSnapshot;
 import io.prometheus.metrics.model.snapshots.SummarySnapshot;
-import io.prometheus.metrics.model.snapshots.Unit;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
-import java.util.Collections;
 import org.junit.jupiter.api.Test;
 
 class OpenMetrics2TextFormatWriterTest {
@@ -90,35 +87,6 @@ void testGetOpenMetrics2Properties() {
     assertThat(writer.getOpenMetrics2Properties().getCompositeValues()).isTrue();
   }
 
-  @Test
-  void testCounterNoTotalSuffix() throws IOException {
-    MetricSnapshots snapshots =
-        MetricSnapshots.of(
-            new CounterSnapshot(
-                new MetricMetadata(
-                    "my_counter_seconds",
-                    "my_counter_seconds",
-                    "my_counter",
-                    "Test counter",
-                    Unit.SECONDS),
-                Collections.singletonList(
-                    CounterSnapshot.CounterDataPointSnapshot.builder()
-                        .value(42.0)
-                        .labels(Labels.of("method", "GET"))
-                        .build())));
-
-    String om2Output = writeWithOM2(snapshots);
-
-    // OM2: name as provided, no _total or unit suffix appending.
-    assertThat(om2Output)
-        .isEqualTo(
-            "# TYPE my_counter counter\n"
-                + "# UNIT my_counter seconds\n"
-                + "# HELP my_counter Test counter\n"
-                + "my_counter{method=\"GET\"} 42.0\n"
-                + "# EOF\n");
-  }
-
   @Test
   void testCounterWithTotalSuffix() throws IOException {
     MetricSnapshots snapshots =
@@ -688,49 +656,6 @@ void testNativeGaugeHistogramWithNegativeAndPositiveSpans() throws IOException {
                 + "# EOF\n");
   }
 
-  @Test
-  void testNativeHistogramWithDots() throws IOException {
-    Exemplar exemplar =
-        Exemplar.builder()
-            .labels(Labels.of("some.exemplar.key", "some value"))
-            .value(3.0)
-            .timestampMillis(1690298864383L)
-            .build();
-
-    MetricSnapshots snapshots =
-        MetricSnapshots.of(
-            new HistogramSnapshot(
-                new MetricMetadata(
-                    "my.request.duration.seconds",
-                    "my.request.duration.seconds",
-                    "my.request.duration",
-                    "Request duration in seconds",
-                    Unit.SECONDS),
-                Collections.singletonList(
-                    HistogramSnapshot.HistogramDataPointSnapshot.builder()
-                        .labels(Labels.builder().label("http.path", "/hello").build())
-                        .sum(3.2)
-                        .nativeSchema(5)
-                        .nativeZeroCount(1)
-                        .nativeBucketsForPositiveValues(
-                            NativeHistogramBuckets.builder().bucket(2, 3).build())
-                        .exemplars(Exemplars.of(exemplar))
-                        .build())));
-
-    String output = writeWithNativeHistograms(snapshots);
-
-    assertThat(output)
-        .isEqualTo(
-            "# TYPE \"my.request.duration\" histogram\n"
-                + "# UNIT \"my.request.duration\" seconds\n"
-                + "# HELP \"my.request.duration\" Request duration in seconds\n"
-                + "{\"my.request.duration\",\"http.path\"=\"/hello\"}"
-                + " {count:4,sum:3.2,schema:5,zero_threshold:0.0,zero_count:1,"
-                + "positive_spans:[2:1],positive_buckets:[3]}"
-                + " # {\"some.exemplar.key\"=\"some value\"} 3.0 1690298864.383\n"
-                + "# EOF\n");
-  }
-
   @Test
   void testCompositeSummary() throws IOException {
     MetricSnapshots snapshots =
@@ -917,6 +842,6 @@ private String write(MetricSnapshots snapshots, ExpositionFormatWriter writer)
       throws IOException {
     ByteArrayOutputStream out = new ByteArrayOutputStream();
     writer.write(out, snapshots, EscapingScheme.ALLOW_UTF8);
-    return out.toString(StandardCharsets.UTF_8);
+    return out.toString(StandardCharsets.UTF_8.name());
   }
 }