Add escaping scheme to ExporterPushgatewayProperties

Signed-off-by: Federico Torres <[email protected]>

Author: fedetorres93

prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterPushgatewayProperties.java

@@ -7,15 +7,18 @@ public class ExporterPushgatewayProperties {
   private static final String ADDRESS = "address";
   private static final String JOB = "job";
   private static final String SCHEME = "scheme";
+  private static final String ESCAPING_SCHEME = "escapingScheme";
   private static final String PREFIX = "io.prometheus.exporter.pushgateway";
   private final String scheme;
   private final String address;
   private final String job;
+  private final String escapingScheme;
 
-  private ExporterPushgatewayProperties(String address, String job, String scheme) {
+  private ExporterPushgatewayProperties(String address, String job, String scheme, String escapingScheme) {
     this.address = address;
     this.job = job;
     this.scheme = scheme;
+    this.escapingScheme = escapingScheme;
   }
 
   /** Address of the Pushgateway in the form {@code host:port}. Default is {@code localhost:9091} */
@@ -39,6 +42,14 @@ public String getScheme() {
     return scheme;
   }
 
+  /**
+   * Escaping scheme to be used when pushing metric data to the pushgateway.
+   * Valid values: "no-escaping", "values", "underscores", "dots". Default is "no-escaping".
+   */
+  public String getEscapingScheme() {
+    return escapingScheme;
+  }
+
   /**
    * Note that this will remove entries from {@code properties}. This is because we want to know if
    * there are unused properties remaining after all properties have been loaded.
@@ -48,6 +59,8 @@ static ExporterPushgatewayProperties load(Map<Object, Object> properties)
     String address = Util.loadString(PREFIX + "." + ADDRESS, properties);
     String job = Util.loadString(PREFIX + "." + JOB, properties);
     String scheme = Util.loadString(PREFIX + "." + SCHEME, properties);
+    String escapingScheme = Util.loadString(PREFIX + "." + ESCAPING_SCHEME, properties);
+    
     if (scheme != null) {
       if (!scheme.equals("http") && !scheme.equals("https")) {
         throw new PrometheusPropertiesException(
@@ -56,6 +69,17 @@ static ExporterPushgatewayProperties load(Map<Object, Object> properties)
                 PREFIX, SCHEME, scheme));
       }
     }
-    return new ExporterPushgatewayProperties(address, job, scheme);
+    
+    if (escapingScheme != null) {
+      if (!escapingScheme.equals("no-escaping") && !escapingScheme.equals("values") 
+          && !escapingScheme.equals("underscores") && !escapingScheme.equals("dots")) {
+        throw new PrometheusPropertiesException(
+            String.format(
+                "%s.%s: Illegal value. Expecting 'no-escaping', 'values', 'underscores', or 'dots'. Found: %s",
+                PREFIX, ESCAPING_SCHEME, escapingScheme));
+      }
+    }
+    
+    return new ExporterPushgatewayProperties(address, job, scheme, escapingScheme);
   }
 }

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

@@ -87,19 +87,22 @@ public class PushGateway {
   private final Map<String, String> requestHeaders;
   private final PrometheusRegistry registry;
   private final HttpConnectionFactory connectionFactory;
+  private final EscapingScheme escapingScheme;
 
   private PushGateway(
       PrometheusRegistry registry,
       Format format,
       URL url,
       HttpConnectionFactory connectionFactory,
       Map<String, String> requestHeaders,
-      boolean prometheusTimestampsInMs) {
+      boolean prometheusTimestampsInMs,
+      EscapingScheme escapingScheme) {
     this.registry = registry;
     this.url = url;
     this.requestHeaders = Collections.unmodifiableMap(new HashMap<>(requestHeaders));
     this.connectionFactory = connectionFactory;
     this.prometheusTimestampsInMs = prometheusTimestampsInMs;
+    this.escapingScheme = escapingScheme;
     writer = getWriter(format);
     if (!writer.isAvailable()) {
       throw new RuntimeException(writer.getClass() + " is not available");
@@ -209,7 +212,7 @@ private void doRequest(PrometheusRegistry registry, String method) throws IOExce
       try {
         if (!method.equals("DELETE")) {
           OutputStream outputStream = connection.getOutputStream();
-          writer.write(outputStream, registry.scrape(), EscapingScheme.NO_ESCAPING);
+          writer.write(outputStream, registry.scrape(), this.escapingScheme);
           outputStream.flush();
           outputStream.close();
         }
@@ -435,6 +438,20 @@ private String getJob(ExporterPushgatewayProperties properties) {
       }
     }
 
+    private EscapingScheme getEscapingScheme(ExporterPushgatewayProperties properties) {
+      if (properties != null && properties.getEscapingScheme() != null) {
+        String scheme = properties.getEscapingScheme();
+        switch (scheme) {
+          case "no-escaping": return EscapingScheme.NO_ESCAPING;
+          case "values": return EscapingScheme.VALUE_ENCODING_ESCAPING;
+          case "underscores": return EscapingScheme.UNDERSCORE_ESCAPING;
+          case "dots": return EscapingScheme.DOTS_ESCAPING;
+          default: return EscapingScheme.NO_ESCAPING;
+        }
+      }
+      return EscapingScheme.NO_ESCAPING;
+    }
+
     private Format getFormat() {
       // currently not configurable via properties
       if (this.format != null) {
@@ -483,7 +500,8 @@ public PushGateway build() {
             makeUrl(properties),
             connectionFactory,
             requestHeaders,
-            getPrometheusTimestampsInMs());
+            getPrometheusTimestampsInMs(),
+            getEscapingScheme(properties));
       } catch (MalformedURLException e) {
         throw new PrometheusPropertiesException(
             address + ": Invalid address. Expecting <host>:<port>");

prometheus-metrics-exporter-pushgateway/src/test/java/io/prometheus/metrics/exporter/pushgateway/PushGatewayTest.java

@@ -8,12 +8,16 @@
 import static org.mockserver.model.HttpRequest.request;
 import static org.mockserver.model.HttpResponse.response;
 
+import io.prometheus.metrics.config.PrometheusProperties;
+import io.prometheus.metrics.config.PrometheusPropertiesLoader;
 import io.prometheus.metrics.core.metrics.Gauge;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
+import io.prometheus.metrics.model.snapshots.EscapingScheme;
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.net.InetAddress;
 import java.net.URL;
+import java.util.Properties;
 
 import io.prometheus.metrics.model.snapshots.PrometheusNaming;
 import io.prometheus.metrics.model.snapshots.ValidationScheme;
@@ -448,4 +452,18 @@ public void testInstanceIpEscapedGroupingKey() throws IOException {
       pg.delete();
     }
   }
+
+  @Test 
+  public void testEscapingSchemeDefaultValue() throws IllegalAccessException, NoSuchFieldException {
+    PushGateway pg = PushGateway.builder()
+      .address("localhost:" + mockServerClient.getPort())
+      .job("test")
+      .build();
+    
+    Field escapingSchemeField = pg.getClass().getDeclaredField("escapingScheme");
+    escapingSchemeField.setAccessible(true);
+    EscapingScheme scheme = (EscapingScheme) escapingSchemeField.get(pg);
+    
+    assertThat(scheme).isEqualTo(EscapingScheme.NO_ESCAPING);
+  }
 }