rename escaping scheme value for no escaping

zeitlinger · zeitlinger · commit ae009cf058c0 · 2025-08-14T16:46:49.000+02:00
Signed-off-by: Gregor Zeitlinger &lt;gregor.zeitlinger@grafana.com&gt;
diff --git a/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/TextFormatUtilBenchmark.java b/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/TextFormatUtilBenchmark.java
@@ -71,14 +71,14 @@ public OutputStream openMetricsWriteToByteArray(WriterState writerState) throws
     ByteArrayOutputStream byteArrayOutputStream = writerState.byteArrayOutputStream;
     byteArrayOutputStream.reset();
     OPEN_METRICS_TEXT_FORMAT_WRITER.write(
-        byteArrayOutputStream, SNAPSHOTS, EscapingScheme.NO_ESCAPING);
+        byteArrayOutputStream, SNAPSHOTS, EscapingScheme.ALLOW_UTF8);
     return byteArrayOutputStream;
   }
 
   @Benchmark
   public OutputStream openMetricsWriteToNull() throws IOException {
     OutputStream nullOutputStream = NullOutputStream.INSTANCE;
-    OPEN_METRICS_TEXT_FORMAT_WRITER.write(nullOutputStream, SNAPSHOTS, EscapingScheme.NO_ESCAPING);
+    OPEN_METRICS_TEXT_FORMAT_WRITER.write(nullOutputStream, SNAPSHOTS, EscapingScheme.ALLOW_UTF8);
     return nullOutputStream;
   }
 
@@ -88,14 +88,14 @@ public OutputStream prometheusWriteToByteArray(WriterState writerState) throws I
     ByteArrayOutputStream byteArrayOutputStream = writerState.byteArrayOutputStream;
     byteArrayOutputStream.reset();
     PROMETHEUS_TEXT_FORMAT_WRITER.write(
-        byteArrayOutputStream, SNAPSHOTS, EscapingScheme.NO_ESCAPING);
+        byteArrayOutputStream, SNAPSHOTS, EscapingScheme.ALLOW_UTF8);
     return byteArrayOutputStream;
   }
 
   @Benchmark
   public OutputStream prometheusWriteToNull() throws IOException {
     OutputStream nullOutputStream = NullOutputStream.INSTANCE;
-    PROMETHEUS_TEXT_FORMAT_WRITER.write(nullOutputStream, SNAPSHOTS, EscapingScheme.NO_ESCAPING);
+    PROMETHEUS_TEXT_FORMAT_WRITER.write(nullOutputStream, SNAPSHOTS, EscapingScheme.ALLOW_UTF8);
     return nullOutputStream;
   }
 
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/EscapingScheme.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/EscapingScheme.java
@@ -4,7 +4,7 @@
 
 public enum EscapingScheme {
   /** NO_ESCAPING indicates that a name will not be escaped. */
-  NO_ESCAPING("allow-utf-8"),
+  ALLOW_UTF8("allow-utf-8"),
 
   /** UNDERSCORE_ESCAPING replaces all legacy-invalid characters with underscores. */
   UNDERSCORE_ESCAPING("underscores"),
@@ -67,7 +67,7 @@ public static EscapingScheme fromAcceptHeader(@Nullable String acceptHeader) {
   static EscapingScheme forString(String value) {
     switch (value) {
       case "allow-utf-8":
-        return NO_ESCAPING;
+        return ALLOW_UTF8;
       case "underscores":
         return UNDERSCORE_ESCAPING;
       case "dots":
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterPushgatewayProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterPushgatewayProperties.java
@@ -86,7 +86,7 @@ static ExporterPushgatewayProperties load(Map<Object, Object> properties)
     }
     switch (scheme) {
       case "allow-utf-8":
-        return EscapingScheme.NO_ESCAPING;
+        return EscapingScheme.ALLOW_UTF8;
       case "values":
         return EscapingScheme.VALUE_ENCODING_ESCAPING;
       case "underscores":
diff --git a/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/EscapingSchemeTest.java b/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/EscapingSchemeTest.java
@@ -9,7 +9,7 @@ class EscapingSchemeTest {
 
   @Test
   void forString() {
-    assertThat(EscapingScheme.forString("allow-utf-8")).isEqualTo(EscapingScheme.NO_ESCAPING);
+    assertThat(EscapingScheme.forString("allow-utf-8")).isEqualTo(EscapingScheme.ALLOW_UTF8);
     assertThat(EscapingScheme.forString("underscores"))
         .isEqualTo(EscapingScheme.UNDERSCORE_ESCAPING);
     assertThat(EscapingScheme.forString("dots")).isEqualTo(EscapingScheme.DOTS_ESCAPING);
@@ -22,7 +22,7 @@ void forString() {
   @Test
   void fromAcceptHeader() {
     assertThat(EscapingScheme.fromAcceptHeader("application/json; escaping=allow-utf-8"))
-        .isEqualTo(EscapingScheme.NO_ESCAPING);
+        .isEqualTo(EscapingScheme.ALLOW_UTF8);
     assertThat(EscapingScheme.fromAcceptHeader("application/json; escaping=underscores"))
         .isEqualTo(EscapingScheme.UNDERSCORE_ESCAPING);
     assertThat(EscapingScheme.fromAcceptHeader("application/json; escaping=dots"))
diff --git a/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/CounterTest.java b/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/CounterTest.java
@@ -118,7 +118,7 @@ public void testLabels() {
   public void testTotalStrippedFromName(String name) {
     Counter counter = Counter.builder().name(name).unit(Unit.SECONDS).build();
     Metrics.MetricFamily protobufData =
-        new PrometheusProtobufWriterImpl().convert(counter.collect(), EscapingScheme.NO_ESCAPING);
+        new PrometheusProtobufWriterImpl().convert(counter.collect(), EscapingScheme.ALLOW_UTF8);
     assertThat(ProtobufUtil.shortDebugString(protobufData))
         .isEqualTo(
             "name: \"my_counter_seconds_total\" type: COUNTER metric { counter { value: 0.0 } }");
diff --git a/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/HistogramTest.java b/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/HistogramTest.java
@@ -88,7 +88,7 @@ private void run() throws NoSuchFieldException, IllegalAccessException {
       }
       Metrics.MetricFamily protobufData =
           new PrometheusProtobufWriterImpl()
-              .convert(histogram.collect(), EscapingScheme.NO_ESCAPING);
+              .convert(histogram.collect(), EscapingScheme.ALLOW_UTF8);
       String expectedWithMetadata =
           "name: \"test\" type: HISTOGRAM metric { histogram { " + expected + " } }";
       assertThat(ProtobufUtil.shortDebugString(protobufData))
@@ -944,13 +944,13 @@ public void testDefaults() throws IOException {
 
     // protobuf
     Metrics.MetricFamily protobufData =
-        new PrometheusProtobufWriterImpl().convert(snapshot, EscapingScheme.NO_ESCAPING);
+        new PrometheusProtobufWriterImpl().convert(snapshot, EscapingScheme.ALLOW_UTF8);
     assertThat(ProtobufUtil.shortDebugString(protobufData)).isEqualTo(expectedProtobuf);
 
     // text
     ByteArrayOutputStream out = new ByteArrayOutputStream();
     OpenMetricsTextFormatWriter writer = new OpenMetricsTextFormatWriter(false, true);
-    writer.write(out, MetricSnapshots.of(snapshot), EscapingScheme.NO_ESCAPING);
+    writer.write(out, MetricSnapshots.of(snapshot), EscapingScheme.ALLOW_UTF8);
     assertThat(out).hasToString(expectedTextFormat);
   }
 
diff --git a/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/InfoTest.java b/prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/InfoTest.java
@@ -26,7 +26,7 @@ public void testInfoStrippedFromName(String name) {
     Info info = Info.builder().name(name).labelNames("my.key").build();
     info.addLabelValues("value");
     Metrics.MetricFamily protobufData =
-        new PrometheusProtobufWriterImpl().convert(info.collect(), EscapingScheme.NO_ESCAPING);
+        new PrometheusProtobufWriterImpl().convert(info.collect(), EscapingScheme.ALLOW_UTF8);
     assertThat(ProtobufUtil.shortDebugString(protobufData))
         .isEqualTo(
             "name: \"jvm.runtime_info\" type: GAUGE metric { label { name: \"my.key\" value:"
diff --git a/prometheus-metrics-exporter-pushgateway/src/test/java/io/prometheus/metrics/exporter/pushgateway/PushGatewayTest.java b/prometheus-metrics-exporter-pushgateway/src/test/java/io/prometheus/metrics/exporter/pushgateway/PushGatewayTest.java
@@ -427,6 +427,6 @@ public void testEscapingSchemeDefaultValue() throws IllegalAccessException, NoSu
     escapingSchemeField.setAccessible(true);
     EscapingScheme scheme = (EscapingScheme) escapingSchemeField.get(pg);
 
-    assertThat(scheme).isEqualTo(EscapingScheme.NO_ESCAPING);
+    assertThat(scheme).isEqualTo(EscapingScheme.UNDERSCORE_ESCAPING);
   }
 }
diff --git a/prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatWriterTest.java b/prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatWriterTest.java
@@ -16,7 +16,7 @@ class ExpositionFormatWriterTest {
   void write() throws IOException {
     MetricSnapshots snapshots = new MetricSnapshots();
     ByteArrayOutputStream out = new ByteArrayOutputStream();
-    writer.write(out, snapshots, EscapingScheme.NO_ESCAPING);
+    writer.write(out, snapshots, EscapingScheme.ALLOW_UTF8);
     assertThat(out).hasToString("# EOF\n");
 
     out.reset();
@@ -26,7 +26,7 @@ void write() throws IOException {
 
   @Test
   void toDebugString() {
-    assertThat(writer.toDebugString(new MetricSnapshots(), EscapingScheme.NO_ESCAPING))
+    assertThat(writer.toDebugString(new MetricSnapshots(), EscapingScheme.ALLOW_UTF8))
         .isEqualTo("# EOF\n");
     assertThat(writer.toDebugString(new MetricSnapshots())).isEqualTo("# EOF\n");
   }
diff --git a/prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatsTest.java b/prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/ExpositionFormatsTest.java
@@ -499,7 +499,7 @@ public void testGaugeUTF8() throws IOException {
             .build();
     ByteArrayOutputStream out = new ByteArrayOutputStream();
     getPrometheusWriter(PrometheusTextFormatWriter.builder().setIncludeCreatedTimestamps(true))
-        .write(out, MetricSnapshots.of((MetricSnapshot) gauge), EscapingScheme.NO_ESCAPING);
+        .write(out, MetricSnapshots.of((MetricSnapshot) gauge), EscapingScheme.ALLOW_UTF8);
     assertThat(out).hasToString(prometheusText);
   }
 
diff --git a/prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/PrometheusProtobufWriterTest.java b/prometheus-metrics-exposition-textformats/src/test/java/io/prometheus/metrics/expositionformats/PrometheusProtobufWriterTest.java
@@ -25,13 +25,13 @@ void getContentType() {
 
   @Test
   void write() {
-    assertThatCode(() -> writer.write(null, null, EscapingScheme.NO_ESCAPING))
+    assertThatCode(() -> writer.write(null, null, EscapingScheme.ALLOW_UTF8))
         .isInstanceOf(UnsupportedOperationException.class);
   }
 
   @Test
   void toDebugString() {
-    assertThatCode(() -> writer.toDebugString(null, EscapingScheme.NO_ESCAPING))
+    assertThatCode(() -> writer.toDebugString(null, EscapingScheme.ALLOW_UTF8))
         .isInstanceOf(UnsupportedOperationException.class);
   }
 }
diff --git a/prometheus-metrics-instrumentation-caffeine/src/test/java/io/prometheus/metrics/instrumentation/caffeine/CacheMetricsCollectorTest.java b/prometheus-metrics-instrumentation-caffeine/src/test/java/io/prometheus/metrics/instrumentation/caffeine/CacheMetricsCollectorTest.java
@@ -312,7 +312,7 @@ private String convertToOpenMetricsFormat(PrometheusRegistry registry) {
     final ByteArrayOutputStream out = new ByteArrayOutputStream();
     final OpenMetricsTextFormatWriter writer = new OpenMetricsTextFormatWriter(true, true);
     try {
-      writer.write(out, registry.scrape(), EscapingScheme.NO_ESCAPING);
+      writer.write(out, registry.scrape(), EscapingScheme.ALLOW_UTF8);
       return out.toString(StandardCharsets.UTF_8.name());
     } catch (IOException e) {
       throw new UncheckedIOException(e);
diff --git a/prometheus-metrics-instrumentation-guava/src/test/java/io/prometheus/metrics/instrumentation/guava/CacheMetricsCollectorTest.java b/prometheus-metrics-instrumentation-guava/src/test/java/io/prometheus/metrics/instrumentation/guava/CacheMetricsCollectorTest.java
@@ -162,7 +162,7 @@ private String convertToOpenMetricsFormat(PrometheusRegistry registry) {
     final ByteArrayOutputStream out = new ByteArrayOutputStream();
     final OpenMetricsTextFormatWriter writer = new OpenMetricsTextFormatWriter(true, true);
     try {
-      writer.write(out, registry.scrape(), EscapingScheme.NO_ESCAPING);
+      writer.write(out, registry.scrape(), EscapingScheme.ALLOW_UTF8);
       return out.toString(StandardCharsets.UTF_8);
     } catch (IOException e) {
       throw new UncheckedIOException(e);
diff --git a/prometheus-metrics-instrumentation-jvm/src/test/java/io/prometheus/metrics/instrumentation/jvm/TestUtil.java b/prometheus-metrics-instrumentation-jvm/src/test/java/io/prometheus/metrics/instrumentation/jvm/TestUtil.java
@@ -12,7 +12,7 @@ class TestUtil {
   static String convertToOpenMetricsFormat(MetricSnapshots snapshots) throws IOException {
     ByteArrayOutputStream out = new ByteArrayOutputStream();
     OpenMetricsTextFormatWriter writer = new OpenMetricsTextFormatWriter(true, true);
-    writer.write(out, snapshots, EscapingScheme.NO_ESCAPING);
+    writer.write(out, snapshots, EscapingScheme.ALLOW_UTF8);
     return out.toString(StandardCharsets.UTF_8);
   }
 }
diff --git a/prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/PrometheusNaming.java b/prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/PrometheusNaming.java
@@ -277,7 +277,7 @@ public static String escapeName(String name, EscapingScheme scheme) {
 
     StringBuilder escaped = new StringBuilder();
     switch (scheme) {
-      case NO_ESCAPING:
+      case ALLOW_UTF8:
         return name;
       case UNDERSCORE_ESCAPING:
         for (int i = 0; i < name.length(); ) {
diff --git a/prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/SnapshotEscaper.java b/prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/SnapshotEscaper.java
@@ -11,7 +11,7 @@ private SnapshotEscaper() {}
 
   /** Escapes the given metric names and labels with the given escaping scheme. */
   public static MetricSnapshot escapeMetricSnapshot(MetricSnapshot v, EscapingScheme scheme) {
-    if (scheme == EscapingScheme.NO_ESCAPING || scheme == EscapingScheme.UNDERSCORE_ESCAPING) {
+    if (scheme == EscapingScheme.ALLOW_UTF8 || scheme == EscapingScheme.UNDERSCORE_ESCAPING) {
       // we re-use the prometheus name for underscore escaping as an optimization
       return v;
     }
diff --git a/prometheus-metrics-model/src/test/java/io/prometheus/metrics/model/snapshots/SnapshotEscaperTest.java b/prometheus-metrics-model/src/test/java/io/prometheus/metrics/model/snapshots/SnapshotEscaperTest.java
@@ -134,7 +134,7 @@ private MetricSnapshot createTestSnapshot(
   @MethodSource("emptySnapshots")
   void escape(MetricSnapshot original) {
     assertThat(original)
-        .isSameAs(escapeMetricSnapshot(original, EscapingScheme.NO_ESCAPING))
+        .isSameAs(escapeMetricSnapshot(original, EscapingScheme.ALLOW_UTF8))
         .isSameAs(escapeMetricSnapshot(original, EscapingScheme.UNDERSCORE_ESCAPING));
     assertThat(escapeMetricSnapshot(original, EscapingScheme.VALUE_ENCODING_ESCAPING))
         .usingRecursiveComparison()
@@ -143,7 +143,7 @@ void escape(MetricSnapshot original) {
 
   @Test
   void escapeNull() {
-    assertThat(escapeMetricSnapshot(null, EscapingScheme.NO_ESCAPING)).isNull();
+    assertThat(escapeMetricSnapshot(null, EscapingScheme.ALLOW_UTF8)).isNull();
   }
 
   public static Stream<Arguments> emptySnapshots() {
@@ -204,7 +204,7 @@ public static Stream<Arguments> emptySnapshots() {
   @Test
   void metadataName() {
     MetricMetadata metadata = new MetricMetadata("test.");
-    assertThat(SnapshotEscaper.getMetadataName(metadata, EscapingScheme.NO_ESCAPING))
+    assertThat(SnapshotEscaper.getMetadataName(metadata, EscapingScheme.ALLOW_UTF8))
         .isEqualTo("test.");
     assertThat(SnapshotEscaper.getMetadataName(metadata, EscapingScheme.UNDERSCORE_ESCAPING))
         .isEqualTo("test_");
@@ -213,7 +213,7 @@ void metadataName() {
   @Test
   void snapshotLabelName() {
     Labels labels = Labels.builder().label("test.", "value").build();
-    assertThat(getSnapshotLabelName(labels, 0, EscapingScheme.NO_ESCAPING)).isEqualTo("test.");
+    assertThat(getSnapshotLabelName(labels, 0, EscapingScheme.ALLOW_UTF8)).isEqualTo("test.");
     assertThat(getSnapshotLabelName(labels, 0, EscapingScheme.UNDERSCORE_ESCAPING))
         .isEqualTo("test_");
   }
diff --git a/prometheus-metrics-simpleclient-bridge/src/test/java/io/prometheus/metrics/simpleclient/bridge/SimpleclientCollectorTest.java b/prometheus-metrics-simpleclient-bridge/src/test/java/io/prometheus/metrics/simpleclient/bridge/SimpleclientCollectorTest.java
@@ -267,7 +267,7 @@ private String origOpenMetrics() throws IOException {
   private String newOpenMetrics() throws IOException {
     ByteArrayOutputStream out = new ByteArrayOutputStream();
     OpenMetricsTextFormatWriter writer = new OpenMetricsTextFormatWriter(true, false);
-    writer.write(out, newRegistry.scrape(), EscapingScheme.NO_ESCAPING);
-    return out.toString(StandardCharsets.UTF_8.name());
+    writer.write(out, newRegistry.scrape(), EscapingScheme.ALLOW_UTF8);
+    return out.toString(StandardCharsets.UTF_8);
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ static ExporterPushgatewayProperties load(Map<Object, Object> properties)`
`86`	`86`	`}`
`87`	`87`	`switch (scheme) {`
`88`	`88`	`case "allow-utf-8":`
`89`		`- return EscapingScheme.NO_ESCAPING;`
	`89`	`+ return EscapingScheme.ALLOW_UTF8;`
`90`	`90`	`case "values":`
`91`	`91`	`return EscapingScheme.VALUE_ENCODING_ESCAPING;`
`92`	`92`	`case "underscores":`
Original file line number	Diff line number	Diff line change
`@@ -427,6 +427,6 @@ public void testEscapingSchemeDefaultValue() throws IllegalAccessException, NoSu`
`427`	`427`	`escapingSchemeField.setAccessible(true);`
`428`	`428`	`EscapingScheme scheme = (EscapingScheme) escapingSchemeField.get(pg);`
`429`	`429`
`430`		`- assertThat(scheme).isEqualTo(EscapingScheme.NO_ESCAPING);`
	`430`	`+ assertThat(scheme).isEqualTo(EscapingScheme.UNDERSCORE_ESCAPING);`
`431`	`431`	`}`
`432`	`432`	`}`
Original file line number	Diff line number	Diff line change
`@@ -499,7 +499,7 @@ public void testGaugeUTF8() throws IOException {`
`499`	`499`	`.build();`
`500`	`500`	`ByteArrayOutputStream out = new ByteArrayOutputStream();`
`501`	`501`	`getPrometheusWriter(PrometheusTextFormatWriter.builder().setIncludeCreatedTimestamps(true))`
`502`		`- .write(out, MetricSnapshots.of((MetricSnapshot) gauge), EscapingScheme.NO_ESCAPING);`
	`502`	`+ .write(out, MetricSnapshots.of((MetricSnapshot) gauge), EscapingScheme.ALLOW_UTF8);`
`503`	`503`	`assertThat(out).hasToString(prometheusText);`
`504`	`504`	`}`
`505`	`505`