Skip to content

Sanitize metric names for the Prometheus client #4866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 22, 2024
+56 −31
Merged

Sanitize metric names for the Prometheus client #4866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93056ac
Sanitize metric names for the Prometheus client
jonatan-ivanov Mar 20, 2024
fda1f18
Use PrometheusNaming in PrometheusNamingConvention
jonatan-ivanov Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions ...try-prometheus/src/main/java/io/micrometer/prometheusmetrics/PrometheusMeterRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import io.prometheus.metrics.model.snapshots.CounterSnapshot.CounterDataPointSnapshot;
import io.prometheus.metrics.model.snapshots.GaugeSnapshot.GaugeDataPointSnapshot;
import io.prometheus.metrics.model.snapshots.HistogramSnapshot.HistogramDataPointSnapshot;
import io.prometheus.metrics.model.snapshots.InfoSnapshot.InfoDataPointSnapshot;
import io.prometheus.metrics.model.snapshots.SummarySnapshot.SummaryDataPointSnapshot;

import java.io.ByteArrayOutputStream;
Expand Down Expand Up @@ -310,10 +311,20 @@ protected <T> io.micrometer.core.instrument.Gauge newGauge(Meter.Id id, @Nullabl
Gauge gauge = new DefaultGauge<>(id, obj, valueFunction);
applyToCollector(id, (collector) -> {
List<String> tagValues = tagValues(id);
collector.add(tagValues,
(conventionName, tagKeys) -> Stream.of(new MicrometerCollector.Family<>(conventionName,
family -> new GaugeSnapshot(family.metadata, family.dataPointSnapshots), getMetadata(id),
new GaugeDataPointSnapshot(gauge.value(), Labels.of(tagKeys, tagValues), null))));
if (id.getName().endsWith(".info")) {
collector
.add(tagValues,
(conventionName, tagKeys) -> Stream.of(new MicrometerCollector.Family<>(conventionName,
family -> new InfoSnapshot(family.metadata, family.dataPointSnapshots),
getMetadata(id), new InfoDataPointSnapshot(Labels.of(tagKeys, tagValues)))));
}
else {
collector.add(tagValues,
(conventionName, tagKeys) -> Stream.of(new MicrometerCollector.Family<>(conventionName,
family -> new GaugeSnapshot(family.metadata, family.dataPointSnapshots),
getMetadata(id),
new GaugeDataPointSnapshot(gauge.value(), Labels.of(tagKeys, tagValues), null))));
}
});
return gauge;
}
Expand Down
24 changes: 3 additions & 21 deletions ...-prometheus/src/main/java/io/micrometer/prometheusmetrics/PrometheusNamingConvention.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
import io.micrometer.common.lang.Nullable;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.config.NamingConvention;

import java.util.regex.Pattern;
import io.prometheus.metrics.model.snapshots.PrometheusNaming;

/**
* See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels for a
Expand All @@ -29,10 +28,6 @@
*/
public class PrometheusNamingConvention implements NamingConvention {

private static final Pattern nameChars = Pattern.compile("[^a-zA-Z0-9_:]");

private static final Pattern tagKeyChars = Pattern.compile("[^a-zA-Z0-9_]");

private final String timerSuffix;

public PrometheusNamingConvention() {
Expand All @@ -45,9 +40,6 @@ public PrometheusNamingConvention(String timerSuffix) {

/**
* Names are snake-cased. They contain a base unit suffix when applicable.
* <p>
* Names may contain ASCII letters and digits, as well as underscores and colons. They
* must match the regex [a-zA-Z_:][a-zA-Z0-9_:]*
*/
@Override
public String name(String name, Meter.Type type, @Nullable String baseUnit) {
Expand Down Expand Up @@ -81,11 +73,7 @@ else if (!conventionName.endsWith("_seconds")) {
break;
}

String sanitized = nameChars.matcher(conventionName).replaceAll("_");
if (!Character.isLetter(sanitized.charAt(0))) {
sanitized = "m_" + sanitized;
}
return sanitized;
return PrometheusNaming.sanitizeMetricName(conventionName);
}

/**
Expand All @@ -95,13 +83,7 @@ else if (!conventionName.endsWith("_seconds")) {
*/
@Override
public String tagKey(String key) {
String conventionKey = NamingConvention.snakeCase.tagKey(key);

String sanitized = tagKeyChars.matcher(conventionKey).replaceAll("_");
if (!Character.isLetter(sanitized.charAt(0))) {
sanitized = "m_" + sanitized;
}
return sanitized;
return PrometheusNaming.sanitizeLabelName(key);
}

}
40 changes: 36 additions & 4 deletions ...prometheus/src/test/java/io/micrometer/prometheusmetrics/PrometheusMeterRegistryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,12 @@
package io.micrometer.prometheusmetrics;

import io.micrometer.core.Issue;
import io.micrometer.core.instrument.Timer;
import io.micrometer.core.instrument.*;
import io.micrometer.core.instrument.binder.BaseUnits;
import io.micrometer.core.instrument.binder.jvm.JvmInfoMetrics;
import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
import io.micrometer.core.instrument.distribution.DistributionStatisticConfig;
import io.micrometer.core.instrument.distribution.HistogramSnapshot;
import io.micrometer.prometheusmetrics.PrometheusConfig;
import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
import io.prometheus.metrics.model.registry.PrometheusRegistry;
import io.prometheus.metrics.model.snapshots.*;
import io.prometheus.metrics.tracer.common.SpanContext;
Expand All @@ -32,7 +30,10 @@
import org.junit.jupiter.api.Test;

import java.time.Duration;
import java.util.*;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.concurrent.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
Expand Down Expand Up @@ -103,6 +104,37 @@ void quantiles() {
assertThat(prometheusRegistry.scrape()).has(withNameAndQuantile("ds"));
}

@Test
void invalidMeterNameSuffixesShouldBeRemovedForMetadata() {
new JvmInfoMetrics().bindTo(registry);
Gauge.builder("test1.info", () -> 1).register(registry);
Counter.builder("test2.total").register(registry).increment(2);
Gauge.builder("test3.created", () -> 3).register(registry);
Counter.builder("test4.bucket").register(registry).increment(4);

Counter.builder("test5.info").register(registry).increment(5);
Gauge.builder("test6.total", () -> 6).register(registry);

String scrapeResult = registry.scrape();

assertThat(scrapeResult).contains("# HELP test1_info")
.contains("# TYPE test1_info gauge")
.contains("test1_info 1");
assertThat(scrapeResult).contains("# HELP test2_total")
.contains("# TYPE test2_total counter")
.contains("test2_total 2.0");
assertThat(scrapeResult).contains("# HELP jvm_info").contains("# TYPE jvm_info gauge").contains("jvm_info{");
assertThat(scrapeResult).contains("# HELP test3").contains("# TYPE test3 gauge").contains("test3 3");
assertThat(scrapeResult).contains("# HELP test4_total")
.contains("# TYPE test4_total counter")
.contains("test4_total 4.0");

assertThat(scrapeResult).contains("# HELP test5_total")
.contains("# TYPE test5_total counter")
.contains("test5_total 5.0");
assertThat(scrapeResult).contains("# HELP test6").contains("# TYPE test6 gauge").contains("test6 6");
}

@Issue("#27")
@DisplayName("custom distribution summaries respect varying tags")
@Test
Expand Down
4 changes: 2 additions & 2 deletions ...metheus/src/test/java/io/micrometer/prometheusmetrics/PrometheusNamingConventionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ class PrometheusNamingConventionTest {

@Test
void formatName() {
assertThat(convention.name("123abc/{:id}水", Meter.Type.GAUGE)).startsWith("m_123abc__:id__");
assertThat(convention.name("123abc/{:id}水", Meter.Type.GAUGE)).startsWith("_23abc__:id__");
}

@Test
void formatTagKey() {
assertThat(convention.tagKey("123abc/{:id}水")).startsWith("m_123abc___id__");
assertThat(convention.tagKey("123abc/{:id}水")).startsWith("_23abc___id__");
}

@Test
Expand Down