Skip to content

Commit 0738a68

Browse files
committed
PrometheusNaming changes were incompatible - so deprecating instead
Signed-off-by: Gregor Zeitlinger <[email protected]>
1 parent c688296 commit 0738a68

File tree

27 files changed

+792
-424
lines changed

27 files changed

+792
-424
lines changed

examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/SampleMultiCollector.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import io.prometheus.metrics.model.snapshots.Labels;
88
import io.prometheus.metrics.model.snapshots.MetricSnapshot;
99
import io.prometheus.metrics.model.snapshots.MetricSnapshots;
10-
import io.prometheus.metrics.model.snapshots.PrometheusNaming;
10+
import io.prometheus.metrics.model.snapshots.PrometheusNames;
1111
import java.util.ArrayList;
1212
import java.util.Collection;
1313
import java.util.List;
@@ -34,7 +34,7 @@ protected MetricSnapshots collectMetricSnapshots(PrometheusScrapeRequest scrapeR
3434
gaugeBuilder.name("x_load").help("process load");
3535

3636
CounterSnapshot.Builder counterBuilder = CounterSnapshot.builder();
37-
counterBuilder.name(PrometheusNaming.sanitizeMetricName("x_calls_total")).help("invocations");
37+
counterBuilder.name(PrometheusNames.sanitizeMetricName("x_calls_total")).help("invocations");
3838

3939
String[] targetNames = scrapeRequest.getParameterValues("target");
4040
String targetName;

prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/Counter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ private Builder(PrometheusProperties properties) {
230230
* Prometheus.
231231
*
232232
* <p>Throws an {@link IllegalArgumentException} if {@link
233-
* io.prometheus.metrics.model.snapshots.PrometheusNaming#isValidMetricName(String)
233+
* io.prometheus.metrics.model.snapshots.PrometheusNames#isValidMetricName(String)
234234
* MetricMetadata.isValidMetricName(name)} is {@code false}.
235235
*/
236236
@Override

prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/CounterWithCallback.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ private Builder(PrometheusProperties properties) {
8888
* Prometheus.
8989
*
9090
* <p>Throws an {@link IllegalArgumentException} if {@link
91-
* io.prometheus.metrics.model.snapshots.PrometheusNaming#isValidMetricName(String)
91+
* io.prometheus.metrics.model.snapshots.PrometheusNames#isValidMetricName(String)
9292
* MetricMetadata.isValidMetricName(name)} is {@code false}.
9393
*/
9494
@Override

prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/Info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ private Builder(PrometheusProperties config) {
135135
* "runtime_info"} in Prometheus.
136136
*
137137
* <p>Throws an {@link IllegalArgumentException} if {@link
138-
* io.prometheus.metrics.model.snapshots.PrometheusNaming#isValidMetricName(String)
138+
* io.prometheus.metrics.model.snapshots.PrometheusNames#isValidMetricName(String)
139139
* MetricMetadata.isValidMetricName(name)} is {@code false}.
140140
*/
141141
@Override

prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/MetricWithFixedMetadata.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import io.prometheus.metrics.config.PrometheusProperties;
44
import io.prometheus.metrics.model.snapshots.Labels;
55
import io.prometheus.metrics.model.snapshots.MetricMetadata;
6-
import io.prometheus.metrics.model.snapshots.PrometheusNaming;
6+
import io.prometheus.metrics.model.snapshots.PrometheusNames;
77
import io.prometheus.metrics.model.snapshots.Unit;
88
import java.util.Arrays;
99
import java.util.List;
@@ -61,7 +61,7 @@ protected Builder(List<String> illegalLabelNames, PrometheusProperties propertie
6161
}
6262

6363
public B name(String name) {
64-
String error = PrometheusNaming.validateMetricName(name);
64+
String error = PrometheusNames.validateMetricName(name);
6565
if (error != null) {
6666
throw new IllegalArgumentException("'" + name + "': Illegal metric name: " + error);
6767
}
@@ -81,7 +81,7 @@ public B help(String help) {
8181

8282
public B labelNames(String... labelNames) {
8383
for (String labelName : labelNames) {
84-
if (!PrometheusNaming.isValidLabelName(labelName)) {
84+
if (!PrometheusNames.isValidLabelName(labelName)) {
8585
throw new IllegalArgumentException(labelName + ": illegal label name");
8686
}
8787
if (illegalLabelNames.contains(labelName)) {

prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/StateSet.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.prometheus.metrics.core.metrics;
22

3-
import static io.prometheus.metrics.model.snapshots.PrometheusNaming.prometheusName;
3+
import static io.prometheus.metrics.model.snapshots.PrometheusNames.prometheusName;
44

55
import io.prometheus.metrics.config.PrometheusProperties;
66
import io.prometheus.metrics.core.datapoints.StateSetDataPoint;

prometheus-metrics-core/src/test/java/io/prometheus/metrics/core/metrics/CallbackMetricTest.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
44

5+
import io.prometheus.metrics.expositionformats.ExpositionFormats;
6+
import io.prometheus.metrics.model.registry.PrometheusRegistry;
7+
import java.io.IOException;
58
import org.junit.jupiter.api.Test;
69

710
class CallbackMetricTest {
@@ -46,4 +49,15 @@ void makeLabels() {
4649
"Cannot pass label values to a CounterWithCallback that was created without label"
4750
+ " names.");
4851
}
52+
53+
@Test
54+
void manual() throws IOException {
55+
PrometheusRegistry prometheusRegistry = new PrometheusRegistry();
56+
Counter counter =
57+
Counter.builder().name("te:st").labelNames("test").register(prometheusRegistry);
58+
counter.labelValues("te:st").inc();
59+
ExpositionFormats.init()
60+
.getPrometheusTextFormatWriter()
61+
.write(System.out, prometheusRegistry.scrape());
62+
}
4963
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package io.prometheus.metrics.exporter.pushgateway;
22

33
import static io.prometheus.metrics.exporter.pushgateway.Scheme.HTTP;
4-
import static io.prometheus.metrics.model.snapshots.PrometheusNaming.escapeName;
4+
import static io.prometheus.metrics.model.snapshots.PrometheusNames.escapeName;
55
import static java.util.Objects.requireNonNull;
66

77
import io.prometheus.metrics.config.EscapingScheme;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import io.prometheus.metrics.model.snapshots.MetricMetadata;
2424
import io.prometheus.metrics.model.snapshots.MetricSnapshot;
2525
import io.prometheus.metrics.model.snapshots.MetricSnapshots;
26-
import io.prometheus.metrics.model.snapshots.PrometheusNaming;
26+
import io.prometheus.metrics.model.snapshots.PrometheusNames;
2727
import io.prometheus.metrics.model.snapshots.Quantile;
2828
import io.prometheus.metrics.model.snapshots.SnapshotEscaper;
2929
import io.prometheus.metrics.model.snapshots.StateSetSnapshot;
@@ -396,7 +396,7 @@ private void writeNameAndLabels(
396396
boolean metricInsideBraces = false;
397397
// If the name does not pass the legacy validity check, we must put the
398398
// metric name inside the braces.
399-
if (!PrometheusNaming.isValidLegacyMetricName(name)) {
399+
if (!PrometheusNames.isValidLegacyMetricName(name)) {
400400
metricInsideBraces = true;
401401
writer.write('{');
402402
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import io.prometheus.metrics.model.snapshots.MetricMetadata;
2222
import io.prometheus.metrics.model.snapshots.MetricSnapshot;
2323
import io.prometheus.metrics.model.snapshots.MetricSnapshots;
24-
import io.prometheus.metrics.model.snapshots.PrometheusNaming;
24+
import io.prometheus.metrics.model.snapshots.PrometheusNames;
2525
import io.prometheus.metrics.model.snapshots.Quantile;
2626
import io.prometheus.metrics.model.snapshots.StateSetSnapshot;
2727
import io.prometheus.metrics.model.snapshots.SummarySnapshot;
@@ -396,7 +396,7 @@ private void writeNameAndLabels(
396396
boolean metricInsideBraces = false;
397397
// If the name does not pass the legacy validity check, we must put the
398398
// metric name inside the braces.
399-
if (!PrometheusNaming.isValidLegacyLabelName(name)) {
399+
if (!PrometheusNames.isValidLegacyLabelName(name)) {
400400
metricInsideBraces = true;
401401
writer.write('{');
402402
}

0 commit comments

Comments
 (0)