Refactor name validation scheme config

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

Author: fedetorres93

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

@@ -0,0 +1,43 @@
+package io.prometheus.metrics.config;
+
+import java.util.Map;
+
+public class NamingProperties {
+
+    private static final String VALIDATION_SCHEME = "validationScheme";
+    private final String validationScheme;
+
+    private NamingProperties(String validation) {
+        this.validationScheme = validation;
+    }
+
+    public String getValidationScheme() {
+        return validationScheme;
+    }
+
+    static NamingProperties load(String prefix, Map<Object, Object> properties) throws PrometheusPropertiesException {
+        String validationScheme = Util.loadString(prefix + "." + VALIDATION_SCHEME, properties);
+        return new NamingProperties(validationScheme);
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public static class Builder {
+
+            private String validationScheme;
+
+            private Builder() {}
+
+            public Builder validation(String validationScheme) {
+                this.validationScheme = validationScheme;
+                return this;
+            }
+
+            public NamingProperties build() {
+                return new NamingProperties(validationScheme);
+            }
+    }
+
+}

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

@@ -19,6 +19,7 @@ public class PrometheusProperties {
     private final ExporterFilterProperties exporterFilterProperties;
     private final ExporterHttpServerProperties exporterHttpServerProperties;
     private final ExporterOpenTelemetryProperties exporterOpenTelemetryProperties;
+    private final NamingProperties namingProperties;
 
     /**
      * Get the properties instance. When called for the first time, {@code get()} loads the properties from the following locations:
@@ -39,14 +40,16 @@ public PrometheusProperties(
             ExporterProperties exporterProperties,
             ExporterFilterProperties exporterFilterProperties,
             ExporterHttpServerProperties httpServerConfig,
-            ExporterOpenTelemetryProperties otelConfig) {
+            ExporterOpenTelemetryProperties otelConfig,
+            NamingProperties namingProperties) {
         this.defaultMetricsProperties = defaultMetricsProperties;
         this.metricProperties.putAll(metricProperties);
         this.exemplarProperties = exemplarProperties;
         this.exporterProperties = exporterProperties;
         this.exporterFilterProperties = exporterFilterProperties;
         this.exporterHttpServerProperties = httpServerConfig;
         this.exporterOpenTelemetryProperties = otelConfig;
+        this.namingProperties = namingProperties;
     }
 
     /**
@@ -83,4 +86,8 @@ public ExporterHttpServerProperties getExporterHttpServerProperties() {
     public ExporterOpenTelemetryProperties getExporterOpenTelemetryProperties() {
         return exporterOpenTelemetryProperties;
     }
+
+    public NamingProperties getNamingProperties() {
+        return namingProperties;
+    }
 }

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

@@ -33,8 +33,9 @@ public static PrometheusProperties load() throws PrometheusPropertiesException {
         ExporterFilterProperties exporterFilterProperties = ExporterFilterProperties.load("io.prometheus.exporter.filter", properties);
         ExporterHttpServerProperties exporterHttpServerProperties = ExporterHttpServerProperties.load("io.prometheus.exporter.httpServer", properties);
         ExporterOpenTelemetryProperties exporterOpenTelemetryProperties = ExporterOpenTelemetryProperties.load("io.prometheus.exporter.opentelemetry", properties);
+        NamingProperties namingProperties = NamingProperties.load("io.prometheus.naming", properties);
         validateAllPropertiesProcessed(properties);
-        return new PrometheusProperties(defaultMetricsProperties, metricsConfigs, exemplarConfig, exporterProperties, exporterFilterProperties, exporterHttpServerProperties, exporterOpenTelemetryProperties);
+        return new PrometheusProperties(defaultMetricsProperties, metricsConfigs, exemplarConfig, exporterProperties, exporterFilterProperties, exporterHttpServerProperties, exporterOpenTelemetryProperties, namingProperties);
     }
 
     // This will remove entries from properties when they are processed.

prometheus-metrics-model/pom.xml

@@ -37,6 +37,12 @@
     </developers>
 
     <dependencies>
+        <dependency>
+            <groupId>io.prometheus</groupId>
+            <artifactId>prometheus-metrics-config</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
         <!-- test dependencies -->
         <dependency>
             <groupId>junit</groupId>

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

@@ -1,5 +1,7 @@
 package io.prometheus.metrics.model.snapshots;
 
+import io.prometheus.metrics.config.PrometheusProperties;
+
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
@@ -16,7 +18,7 @@
  * in Prometheus exposition formats. However, if metrics are exposed in OpenTelemetry format the dots are retained.
  */
 public class PrometheusNaming {
-    public static ValidationScheme nameValidationScheme = ValidationScheme.LEGACY_VALIDATION;
+    public static ValidationScheme nameValidationScheme = initValidationScheme();
 
     public static EscapingScheme nameEscapingScheme = EscapingScheme.VALUE_ENCODING_ESCAPING;
 
@@ -81,6 +83,16 @@ public static boolean isValidMetricName(String name) {
         return validateMetricName(name) == null;
     }
 
+    static ValidationScheme initValidationScheme() {
+        if (PrometheusProperties.get() != null && PrometheusProperties.get().getNamingProperties() != null) {
+            String validationScheme = PrometheusProperties.get().getNamingProperties().getValidationScheme();
+            if (validationScheme != null && validationScheme.equals("utf-8")) {
+                return ValidationScheme.UTF_8_VALIDATION;
+            }
+        }
+        return ValidationScheme.LEGACY_VALIDATION;
+    }
+
     static String validateMetricName(String name) {
         switch (nameValidationScheme) {
             case LEGACY_VALIDATION:
@@ -488,7 +500,6 @@ static String escapeName(String name, EscapingScheme scheme) {
                     } else if (!isValidUTF8Char(c)) {
                         escaped.append("_FFFD_");
                     } else if (c < 0x100) {
-                        // TODO Check if this is ok
                         escaped.append('_');
                         for (int s = 4; s >= 0; s -= 4) {
                             escaped.append(LOWERHEX.charAt((c >> s) & 0xF));
@@ -523,7 +534,6 @@ static String unescapeName(String name, EscapingScheme scheme) {
                 name = name.replaceAll("__", "_");
                 return name;
             case VALUE_ENCODING_ESCAPING:
-                // TODO Check if this is ok
                 Matcher matcher = Pattern.compile("U__").matcher(name);
                 if (matcher.find()) {
                     String escapedName = name.substring(matcher.end());

prometheus-metrics-model/src/test/resources/prometheus.properties

@@ -0,0 +1 @@
+io.prometheus.naming.validationScheme=legacy