extract snapshot escaper

Signed-off-by: Gregor Zeitlinger <[email protected]>

Author: zeitlinger

prometheus-metrics-exporter-pushgateway/src/main/java/io/prometheus/metrics/exporter/pushgateway/PushGateway.java

@@ -1,7 +1,7 @@
 package io.prometheus.metrics.exporter.pushgateway;
 
 import static io.prometheus.metrics.exporter.pushgateway.Scheme.HTTP;
-import static io.prometheus.metrics.model.snapshots.PrometheusNaming.escapeName;
+import static io.prometheus.metrics.model.snapshots.SnapshotEscaper.escapeName;
 
 import io.prometheus.metrics.config.ExporterPushgatewayProperties;
 import io.prometheus.metrics.config.PrometheusProperties;

prometheus-metrics-exposition-formats/src/main/java/io/prometheus/metrics/expositionformats/internal/PrometheusProtobufWriterImpl.java

@@ -21,6 +21,7 @@
 import io.prometheus.metrics.model.snapshots.NativeHistogramBuckets;
 import io.prometheus.metrics.model.snapshots.PrometheusNaming;
 import io.prometheus.metrics.model.snapshots.Quantiles;
+import io.prometheus.metrics.model.snapshots.SnapshotEscaper;
 import io.prometheus.metrics.model.snapshots.StateSetSnapshot;
 import io.prometheus.metrics.model.snapshots.SummarySnapshot;
 import io.prometheus.metrics.model.snapshots.UnknownSnapshot;
@@ -43,7 +44,7 @@ public String getContentType() {
   public String toDebugString(MetricSnapshots metricSnapshots, EscapingScheme escapingScheme) {
     StringBuilder stringBuilder = new StringBuilder();
     for (MetricSnapshot s : metricSnapshots) {
-      MetricSnapshot snapshot = PrometheusNaming.escapeMetricSnapshot(s, escapingScheme);
+      MetricSnapshot snapshot = SnapshotEscaper.escapeMetricSnapshot(s, escapingScheme);
       if (!snapshot.getDataPoints().isEmpty()) {
         stringBuilder.append(TextFormat.printer().printToString(convert(snapshot)));
       }
@@ -56,7 +57,7 @@ public void write(
       OutputStream out, MetricSnapshots metricSnapshots, EscapingScheme escapingScheme)
       throws IOException {
     for (MetricSnapshot s : metricSnapshots) {
-      MetricSnapshot snapshot = PrometheusNaming.escapeMetricSnapshot(s, escapingScheme);
+      MetricSnapshot snapshot = SnapshotEscaper.escapeMetricSnapshot(s, escapingScheme);
       if (!snapshot.getDataPoints().isEmpty()) {
         convert(snapshot).writeDelimitedTo(out);
       }

prometheus-metrics-exposition-formats/src/test/java/io/prometheus/metrics/expositionformats/ProtobufExpositionFormatsTest.java

@@ -8,6 +8,7 @@
 import io.prometheus.metrics.model.snapshots.EscapingScheme;
 import io.prometheus.metrics.model.snapshots.MetricSnapshot;
 import io.prometheus.metrics.model.snapshots.PrometheusNaming;
+import io.prometheus.metrics.model.snapshots.SnapshotEscaper;
 
 class ProtobufExpositionFormatsTest extends ExpositionFormatsTest {
 
@@ -16,7 +17,7 @@ protected void assertPrometheusProtobuf(String expected, MetricSnapshot snapshot
     PrometheusProtobufWriterImpl writer = new PrometheusProtobufWriterImpl();
     Metrics.MetricFamily protobufData =
         writer.convert(
-            PrometheusNaming.escapeMetricSnapshot(snapshot, EscapingScheme.UNDERSCORE_ESCAPING));
+          SnapshotEscaper.escapeMetricSnapshot(snapshot, EscapingScheme.UNDERSCORE_ESCAPING));
     String actual = ProtobufUtil.shortDebugString(protobufData);
     assertThat(actual).isEqualTo(expected);
   }

prometheus-metrics-exposition-textformats/src/main/java/io/prometheus/metrics/expositionformats/OpenMetricsTextFormatWriter.java

@@ -23,6 +23,7 @@
 import io.prometheus.metrics.model.snapshots.MetricSnapshots;
 import io.prometheus.metrics.model.snapshots.PrometheusNaming;
 import io.prometheus.metrics.model.snapshots.Quantile;
+import io.prometheus.metrics.model.snapshots.SnapshotEscaper;
 import io.prometheus.metrics.model.snapshots.StateSetSnapshot;
 import io.prometheus.metrics.model.snapshots.SummarySnapshot;
 import io.prometheus.metrics.model.snapshots.UnknownSnapshot;
@@ -111,7 +112,7 @@ public void write(
       throws IOException {
     Writer writer = new BufferedWriter(new OutputStreamWriter(out, StandardCharsets.UTF_8));
     for (MetricSnapshot s : metricSnapshots) {
-      MetricSnapshot snapshot = PrometheusNaming.escapeMetricSnapshot(s, escapingScheme);
+      MetricSnapshot snapshot = SnapshotEscaper.escapeMetricSnapshot(s, escapingScheme);
       if (!snapshot.getDataPoints().isEmpty()) {
         if (snapshot instanceof CounterSnapshot) {
           writeCounter(writer, (CounterSnapshot) snapshot);

prometheus-metrics-exposition-textformats/src/main/java/io/prometheus/metrics/expositionformats/PrometheusTextFormatWriter.java

@@ -20,6 +20,7 @@
 import io.prometheus.metrics.model.snapshots.MetricSnapshots;
 import io.prometheus.metrics.model.snapshots.PrometheusNaming;
 import io.prometheus.metrics.model.snapshots.Quantile;
+import io.prometheus.metrics.model.snapshots.SnapshotEscaper;
 import io.prometheus.metrics.model.snapshots.StateSetSnapshot;
 import io.prometheus.metrics.model.snapshots.SummarySnapshot;
 import io.prometheus.metrics.model.snapshots.UnknownSnapshot;
@@ -113,7 +114,7 @@ public void write(
     // "summary".
     Writer writer = new BufferedWriter(new OutputStreamWriter(out, StandardCharsets.UTF_8));
     for (MetricSnapshot s : metricSnapshots) {
-      MetricSnapshot snapshot = PrometheusNaming.escapeMetricSnapshot(s, escapingScheme);
+      MetricSnapshot snapshot = SnapshotEscaper.escapeMetricSnapshot(s, escapingScheme);
       if (!snapshot.getDataPoints().isEmpty()) {
         if (snapshot instanceof CounterSnapshot) {
           writeCounter(writer, (CounterSnapshot) snapshot);
@@ -134,7 +135,7 @@ public void write(
     }
     if (writeCreatedTimestamps) {
       for (MetricSnapshot s : metricSnapshots) {
-        MetricSnapshot snapshot = PrometheusNaming.escapeMetricSnapshot(s, escapingScheme);
+        MetricSnapshot snapshot = SnapshotEscaper.escapeMetricSnapshot(s, escapingScheme);
         if (!snapshot.getDataPoints().isEmpty()) {
           if (snapshot instanceof CounterSnapshot) {
             writeCreated(writer, snapshot);

prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/SnapshotEscaper.java

@@ -10,7 +10,38 @@
 import java.util.regex.Pattern;
 import javax.annotation.Nullable;
 
-class SnapshotEscaper {
+public class SnapshotEscaper {
+
+  private SnapshotEscaper() {
+  }
+
+  /** Escapes the given metric names and labels with the given escaping scheme. */
+  public static MetricSnapshot escapeMetricSnapshot(MetricSnapshot v, EscapingScheme scheme) {
+    if (v == null) {
+      return null;
+    }
+
+    if (scheme == EscapingScheme.NO_ESCAPING) {
+      return v;
+    }
+
+    List<DataPointSnapshot> outDataPoints = new ArrayList<>();
+
+    for (DataPointSnapshot d : v.getDataPoints()) {
+      if (!snapshotNeedsEscaping(d, scheme)) {
+        outDataPoints.add(d);
+        continue;
+      }
+
+      DataPointSnapshot outDataPointSnapshot =
+        createEscapedDataPointSnapshot(v, d, escapeLabels(d.getLabels(), scheme), scheme);
+      outDataPoints.add(outDataPointSnapshot);
+    }
+
+    return createEscapedMetricSnapshot(
+      v, escapeName(v.getMetadata().getName(), scheme), outDataPoints);
+  }
+
   static MetricSnapshot createEscapedMetricSnapshot(
       MetricSnapshot v, String outName, List<DataPointSnapshot> outDataPoints) {
     if (v instanceof CounterSnapshot) {
@@ -83,33 +114,6 @@ static MetricSnapshot createEscapedMetricSnapshot(
     }
   }
 
-  /** Escapes the given metric names and labels with the given escaping scheme. */
-  public static MetricSnapshot escapeMetricSnapshot(MetricSnapshot v, EscapingScheme scheme) {
-    if (v == null) {
-      return null;
-    }
-
-    if (scheme == EscapingScheme.NO_ESCAPING) {
-      return v;
-    }
-
-    List<DataPointSnapshot> outDataPoints = new ArrayList<>();
-
-    for (DataPointSnapshot d : v.getDataPoints()) {
-      if (!snapshotNeedsEscaping(d, scheme)) {
-        outDataPoints.add(d);
-        continue;
-      }
-
-      DataPointSnapshot outDataPointSnapshot =
-          createEscapedDataPointSnapshot(v, d, escapeLabels(d.getLabels(), scheme), scheme);
-      outDataPoints.add(outDataPointSnapshot);
-    }
-
-    return createEscapedMetricSnapshot(
-        v, escapeName(v.getMetadata().getName(), scheme), outDataPoints);
-  }
-
   private static Labels escapeLabels(Labels labels, EscapingScheme scheme) {
     Labels.Builder outLabelsBuilder = Labels.builder();