* Benchmark Mode Cnt Score Error Units
* i.p.metrics.benchmarks.HistogramBenchmark.openTelemetryClassic thrpt 25 1908.715 ± 114.050 ops/s
@@ -27,164 +27,159 @@
* i.p.metrics.benchmarks.HistogramBenchmark.prometheusNative thrpt 25 3372.789 ± 339.328 ops/s
* i.p.metrics.benchmarks.HistogramBenchmark.simpleclient thrpt 25 6488.252 ± 96.737 ops/s
*
+ *
* The simpleclient (i.e. client_java version 0.16.0 and older) histograms perform about the same as
* the classic histogram of the current 1.0.0 version.
- *
- * Compared to OpenTelemetry histograms the Prometheus Java client histograms perform more than 3 times better
- * (OpenTelemetry has 1908 ops / sec for classic histograms, while Prometheus has 6451 ops / sec).
+ *
+ *
Compared to OpenTelemetry histograms the Prometheus Java client histograms perform more than 3
+ * times better (OpenTelemetry has 1908 ops / sec for classic histograms, while Prometheus has 6451
+ * ops / sec).
*/
-
public class HistogramBenchmark {
- @State(Scope.Benchmark)
- public static class PrometheusClassicHistogram {
+ @State(Scope.Benchmark)
+ public static class PrometheusClassicHistogram {
- final Histogram noLabels;
+ final Histogram noLabels;
- public PrometheusClassicHistogram() {
- noLabels = Histogram.builder()
- .name("test")
- .help("help")
- .classicOnly()
- .build();
- }
+ public PrometheusClassicHistogram() {
+ noLabels = Histogram.builder().name("test").help("help").classicOnly().build();
}
-
- @State(Scope.Benchmark)
- public static class PrometheusNativeHistogram {
-
- final Histogram noLabels;
-
- public PrometheusNativeHistogram() {
- noLabels = Histogram.builder()
- .name("test")
- .help("help")
- .nativeOnly()
- .nativeInitialSchema(5)
- .nativeMaxNumberOfBuckets(0)
- .build();
- }
+ }
+
+ @State(Scope.Benchmark)
+ public static class PrometheusNativeHistogram {
+
+ final Histogram noLabels;
+
+ public PrometheusNativeHistogram() {
+ noLabels =
+ Histogram.builder()
+ .name("test")
+ .help("help")
+ .nativeOnly()
+ .nativeInitialSchema(5)
+ .nativeMaxNumberOfBuckets(0)
+ .build();
}
+ }
- @State(Scope.Benchmark)
- public static class SimpleclientHistogram {
+ @State(Scope.Benchmark)
+ public static class SimpleclientHistogram {
- final io.prometheus.client.Histogram noLabels;
+ final io.prometheus.client.Histogram noLabels;
- public SimpleclientHistogram() {
- noLabels = io.prometheus.client.Histogram.build()
- .name("name")
- .help("help")
- .create();
- }
+ public SimpleclientHistogram() {
+ noLabels = io.prometheus.client.Histogram.build().name("name").help("help").create();
}
-
- @State(Scope.Benchmark)
- public static class OpenTelemetryClassicHistogram {
-
- final io.opentelemetry.api.metrics.DoubleHistogram histogram;
-
- public OpenTelemetryClassicHistogram() {
-
- SdkMeterProvider sdkMeterProvider = SdkMeterProvider.builder()
- .registerMetricReader(InMemoryMetricReader.create())
- .setResource(Resource.getDefault())
- .registerView(InstrumentSelector.builder()
- .setName("test")
- .build(),
- View.builder()
- .setAggregation(Aggregation.explicitBucketHistogram(Arrays.asList(.005, .01, .025, .05, .1, .25, .5, 1.0, 2.5, 5.0, 10.0)))
- .build()
- )
- .build();
- OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
- .setMeterProvider(sdkMeterProvider)
- .build();
- Meter meter = openTelemetry
- .meterBuilder("instrumentation-library-name")
- .setInstrumentationVersion("1.0.0")
- .build();
- this.histogram = meter
- .histogramBuilder("test")
- .setDescription("test")
- .build();
- }
+ }
+
+ @State(Scope.Benchmark)
+ public static class OpenTelemetryClassicHistogram {
+
+ final io.opentelemetry.api.metrics.DoubleHistogram histogram;
+
+ public OpenTelemetryClassicHistogram() {
+
+ SdkMeterProvider sdkMeterProvider =
+ SdkMeterProvider.builder()
+ .registerMetricReader(InMemoryMetricReader.create())
+ .setResource(Resource.getDefault())
+ .registerView(
+ InstrumentSelector.builder().setName("test").build(),
+ View.builder()
+ .setAggregation(
+ Aggregation.explicitBucketHistogram(
+ Arrays.asList(
+ .005, .01, .025, .05, .1, .25, .5, 1.0, 2.5, 5.0, 10.0)))
+ .build())
+ .build();
+ OpenTelemetry openTelemetry =
+ OpenTelemetrySdk.builder().setMeterProvider(sdkMeterProvider).build();
+ Meter meter =
+ openTelemetry
+ .meterBuilder("instrumentation-library-name")
+ .setInstrumentationVersion("1.0.0")
+ .build();
+ this.histogram = meter.histogramBuilder("test").setDescription("test").build();
}
-
- @State(Scope.Benchmark)
- public static class OpenTelemetryExponentialHistogram {
-
- final io.opentelemetry.api.metrics.DoubleHistogram histogram;
-
- public OpenTelemetryExponentialHistogram() {
-
- SdkMeterProvider sdkMeterProvider = SdkMeterProvider.builder()
- .registerMetricReader(InMemoryMetricReader.create())
- .setResource(Resource.getDefault())
- .registerView(InstrumentSelector.builder()
- .setName("test")
- .build(),
- View.builder()
- .setAggregation(Aggregation.base2ExponentialBucketHistogram(10_000, 5))
- .build()
- )
- .build();
- OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
- .setMeterProvider(sdkMeterProvider)
- .build();
- Meter meter = openTelemetry
- .meterBuilder("instrumentation-library-name")
- .setInstrumentationVersion("1.0.0")
- .build();
- this.histogram = meter
- .histogramBuilder("test")
- .setDescription("test")
- .build();
- }
+ }
+
+ @State(Scope.Benchmark)
+ public static class OpenTelemetryExponentialHistogram {
+
+ final io.opentelemetry.api.metrics.DoubleHistogram histogram;
+
+ public OpenTelemetryExponentialHistogram() {
+
+ SdkMeterProvider sdkMeterProvider =
+ SdkMeterProvider.builder()
+ .registerMetricReader(InMemoryMetricReader.create())
+ .setResource(Resource.getDefault())
+ .registerView(
+ InstrumentSelector.builder().setName("test").build(),
+ View.builder()
+ .setAggregation(Aggregation.base2ExponentialBucketHistogram(10_000, 5))
+ .build())
+ .build();
+ OpenTelemetry openTelemetry =
+ OpenTelemetrySdk.builder().setMeterProvider(sdkMeterProvider).build();
+ Meter meter =
+ openTelemetry
+ .meterBuilder("instrumentation-library-name")
+ .setInstrumentationVersion("1.0.0")
+ .build();
+ this.histogram = meter.histogramBuilder("test").setDescription("test").build();
}
-
- @Benchmark
- @Threads(4)
- public Histogram prometheusClassic(RandomNumbers randomNumbers, PrometheusClassicHistogram histogram) {
- for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
- histogram.noLabels.observe(randomNumbers.randomNumbers[i]);
- }
- return histogram.noLabels;
+ }
+
+ @Benchmark
+ @Threads(4)
+ public Histogram prometheusClassic(
+ RandomNumbers randomNumbers, PrometheusClassicHistogram histogram) {
+ for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
+ histogram.noLabels.observe(randomNumbers.randomNumbers[i]);
}
-
- @Benchmark
- @Threads(4)
- public Histogram prometheusNative(RandomNumbers randomNumbers, PrometheusNativeHistogram histogram) {
- for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
- histogram.noLabels.observe(randomNumbers.randomNumbers[i]);
- }
- return histogram.noLabels;
+ return histogram.noLabels;
+ }
+
+ @Benchmark
+ @Threads(4)
+ public Histogram prometheusNative(
+ RandomNumbers randomNumbers, PrometheusNativeHistogram histogram) {
+ for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
+ histogram.noLabels.observe(randomNumbers.randomNumbers[i]);
}
-
- @Benchmark
- @Threads(4)
- public io.prometheus.client.Histogram simpleclient(RandomNumbers randomNumbers, SimpleclientHistogram histogram) {
- for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
- histogram.noLabels.observe(randomNumbers.randomNumbers[i]);
- }
- return histogram.noLabels;
+ return histogram.noLabels;
+ }
+
+ @Benchmark
+ @Threads(4)
+ public io.prometheus.client.Histogram simpleclient(
+ RandomNumbers randomNumbers, SimpleclientHistogram histogram) {
+ for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
+ histogram.noLabels.observe(randomNumbers.randomNumbers[i]);
}
-
- @Benchmark
- @Threads(4)
- public io.opentelemetry.api.metrics.DoubleHistogram openTelemetryClassic(RandomNumbers randomNumbers, OpenTelemetryClassicHistogram histogram) {
- for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
- histogram.histogram.record(randomNumbers.randomNumbers[i]);
- }
- return histogram.histogram;
+ return histogram.noLabels;
+ }
+
+ @Benchmark
+ @Threads(4)
+ public io.opentelemetry.api.metrics.DoubleHistogram openTelemetryClassic(
+ RandomNumbers randomNumbers, OpenTelemetryClassicHistogram histogram) {
+ for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
+ histogram.histogram.record(randomNumbers.randomNumbers[i]);
}
-
- @Benchmark
- @Threads(4)
- public io.opentelemetry.api.metrics.DoubleHistogram openTelemetryExponential(RandomNumbers randomNumbers, OpenTelemetryExponentialHistogram histogram) {
- for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
- histogram.histogram.record(randomNumbers.randomNumbers[i]);
- }
- return histogram.histogram;
+ return histogram.histogram;
+ }
+
+ @Benchmark
+ @Threads(4)
+ public io.opentelemetry.api.metrics.DoubleHistogram openTelemetryExponential(
+ RandomNumbers randomNumbers, OpenTelemetryExponentialHistogram histogram) {
+ for (int i = 0; i < randomNumbers.randomNumbers.length; i++) {
+ histogram.histogram.record(randomNumbers.randomNumbers[i]);
}
+ return histogram.histogram;
+ }
}
diff --git a/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/RandomNumbers.java b/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/RandomNumbers.java
index d7002d909..6778c4ea1 100644
--- a/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/RandomNumbers.java
+++ b/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/RandomNumbers.java
@@ -1,19 +1,18 @@
package io.prometheus.metrics.benchmarks;
+import java.util.Random;
import org.openjdk.jmh.annotations.Scope;
import org.openjdk.jmh.annotations.State;
-import java.util.Random;
-
@State(Scope.Thread)
public class RandomNumbers {
- final double[] randomNumbers = new double[10*1024];
+ final double[] randomNumbers = new double[10 * 1024];
- public RandomNumbers() {
- Random rand = new Random(0);
- for (int i = 0; i < randomNumbers.length; i++) {
- randomNumbers[i] = Math.abs(rand.nextGaussian());
- }
+ public RandomNumbers() {
+ Random rand = new Random(0);
+ for (int i = 0; i < randomNumbers.length; i++) {
+ randomNumbers[i] = Math.abs(rand.nextGaussian());
}
+ }
}
diff --git a/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/GreetingServlet.java b/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/GreetingServlet.java
index 7a0870bf3..af1652f76 100644
--- a/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/GreetingServlet.java
+++ b/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/GreetingServlet.java
@@ -1,47 +1,45 @@
package io.prometheus.metrics.examples.otel_exemplars.greeting;
+import static io.prometheus.metrics.model.snapshots.Unit.nanosToSeconds;
+
import io.prometheus.metrics.core.metrics.Histogram;
import io.prometheus.metrics.model.snapshots.Unit;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
-
import java.io.IOException;
import java.util.Random;
-import static io.prometheus.metrics.model.snapshots.Unit.nanosToSeconds;
-
-/**
- * Hello World REST servlet, with an example counter and an example histogram.
- */
+/** Hello World REST servlet, with an example counter and an example histogram. */
public class GreetingServlet extends HttpServlet {
- private final Random random = new Random(0);
+ private final Random random = new Random(0);
- private final Histogram histogram;
+ private final Histogram histogram;
- public GreetingServlet() {
- histogram = Histogram.builder()
+ public GreetingServlet() {
+ histogram =
+ Histogram.builder()
.name("request_duration_seconds")
.help("request duration in seconds")
.unit(Unit.SECONDS)
.labelNames("http_status")
.register();
- histogram.initLabelValues("200");
- }
-
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
- long start = System.nanoTime();
- try {
- Thread.sleep((long) (Math.abs((random.nextGaussian() + 1.0) * 100.0)));
- resp.setStatus(200);
- resp.setContentType("text/plain");
- resp.getWriter().println("Hello, World!");
- } catch (InterruptedException e) {
- throw new RuntimeException(e);
- } finally {
- histogram.labelValues("200").observe(nanosToSeconds(System.nanoTime() - start));
- }
+ histogram.initLabelValues("200");
+ }
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
+ long start = System.nanoTime();
+ try {
+ Thread.sleep((long) (Math.abs((random.nextGaussian() + 1.0) * 100.0)));
+ resp.setStatus(200);
+ resp.setContentType("text/plain");
+ resp.getWriter().println("Hello, World!");
+ } catch (InterruptedException e) {
+ throw new RuntimeException(e);
+ } finally {
+ histogram.labelValues("200").observe(nanosToSeconds(System.nanoTime() - start));
}
+ }
}
diff --git a/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/Main.java b/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/Main.java
index 731e05cf9..c0cf09830 100644
--- a/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/Main.java
+++ b/examples/example-exemplars-tail-sampling/example-greeting-service/src/main/java/io/prometheus/metrics/examples/otel_exemplars/greeting/Main.java
@@ -2,34 +2,31 @@
import io.prometheus.metrics.exporter.servlet.jakarta.PrometheusMetricsServlet;
import io.prometheus.metrics.instrumentation.jvm.JvmMetrics;
+import java.io.File;
import org.apache.catalina.Context;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.startup.Tomcat;
-import java.io.File;
-
-/**
- * Simple example using embedded Tomcat and the {@link PrometheusMetricsServlet}.
- */
+/** Simple example using embedded Tomcat and the {@link PrometheusMetricsServlet}. */
public class Main {
- public static void main(String[] args) throws LifecycleException {
+ public static void main(String[] args) throws LifecycleException {
- JvmMetrics.builder().register();
+ JvmMetrics.builder().register();
- Tomcat tomcat = new Tomcat();
- tomcat.setPort(8081);
+ Tomcat tomcat = new Tomcat();
+ tomcat.setPort(8081);
- Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
+ Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
- Tomcat.addServlet(ctx, "hello", new GreetingServlet());
- ctx.addServletMappingDecoded("/*", "hello");
+ Tomcat.addServlet(ctx, "hello", new GreetingServlet());
+ ctx.addServletMappingDecoded("/*", "hello");
- Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
- ctx.addServletMappingDecoded("/metrics", "metrics");
+ Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
+ ctx.addServletMappingDecoded("/metrics", "metrics");
- tomcat.getConnector();
- tomcat.start();
- tomcat.getServer().await();
- }
+ tomcat.getConnector();
+ tomcat.start();
+ tomcat.getServer().await();
+ }
}
diff --git a/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/HelloWorldServlet.java b/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/HelloWorldServlet.java
index 11c048d68..fbe293d50 100644
--- a/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/HelloWorldServlet.java
+++ b/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/HelloWorldServlet.java
@@ -1,12 +1,14 @@
package io.prometheus.metrics.examples.otel_exemplars.app;
+import static io.prometheus.metrics.model.snapshots.Unit.nanosToSeconds;
+import static java.net.http.HttpResponse.BodyHandlers.ofString;
+
import io.prometheus.metrics.core.metrics.Histogram;
import io.prometheus.metrics.model.snapshots.Unit;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
-
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
@@ -15,51 +17,46 @@
import java.net.http.HttpResponse;
import java.util.Random;
-import static io.prometheus.metrics.model.snapshots.Unit.nanosToSeconds;
-import static java.net.http.HttpResponse.BodyHandlers.ofString;
-
-/**
- * Hello World REST servlet, with an example counter and an example histogram.
- */
+/** Hello World REST servlet, with an example counter and an example histogram. */
public class HelloWorldServlet extends HttpServlet {
- private final Random random = new Random(0);
-
- private final Histogram histogram;
-
- public HelloWorldServlet() {
- histogram = Histogram.builder()
- .name("request_duration_seconds")
- .help("request duration in seconds")
- .unit(Unit.SECONDS)
- .labelNames("http_status")
- .register();
- histogram.initLabelValues("200");
- }
-
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException {
- long start = System.nanoTime();
- try {
- Thread.sleep((long) (Math.abs((random.nextGaussian() + 1.0) * 100.0)));
- String greeting = executeGreetingServiceRequest();
- resp.setStatus(200);
- resp.setContentType("text/plain");
- resp.getWriter().print(greeting);
- } catch (Exception e) {
- throw new ServletException(e);
- } finally {
- histogram.labelValues("200").observe(nanosToSeconds(System.nanoTime() - start));
- }
- }
-
- private String executeGreetingServiceRequest() throws URISyntaxException, IOException, InterruptedException {
- HttpRequest request = HttpRequest.newBuilder()
- .GET()
- .uri(new URI("http://localhost:8081/"))
- .build();
- HttpClient httpClient = HttpClient.newHttpClient();
- HttpResponse response = httpClient.send(request, ofString());
- return response.body();
+ private final Random random = new Random(0);
+
+ private final Histogram histogram;
+
+ public HelloWorldServlet() {
+ histogram =
+ Histogram.builder()
+ .name("request_duration_seconds")
+ .help("request duration in seconds")
+ .unit(Unit.SECONDS)
+ .labelNames("http_status")
+ .register();
+ histogram.initLabelValues("200");
+ }
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException {
+ long start = System.nanoTime();
+ try {
+ Thread.sleep((long) (Math.abs((random.nextGaussian() + 1.0) * 100.0)));
+ String greeting = executeGreetingServiceRequest();
+ resp.setStatus(200);
+ resp.setContentType("text/plain");
+ resp.getWriter().print(greeting);
+ } catch (Exception e) {
+ throw new ServletException(e);
+ } finally {
+ histogram.labelValues("200").observe(nanosToSeconds(System.nanoTime() - start));
}
+ }
+
+ private String executeGreetingServiceRequest()
+ throws URISyntaxException, IOException, InterruptedException {
+ HttpRequest request =
+ HttpRequest.newBuilder().GET().uri(new URI("http://localhost:8081/")).build();
+ HttpClient httpClient = HttpClient.newHttpClient();
+ HttpResponse response = httpClient.send(request, ofString());
+ return response.body();
+ }
}
diff --git a/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/Main.java b/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/Main.java
index 5fb5114bb..dc58256cb 100644
--- a/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/Main.java
+++ b/examples/example-exemplars-tail-sampling/example-hello-world-app/src/main/java/io/prometheus/metrics/examples/otel_exemplars/app/Main.java
@@ -2,34 +2,31 @@
import io.prometheus.metrics.exporter.servlet.jakarta.PrometheusMetricsServlet;
import io.prometheus.metrics.instrumentation.jvm.JvmMetrics;
+import java.io.File;
import org.apache.catalina.Context;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.startup.Tomcat;
-import java.io.File;
-
-/**
- * Simple example using embedded Tomcat and the {@link PrometheusMetricsServlet}.
- */
+/** Simple example using embedded Tomcat and the {@link PrometheusMetricsServlet}. */
public class Main {
- public static void main(String[] args) throws LifecycleException {
+ public static void main(String[] args) throws LifecycleException {
- JvmMetrics.builder().register();
+ JvmMetrics.builder().register();
- Tomcat tomcat = new Tomcat();
- tomcat.setPort(8080);
+ Tomcat tomcat = new Tomcat();
+ tomcat.setPort(8080);
- Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
+ Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
- Tomcat.addServlet(ctx, "hello", new HelloWorldServlet());
- ctx.addServletMappingDecoded("/*", "hello");
+ Tomcat.addServlet(ctx, "hello", new HelloWorldServlet());
+ ctx.addServletMappingDecoded("/*", "hello");
- Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
- ctx.addServletMappingDecoded("/metrics", "metrics");
+ Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
+ ctx.addServletMappingDecoded("/metrics", "metrics");
- tomcat.getConnector();
- tomcat.start();
- tomcat.getServer().await();
- }
+ tomcat.getConnector();
+ tomcat.start();
+ tomcat.getServer().await();
+ }
}
diff --git a/examples/example-exporter-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java b/examples/example-exporter-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java
index f01874ef8..3b0976778 100644
--- a/examples/example-exporter-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java
+++ b/examples/example-exporter-httpserver/src/main/java/io/prometheus/metrics/examples/httpserver/Main.java
@@ -4,39 +4,36 @@
import io.prometheus.metrics.exporter.httpserver.HTTPServer;
import io.prometheus.metrics.instrumentation.jvm.JvmMetrics;
import io.prometheus.metrics.model.snapshots.Unit;
-
import java.io.IOException;
-/**
- * Simple example of an application exposing metrics via Prometheus' built-in HTTPServer.
- */
+/** Simple example of an application exposing metrics via Prometheus' built-in HTTPServer. */
public class Main {
- public static void main(String[] args) throws IOException, InterruptedException {
+ public static void main(String[] args) throws IOException, InterruptedException {
- JvmMetrics.builder().register();
+ JvmMetrics.builder().register();
- // Note: uptime_seconds_total is not a great example:
- // The built-in JvmMetrics have an out-of-the-box metric named process_start_time_seconds
- // with the start timestamp in seconds, so if you want to know the uptime you can simply
- // run the Prometheus query
- // time() - process_start_time_seconds
- // rather than creating a custom uptime metric.
- Counter counter = Counter.builder()
- .name("uptime_seconds_total")
- .help("total number of seconds since this application was started")
- .unit(Unit.SECONDS)
- .register();
+ // Note: uptime_seconds_total is not a great example:
+ // The built-in JvmMetrics have an out-of-the-box metric named process_start_time_seconds
+ // with the start timestamp in seconds, so if you want to know the uptime you can simply
+ // run the Prometheus query
+ // time() - process_start_time_seconds
+ // rather than creating a custom uptime metric.
+ Counter counter =
+ Counter.builder()
+ .name("uptime_seconds_total")
+ .help("total number of seconds since this application was started")
+ .unit(Unit.SECONDS)
+ .register();
- HTTPServer server = HTTPServer.builder()
- .port(9400)
- .buildAndStart();
+ HTTPServer server = HTTPServer.builder().port(9400).buildAndStart();
- System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
+ System.out.println(
+ "HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
- while (true) {
- Thread.sleep(1000);
- counter.inc();
- }
+ while (true) {
+ Thread.sleep(1000);
+ counter.inc();
}
+ }
}
diff --git a/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/Main.java b/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/Main.java
index da36346b9..0fac9a0d3 100644
--- a/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/Main.java
+++ b/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/Main.java
@@ -1,23 +1,19 @@
package io.prometheus.metrics.examples.multitarget;
-import java.io.IOException;
-
import io.prometheus.metrics.exporter.httpserver.HTTPServer;
import io.prometheus.metrics.model.registry.PrometheusRegistry;
+import java.io.IOException;
-/**
- * Simple example of an application exposing metrics via Prometheus' built-in HTTPServer.
- */
+/** Simple example of an application exposing metrics via Prometheus' built-in HTTPServer. */
public class Main {
- public static void main(String[] args) throws IOException, InterruptedException {
+ public static void main(String[] args) throws IOException, InterruptedException {
- SampleMultiCollector xmc = new SampleMultiCollector();
- PrometheusRegistry.defaultRegistry.register(xmc);
- HTTPServer server = HTTPServer.builder()
- .port(9401)
- .buildAndStart();
+ SampleMultiCollector xmc = new SampleMultiCollector();
+ PrometheusRegistry.defaultRegistry.register(xmc);
+ HTTPServer server = HTTPServer.builder().port(9401).buildAndStart();
- System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
- }
+ System.out.println(
+ "HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
+ }
}
diff --git a/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/SampleMultiCollector.java b/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/SampleMultiCollector.java
index 819bb3028..7a05f0a8b 100644
--- a/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/SampleMultiCollector.java
+++ b/examples/example-exporter-multi-target/src/main/java/io/prometheus/metrics/examples/multitarget/SampleMultiCollector.java
@@ -1,9 +1,5 @@
package io.prometheus.metrics.examples.multitarget;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-
import io.prometheus.metrics.model.registry.MultiCollector;
import io.prometheus.metrics.model.registry.PrometheusScrapeRequest;
import io.prometheus.metrics.model.snapshots.CounterSnapshot;
@@ -13,76 +9,79 @@
import io.prometheus.metrics.model.snapshots.MetricSnapshot;
import io.prometheus.metrics.model.snapshots.MetricSnapshots;
import io.prometheus.metrics.model.snapshots.PrometheusNaming;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
public class SampleMultiCollector implements MultiCollector {
- public SampleMultiCollector() {
- super();
- }
-
- @Override
- public MetricSnapshots collect() {
- return new MetricSnapshots();
- }
+ public SampleMultiCollector() {
+ super();
+ }
- @Override
- public MetricSnapshots collect(PrometheusScrapeRequest scrapeRequest) {
- return collectMetricSnapshots(scrapeRequest);
- }
+ @Override
+ public MetricSnapshots collect() {
+ return new MetricSnapshots();
+ }
- protected MetricSnapshots collectMetricSnapshots(PrometheusScrapeRequest scrapeRequest) {
+ @Override
+ public MetricSnapshots collect(PrometheusScrapeRequest scrapeRequest) {
+ return collectMetricSnapshots(scrapeRequest);
+ }
- GaugeSnapshot.Builder gaugeBuilder = GaugeSnapshot.builder();
- gaugeBuilder.name("x_load").help("process load");
+ protected MetricSnapshots collectMetricSnapshots(PrometheusScrapeRequest scrapeRequest) {
- CounterSnapshot.Builder counterBuilder = CounterSnapshot.builder();
- counterBuilder.name(PrometheusNaming.sanitizeMetricName("x_calls_total")).help("invocations");
+ GaugeSnapshot.Builder gaugeBuilder = GaugeSnapshot.builder();
+ gaugeBuilder.name("x_load").help("process load");
- String[] targetNames = scrapeRequest.getParameterValues("target");
- String targetName;
- String[] procs = scrapeRequest.getParameterValues("proc");
- if (targetNames == null || targetNames.length == 0) {
- targetName = "defaultTarget";
- procs = null; //ignore procs param
- } else {
- targetName = targetNames[0];
- }
- Builder counterDataPointBuilder = CounterSnapshot.CounterDataPointSnapshot.builder();
- io.prometheus.metrics.model.snapshots.GaugeSnapshot.GaugeDataPointSnapshot.Builder gaugeDataPointBuilder = GaugeSnapshot.GaugeDataPointSnapshot.builder();
- Labels lbls = Labels.of("target", targetName);
+ CounterSnapshot.Builder counterBuilder = CounterSnapshot.builder();
+ counterBuilder.name(PrometheusNaming.sanitizeMetricName("x_calls_total")).help("invocations");
- if (procs == null || procs.length == 0) {
- counterDataPointBuilder.labels(lbls.merge(Labels.of("proc", "defaultProc")));
- gaugeDataPointBuilder.labels(lbls.merge(Labels.of("proc", "defaultProc")));
- counterDataPointBuilder.value(70);
- gaugeDataPointBuilder.value(Math.random());
+ String[] targetNames = scrapeRequest.getParameterValues("target");
+ String targetName;
+ String[] procs = scrapeRequest.getParameterValues("proc");
+ if (targetNames == null || targetNames.length == 0) {
+ targetName = "defaultTarget";
+ procs = null; // ignore procs param
+ } else {
+ targetName = targetNames[0];
+ }
+ Builder counterDataPointBuilder = CounterSnapshot.CounterDataPointSnapshot.builder();
+ io.prometheus.metrics.model.snapshots.GaugeSnapshot.GaugeDataPointSnapshot.Builder
+ gaugeDataPointBuilder = GaugeSnapshot.GaugeDataPointSnapshot.builder();
+ Labels lbls = Labels.of("target", targetName);
- counterBuilder.dataPoint(counterDataPointBuilder.build());
- gaugeBuilder.dataPoint(gaugeDataPointBuilder.build());
+ if (procs == null || procs.length == 0) {
+ counterDataPointBuilder.labels(lbls.merge(Labels.of("proc", "defaultProc")));
+ gaugeDataPointBuilder.labels(lbls.merge(Labels.of("proc", "defaultProc")));
+ counterDataPointBuilder.value(70);
+ gaugeDataPointBuilder.value(Math.random());
- } else {
- for (int i = 0; i < procs.length; i++) {
- counterDataPointBuilder.labels(lbls.merge(Labels.of("proc", procs[i])));
- gaugeDataPointBuilder.labels(lbls.merge(Labels.of("proc", procs[i])));
- counterDataPointBuilder.value(Math.random());
- gaugeDataPointBuilder.value(Math.random());
+ counterBuilder.dataPoint(counterDataPointBuilder.build());
+ gaugeBuilder.dataPoint(gaugeDataPointBuilder.build());
- counterBuilder.dataPoint(counterDataPointBuilder.build());
- gaugeBuilder.dataPoint(gaugeDataPointBuilder.build());
- }
- }
- Collection snaps = new ArrayList();
- snaps.add(counterBuilder.build());
- snaps.add(gaugeBuilder.build());
- MetricSnapshots msnaps = new MetricSnapshots(snaps);
- return msnaps;
- }
+ } else {
+ for (int i = 0; i < procs.length; i++) {
+ counterDataPointBuilder.labels(lbls.merge(Labels.of("proc", procs[i])));
+ gaugeDataPointBuilder.labels(lbls.merge(Labels.of("proc", procs[i])));
+ counterDataPointBuilder.value(Math.random());
+ gaugeDataPointBuilder.value(Math.random());
- public List getPrometheusNames() {
- List names = new ArrayList();
- names.add("x_calls_total");
- names.add("x_load");
- return names;
- }
+ counterBuilder.dataPoint(counterDataPointBuilder.build());
+ gaugeBuilder.dataPoint(gaugeDataPointBuilder.build());
+ }
+ }
+ Collection snaps = new ArrayList();
+ snaps.add(counterBuilder.build());
+ snaps.add(gaugeBuilder.build());
+ MetricSnapshots msnaps = new MetricSnapshots(snaps);
+ return msnaps;
+ }
+ public List getPrometheusNames() {
+ List names = new ArrayList();
+ names.add("x_calls_total");
+ names.add("x_load");
+ return names;
+ }
}
diff --git a/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/Main.java b/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/Main.java
index 966b16d92..defe85074 100644
--- a/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/Main.java
+++ b/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/Main.java
@@ -5,37 +5,36 @@
import io.prometheus.metrics.instrumentation.jvm.JvmMetrics;
import io.prometheus.metrics.model.snapshots.Unit;
-/**
- * Simple example of an application exposing metrics pushing metrics via OTLP.
- */
+/** Simple example of an application exposing metrics pushing metrics via OTLP. */
public class Main {
- public static void main(String[] args) throws Exception {
+ public static void main(String[] args) throws Exception {
- // Note: Some JVM metrics are also defined as OpenTelemetry's semantic conventions.
- // We have plans to implement a configuration option for JvmMetrics to use OpenTelemetry
- // naming conventions rather than the Prometheus names.
- JvmMetrics.builder().register();
+ // Note: Some JVM metrics are also defined as OpenTelemetry's semantic conventions.
+ // We have plans to implement a configuration option for JvmMetrics to use OpenTelemetry
+ // naming conventions rather than the Prometheus names.
+ JvmMetrics.builder().register();
- // Note: uptime_seconds_total is not a great example:
- // The built-in JvmMetrics have an out-of-the-box metric named process_start_time_seconds
- // with the start timestamp in seconds, so if you want to know the uptime you can simply
- // run the Prometheus query
- // time() - process_start_time_seconds
- // rather than creating a custom uptime metric.
- Counter counter = Counter.builder()
- .name("uptime_seconds_total")
- .help("total number of seconds since this application was started")
- .unit(Unit.SECONDS)
- .register();
+ // Note: uptime_seconds_total is not a great example:
+ // The built-in JvmMetrics have an out-of-the-box metric named process_start_time_seconds
+ // with the start timestamp in seconds, so if you want to know the uptime you can simply
+ // run the Prometheus query
+ // time() - process_start_time_seconds
+ // rather than creating a custom uptime metric.
+ Counter counter =
+ Counter.builder()
+ .name("uptime_seconds_total")
+ .help("total number of seconds since this application was started")
+ .unit(Unit.SECONDS)
+ .register();
- OpenTelemetryExporter.builder()
- .intervalSeconds(5) // ridiculously short interval for demo purposes
- .buildAndStart();
+ OpenTelemetryExporter.builder()
+ .intervalSeconds(5) // ridiculously short interval for demo purposes
+ .buildAndStart();
- while (true) {
- Thread.sleep(1000);
- counter.inc();
- }
+ while (true) {
+ Thread.sleep(1000);
+ counter.inc();
}
+ }
}
diff --git a/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/ManualCompleteMetricsTest.java b/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/ManualCompleteMetricsTest.java
index 72e8dd107..b8b8ef98b 100644
--- a/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/ManualCompleteMetricsTest.java
+++ b/examples/example-exporter-opentelemetry/src/main/java/io/prometheus/metrics/examples/opentelemetry/ManualCompleteMetricsTest.java
@@ -19,127 +19,128 @@
public class ManualCompleteMetricsTest {
- // This contains a complete set of all metric types, and target_info and otel_scope_info.
- // I used this to expose in Prometheus format and OTLP format at the same time and compare the results.
- // I'm keeping this as a backup for now, but this should be converted to an integration test.
- //
- // To run it, add prometheus-metrics-exporter-httpserver as a dependency and configure Prometheus
- // to scrape from port 9400 in addition to receiving metrics via remote write.
-
- /*
- public static void main(String[] args) throws Exception {
-
- Counter counter = Counter.newBuilder()
- .withName("uptime_seconds_total")
- .withHelp("total number of seconds since this application was started")
- .withUnit(Unit.SECONDS)
- .register();
-
- Gauge gauge = Gauge.newBuilder()
- .withName("temperature_celsius")
- .withHelp("temperature in celsius")
- .withUnit(Unit.CELSIUS)
- .withLabelNames("location")
- .register();
-
- gauge.labelValues("inside").set(23.4);
- gauge.labelValues("outside").set(9.3);
-
- // By default, the histogram will be exported as an exponential histogram in OpenTelemetry.
- Histogram histogram = Histogram.newBuilder()
- .withName("request_latency_seconds")
- .withHelp("Request duration in seconds")
- .withUnit(Unit.SECONDS)
- .withLabelNames("http_status")
- .register();
-
- Random random = new Random(0);
- for (int i = 0; i < 1000; i++) {
- histogram.labelValues("200").observe(random.nextGaussian());
- }
-
- // Explicitly use a classic-only histogram to have an example of a classic histogram in OpenTelemetry
- Histogram classicHistogram = Histogram.newBuilder()
- .withName("request_size_bytes")
- .withHelp("Request size in Bytes")
- .withUnit(Unit.BYTES)
- .withLabelNames("path")
- .classicOnly()
- .withClassicBuckets(128, 256, 512, 1024, 2048)
- .register();
-
- for (int i = 0; i < 15; i++) {
- classicHistogram.labelValues("200").observe(random.nextInt(3000));
- }
-
- Summary summary = Summary.newBuilder()
- .withName("response_latency_seconds")
- .withHelp("Response latency seconds")
- .withUnit(Unit.BYTES)
- .withQuantile(0.95)
- .withQuantile(0.99)
- .register();
-
- for (int i = 0; i < 1000; i++) {
- summary.observe(random.nextGaussian());
- }
-
- Info targetInfo = Info.newBuilder()
- .withName("target_info")
- .withHelp("OTel resource")
- .withLabelNames("service.version")
- .register();
- targetInfo.setLabelValues("1.0.0");
-
- Info scopeInfo = Info.newBuilder()
- .withName("otel_scope_info")
- .withLabelNames("otel.scope.name", "otel.scope.version", "library_mascot")
- .register();
-
- scopeInfo.setLabelValues("my.instrumentation.lib", "100.3", "bear");
-
- Info info = Info.newBuilder()
- .withName("java_runtime_info")
- .withHelp("Java runtime info")
- .withLabelNames("version", "vendor", "runtime")
- .register();
-
- String version = System.getProperty("java.runtime.version", "unknown");
- String vendor = System.getProperty("java.vm.vendor", "unknown");
- String runtime = System.getProperty("java.runtime.name", "unknown");
-
- info.setLabelValues(version, vendor, runtime);
-
- StateSet stateSet = StateSet.newBuilder()
- .withName("feature_flags")
- .withLabelNames("env")
- .withStates("feature1", "feature2")
- .register();
-
- stateSet.labelValues("dev").setFalse("feature1");
- stateSet.labelValues("dev").setTrue("feature2");
-
- PrometheusRegistry.defaultRegistry.register(() -> UnknownSnapshot.newBuilder()
- .withName("my_unknown_metric")
- .addDataPoint(UnknownSnapshot.UnknownDataPointSnapshot.newBuilder()
- .withLabels(Labels.of("a", "1", "b", "2"))
- .withValue(3.0)
- .build())
- .build());
-
- HTTPServer server = HTTPServer.newBuilder()
- .withPort(9400)
- .buildAndStart();
- System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
-
- OpenTelemetryExporter.newBuilder()
- .withIntervalSeconds(5)
- .buildAndStart();
-
- while (true) {
- Thread.sleep(1000);
- counter.inc();
- }
- }
- */
+ // This contains a complete set of all metric types, and target_info and otel_scope_info.
+ // I used this to expose in Prometheus format and OTLP format at the same time and compare the
+ // results.
+ // I'm keeping this as a backup for now, but this should be converted to an integration test.
+ //
+ // To run it, add prometheus-metrics-exporter-httpserver as a dependency and configure Prometheus
+ // to scrape from port 9400 in addition to receiving metrics via remote write.
+
+ /*
+ public static void main(String[] args) throws Exception {
+
+ Counter counter = Counter.newBuilder()
+ .withName("uptime_seconds_total")
+ .withHelp("total number of seconds since this application was started")
+ .withUnit(Unit.SECONDS)
+ .register();
+
+ Gauge gauge = Gauge.newBuilder()
+ .withName("temperature_celsius")
+ .withHelp("temperature in celsius")
+ .withUnit(Unit.CELSIUS)
+ .withLabelNames("location")
+ .register();
+
+ gauge.labelValues("inside").set(23.4);
+ gauge.labelValues("outside").set(9.3);
+
+ // By default, the histogram will be exported as an exponential histogram in OpenTelemetry.
+ Histogram histogram = Histogram.newBuilder()
+ .withName("request_latency_seconds")
+ .withHelp("Request duration in seconds")
+ .withUnit(Unit.SECONDS)
+ .withLabelNames("http_status")
+ .register();
+
+ Random random = new Random(0);
+ for (int i = 0; i < 1000; i++) {
+ histogram.labelValues("200").observe(random.nextGaussian());
+ }
+
+ // Explicitly use a classic-only histogram to have an example of a classic histogram in OpenTelemetry
+ Histogram classicHistogram = Histogram.newBuilder()
+ .withName("request_size_bytes")
+ .withHelp("Request size in Bytes")
+ .withUnit(Unit.BYTES)
+ .withLabelNames("path")
+ .classicOnly()
+ .withClassicBuckets(128, 256, 512, 1024, 2048)
+ .register();
+
+ for (int i = 0; i < 15; i++) {
+ classicHistogram.labelValues("200").observe(random.nextInt(3000));
+ }
+
+ Summary summary = Summary.newBuilder()
+ .withName("response_latency_seconds")
+ .withHelp("Response latency seconds")
+ .withUnit(Unit.BYTES)
+ .withQuantile(0.95)
+ .withQuantile(0.99)
+ .register();
+
+ for (int i = 0; i < 1000; i++) {
+ summary.observe(random.nextGaussian());
+ }
+
+ Info targetInfo = Info.newBuilder()
+ .withName("target_info")
+ .withHelp("OTel resource")
+ .withLabelNames("service.version")
+ .register();
+ targetInfo.setLabelValues("1.0.0");
+
+ Info scopeInfo = Info.newBuilder()
+ .withName("otel_scope_info")
+ .withLabelNames("otel.scope.name", "otel.scope.version", "library_mascot")
+ .register();
+
+ scopeInfo.setLabelValues("my.instrumentation.lib", "100.3", "bear");
+
+ Info info = Info.newBuilder()
+ .withName("java_runtime_info")
+ .withHelp("Java runtime info")
+ .withLabelNames("version", "vendor", "runtime")
+ .register();
+
+ String version = System.getProperty("java.runtime.version", "unknown");
+ String vendor = System.getProperty("java.vm.vendor", "unknown");
+ String runtime = System.getProperty("java.runtime.name", "unknown");
+
+ info.setLabelValues(version, vendor, runtime);
+
+ StateSet stateSet = StateSet.newBuilder()
+ .withName("feature_flags")
+ .withLabelNames("env")
+ .withStates("feature1", "feature2")
+ .register();
+
+ stateSet.labelValues("dev").setFalse("feature1");
+ stateSet.labelValues("dev").setTrue("feature2");
+
+ PrometheusRegistry.defaultRegistry.register(() -> UnknownSnapshot.newBuilder()
+ .withName("my_unknown_metric")
+ .addDataPoint(UnknownSnapshot.UnknownDataPointSnapshot.newBuilder()
+ .withLabels(Labels.of("a", "1", "b", "2"))
+ .withValue(3.0)
+ .build())
+ .build());
+
+ HTTPServer server = HTTPServer.newBuilder()
+ .withPort(9400)
+ .buildAndStart();
+ System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
+
+ OpenTelemetryExporter.newBuilder()
+ .withIntervalSeconds(5)
+ .buildAndStart();
+
+ while (true) {
+ Thread.sleep(1000);
+ counter.inc();
+ }
+ }
+ */
}
diff --git a/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/HelloWorldServlet.java b/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/HelloWorldServlet.java
index d3d8f37e5..eb2fa4f19 100644
--- a/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/HelloWorldServlet.java
+++ b/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/HelloWorldServlet.java
@@ -1,57 +1,56 @@
package io.prometheus.metrics.examples.tomcat_servlet;
+import static io.prometheus.metrics.model.snapshots.Unit.nanosToSeconds;
+
import io.prometheus.metrics.core.metrics.Counter;
import io.prometheus.metrics.core.metrics.Histogram;
import io.prometheus.metrics.model.snapshots.Unit;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
-
import java.io.IOException;
import java.util.Random;
-import static io.prometheus.metrics.model.snapshots.Unit.nanosToSeconds;
-
-/**
- * Hello World REST servlet, with an example counter and an example histogram.
- */
+/** Hello World REST servlet, with an example counter and an example histogram. */
public class HelloWorldServlet extends HttpServlet {
- private final Random random = new Random(0);
-
- // Note: The requests_total counter is not a great example, because the
- // request_duration_seconds histogram below also has a count with the number of requests.
- private final Counter counter = Counter.builder()
- .name("requests_total")
- .help("total number of requests")
- .labelNames("http_status")
- .register();
-
- private final Histogram histogram = Histogram.builder()
- .name("request_duration_seconds")
- .help("request duration in seconds")
- .unit(Unit.SECONDS)
- .labelNames("http_status")
- .register();
-
- public HelloWorldServlet() {
- counter.initLabelValues("200");
- histogram.initLabelValues("200");
- }
-
- @Override
- protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
- long start = System.nanoTime();
- try {
- Thread.sleep((long) (Math.abs((random.nextGaussian() + 1.0) * 100.0)));
- resp.setStatus(200);
- resp.setContentType("text/plain");
- resp.getWriter().println("Hello, World!");
- } catch (InterruptedException e) {
- throw new RuntimeException(e);
- } finally {
- counter.labelValues("200").inc();
- histogram.labelValues("200").observe(nanosToSeconds(System.nanoTime() - start));
- }
+ private final Random random = new Random(0);
+
+ // Note: The requests_total counter is not a great example, because the
+ // request_duration_seconds histogram below also has a count with the number of requests.
+ private final Counter counter =
+ Counter.builder()
+ .name("requests_total")
+ .help("total number of requests")
+ .labelNames("http_status")
+ .register();
+
+ private final Histogram histogram =
+ Histogram.builder()
+ .name("request_duration_seconds")
+ .help("request duration in seconds")
+ .unit(Unit.SECONDS)
+ .labelNames("http_status")
+ .register();
+
+ public HelloWorldServlet() {
+ counter.initLabelValues("200");
+ histogram.initLabelValues("200");
+ }
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
+ long start = System.nanoTime();
+ try {
+ Thread.sleep((long) (Math.abs((random.nextGaussian() + 1.0) * 100.0)));
+ resp.setStatus(200);
+ resp.setContentType("text/plain");
+ resp.getWriter().println("Hello, World!");
+ } catch (InterruptedException e) {
+ throw new RuntimeException(e);
+ } finally {
+ counter.labelValues("200").inc();
+ histogram.labelValues("200").observe(nanosToSeconds(System.nanoTime() - start));
}
+ }
}
diff --git a/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/Main.java b/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/Main.java
index 4ce6353db..81bc2ac19 100644
--- a/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/Main.java
+++ b/examples/example-exporter-servlet-tomcat/src/main/java/io/prometheus/metrics/examples/tomcat_servlet/Main.java
@@ -2,38 +2,35 @@
import io.prometheus.metrics.exporter.servlet.jakarta.PrometheusMetricsServlet;
import io.prometheus.metrics.instrumentation.jvm.JvmMetrics;
-import org.apache.catalina.Context;
-import org.apache.catalina.LifecycleException;
-import org.apache.catalina.startup.Tomcat;
-
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
+import org.apache.catalina.Context;
+import org.apache.catalina.LifecycleException;
+import org.apache.catalina.startup.Tomcat;
-/**
- * Simple example using embedded Tomcat and the {@link PrometheusMetricsServlet}.
- */
+/** Simple example using embedded Tomcat and the {@link PrometheusMetricsServlet}. */
public class Main {
- public static void main(String[] args) throws LifecycleException, IOException {
+ public static void main(String[] args) throws LifecycleException, IOException {
- JvmMetrics.builder().register();
+ JvmMetrics.builder().register();
- Tomcat tomcat = new Tomcat();
- Path tmpDir = Files.createTempDirectory("prometheus-tomcat-servlet-example-");
- tomcat.setBaseDir(tmpDir.toFile().getAbsolutePath());
+ Tomcat tomcat = new Tomcat();
+ Path tmpDir = Files.createTempDirectory("prometheus-tomcat-servlet-example-");
+ tomcat.setBaseDir(tmpDir.toFile().getAbsolutePath());
- Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
+ Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
- Tomcat.addServlet(ctx, "hello", new HelloWorldServlet());
- ctx.addServletMappingDecoded("/*", "hello");
+ Tomcat.addServlet(ctx, "hello", new HelloWorldServlet());
+ ctx.addServletMappingDecoded("/*", "hello");
- Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
- ctx.addServletMappingDecoded("/metrics", "metrics");
+ Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
+ ctx.addServletMappingDecoded("/metrics", "metrics");
- tomcat.getConnector();
- tomcat.start();
- tomcat.getServer().await();
- }
+ tomcat.getConnector();
+ tomcat.start();
+ tomcat.getServer().await();
+ }
}
diff --git a/examples/example-native-histogram/src/main/java/io/prometheus/metrics/examples/nativehistogram/Main.java b/examples/example-native-histogram/src/main/java/io/prometheus/metrics/examples/nativehistogram/Main.java
index 591216fb7..b23fd054d 100644
--- a/examples/example-native-histogram/src/main/java/io/prometheus/metrics/examples/nativehistogram/Main.java
+++ b/examples/example-native-histogram/src/main/java/io/prometheus/metrics/examples/nativehistogram/Main.java
@@ -4,36 +4,35 @@
import io.prometheus.metrics.exporter.httpserver.HTTPServer;
import io.prometheus.metrics.instrumentation.jvm.JvmMetrics;
import io.prometheus.metrics.model.snapshots.Unit;
-
import java.io.IOException;
import java.util.Random;
public class Main {
- public static void main(String[] args) throws IOException, InterruptedException {
+ public static void main(String[] args) throws IOException, InterruptedException {
- JvmMetrics.builder().register();
+ JvmMetrics.builder().register();
- Histogram histogram = Histogram.builder()
- .name("request_latency_seconds")
- .help("request latency in seconds")
- .unit(Unit.SECONDS)
- .labelNames("path", "status")
- .register();
+ Histogram histogram =
+ Histogram.builder()
+ .name("request_latency_seconds")
+ .help("request latency in seconds")
+ .unit(Unit.SECONDS)
+ .labelNames("path", "status")
+ .register();
- HTTPServer server = HTTPServer.builder()
- .port(9400)
- .buildAndStart();
+ HTTPServer server = HTTPServer.builder().port(9400).buildAndStart();
- System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
+ System.out.println(
+ "HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
- Random random = new Random(0);
+ Random random = new Random(0);
- while (true) {
- double duration = Math.abs(random.nextGaussian() / 10.0 + 0.2);
- String status = random.nextInt(100) < 20 ? "500" : "200";
- histogram.labelValues("/", status).observe(duration);
- Thread.sleep(1000);
- }
+ while (true) {
+ double duration = Math.abs(random.nextGaussian() / 10.0 + 0.2);
+ String status = random.nextInt(100) < 20 ? "500" : "200";
+ histogram.labelValues("/", status).observe(duration);
+ Thread.sleep(1000);
}
+ }
}
diff --git a/examples/example-prometheus-properties/src/main/java/io/prometheus/metrics/examples/prometheus_properties/Main.java b/examples/example-prometheus-properties/src/main/java/io/prometheus/metrics/examples/prometheus_properties/Main.java
index 97611fe7b..e1f5954bc 100644
--- a/examples/example-prometheus-properties/src/main/java/io/prometheus/metrics/examples/prometheus_properties/Main.java
+++ b/examples/example-prometheus-properties/src/main/java/io/prometheus/metrics/examples/prometheus_properties/Main.java
@@ -4,42 +4,42 @@
import io.prometheus.metrics.exporter.httpserver.HTTPServer;
import io.prometheus.metrics.instrumentation.jvm.JvmMetrics;
import io.prometheus.metrics.model.snapshots.Unit;
-
import java.io.IOException;
import java.util.Random;
public class Main {
- public static void main(String[] args) throws IOException, InterruptedException {
+ public static void main(String[] args) throws IOException, InterruptedException {
- JvmMetrics.builder().register();
+ JvmMetrics.builder().register();
- Histogram requestDuration = Histogram.builder()
- .name("request_duration_seconds")
- .help("request duration in seconds")
- .unit(Unit.SECONDS)
- .register();
+ Histogram requestDuration =
+ Histogram.builder()
+ .name("request_duration_seconds")
+ .help("request duration in seconds")
+ .unit(Unit.SECONDS)
+ .register();
- Histogram requestSize = Histogram.builder()
- .name("request_size_bytes")
- .help("request size in bytes")
- .unit(Unit.BYTES)
- .register();
+ Histogram requestSize =
+ Histogram.builder()
+ .name("request_size_bytes")
+ .help("request size in bytes")
+ .unit(Unit.BYTES)
+ .register();
- HTTPServer server = HTTPServer.builder()
- .port(9400)
- .buildAndStart();
+ HTTPServer server = HTTPServer.builder().port(9400).buildAndStart();
- System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
+ System.out.println(
+ "HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
- Random random = new Random(0);
+ Random random = new Random(0);
- while (true) {
- double duration = Math.abs(random.nextGaussian() / 10.0 + 0.2);
- double size = random.nextInt(1000) + 256;
- requestDuration.observe(duration);
- requestSize.observe(size);
- Thread.sleep(1000);
- }
+ while (true) {
+ double duration = Math.abs(random.nextGaussian() / 10.0 + 0.2);
+ double size = random.nextInt(1000) + 256;
+ requestDuration.observe(duration);
+ requestSize.observe(size);
+ Thread.sleep(1000);
}
+ }
}
diff --git a/examples/example-simpleclient-bridge/src/main/java/io/prometheus/metrics/examples/simpleclient/Main.java b/examples/example-simpleclient-bridge/src/main/java/io/prometheus/metrics/examples/simpleclient/Main.java
index cb0488d57..dd9dbcdcb 100644
--- a/examples/example-simpleclient-bridge/src/main/java/io/prometheus/metrics/examples/simpleclient/Main.java
+++ b/examples/example-simpleclient-bridge/src/main/java/io/prometheus/metrics/examples/simpleclient/Main.java
@@ -3,39 +3,34 @@
import io.prometheus.client.Counter;
import io.prometheus.metrics.exporter.httpserver.HTTPServer;
import io.prometheus.metrics.simpleclient.bridge.SimpleclientCollector;
-
import java.io.IOException;
-/**
- * Simple example of the simpleclient backwards compatibility module.
- */
+/** Simple example of the simpleclient backwards compatibility module. */
public class Main {
- public static void main(String[] args) throws IOException, InterruptedException {
+ public static void main(String[] args) throws IOException, InterruptedException {
- // The following call will register all metrics from the old CollectorRegistry.defaultRegistry
- // with the new PrometheusRegistry.defaultRegistry.
+ // The following call will register all metrics from the old CollectorRegistry.defaultRegistry
+ // with the new PrometheusRegistry.defaultRegistry.
- SimpleclientCollector.builder().register();
+ SimpleclientCollector.builder().register();
- // Register a counter with the old CollectorRegistry.
- // It doesn't matter whether the counter is registered before or after bridging with PrometheusRegistry.
+ // Register a counter with the old CollectorRegistry.
+ // It doesn't matter whether the counter is registered before or after bridging with
+ // PrometheusRegistry.
- Counter simpleclientCounter = Counter.build()
- .name("events_total")
- .help("total number of events")
- .register();
+ Counter simpleclientCounter =
+ Counter.build().name("events_total").help("total number of events").register();
- simpleclientCounter.inc();
+ simpleclientCounter.inc();
- // Expose metrics from the new PrometheusRegistry. This should contain the events_total metric.
+ // Expose metrics from the new PrometheusRegistry. This should contain the events_total metric.
- HTTPServer server = HTTPServer.builder()
- .port(9400)
- .buildAndStart();
+ HTTPServer server = HTTPServer.builder().port(9400).buildAndStart();
- System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
+ System.out.println(
+ "HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
- Thread.currentThread().join();
- }
+ Thread.currentThread().join();
+ }
}
diff --git a/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/LogConsumer.java b/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/LogConsumer.java
index d60e53979..0e6cfbcc6 100644
--- a/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/LogConsumer.java
+++ b/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/LogConsumer.java
@@ -1,36 +1,33 @@
package io.prometheus.client.it.common;
-import org.testcontainers.containers.output.OutputFrame;
-
import java.util.function.Consumer;
+import org.testcontainers.containers.output.OutputFrame;
-/**
- * Print Docker logs from TestContainers to stdout or stderr.
- */
+/** Print Docker logs from TestContainers to stdout or stderr. */
public class LogConsumer implements Consumer {
- private final String prefix;
+ private final String prefix;
- private LogConsumer(String prefix) {
- this.prefix = prefix;
- }
+ private LogConsumer(String prefix) {
+ this.prefix = prefix;
+ }
- public static LogConsumer withPrefix(String prefix) {
- return new LogConsumer(prefix);
- }
+ public static LogConsumer withPrefix(String prefix) {
+ return new LogConsumer(prefix);
+ }
- @Override
- public void accept(OutputFrame outputFrame) {
- switch (outputFrame.getType()) {
- case STDOUT:
- System.out.print(prefix + " - " + outputFrame.getUtf8String());
- break;
- case END:
- System.out.println(prefix + " - END");
- break;
- default: // STDERR or unexpected
- System.err.print(prefix + " - " + outputFrame.getUtf8String());
- break;
- }
+ @Override
+ public void accept(OutputFrame outputFrame) {
+ switch (outputFrame.getType()) {
+ case STDOUT:
+ System.out.print(prefix + " - " + outputFrame.getUtf8String());
+ break;
+ case END:
+ System.out.println(prefix + " - END");
+ break;
+ default: // STDERR or unexpected
+ System.err.print(prefix + " - " + outputFrame.getUtf8String());
+ break;
}
+ }
}
diff --git a/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/Volume.java b/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/Volume.java
index dc9a32992..783ccb7a5 100644
--- a/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/Volume.java
+++ b/integration-tests/it-common/src/test/java/io/prometheus/client/it/common/Volume.java
@@ -1,6 +1,6 @@
package io.prometheus.client.it.common;
-import org.junit.Assert;
+import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
import java.io.File;
import java.io.IOException;
@@ -8,94 +8,96 @@
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.function.Predicate;
+import org.junit.Assert;
-import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
-
-/**
- * Temporary directory in ./target/ to be mounted as a volume in Docker containers.
- */
+/** Temporary directory in ./target/ to be mounted as a volume in Docker containers. */
public class Volume {
- private final Path tmpDir; // will be created in the ./target/ directory
+ private final Path tmpDir; // will be created in the ./target/ directory
- private Volume(Path tmpDir) {
- this.tmpDir = tmpDir;
- }
+ private Volume(Path tmpDir) {
+ this.tmpDir = tmpDir;
+ }
- public static Volume create(String prefix) throws IOException, URISyntaxException {
- Path targetDir = Paths.get(Volume.class.getResource("/").toURI()).getParent();
- Assert.assertEquals("failed to locate target/ directory", "target", targetDir.getFileName().toString());
- return new Volume(Files.createTempDirectory(targetDir, prefix + "-"));
- }
+ public static Volume create(String prefix) throws IOException, URISyntaxException {
+ Path targetDir = Paths.get(Volume.class.getResource("/").toURI()).getParent();
+ Assert.assertEquals(
+ "failed to locate target/ directory", "target", targetDir.getFileName().toString());
+ return new Volume(Files.createTempDirectory(targetDir, prefix + "-"));
+ }
- /**
- * Copy a file or directory to this volume.
- * @param src is relative to {@code ./target/}
- */
- public Volume copy(String src) throws IOException {
- Path srcPath = tmpDir.getParent().resolve(src);
- if (Files.isRegularFile(srcPath)) {
- Files.copy(srcPath, tmpDir.resolve(srcPath.getFileName()), REPLACE_EXISTING);
- } else if (Files.isDirectory(srcPath)) {
- Path dest = tmpDir.resolve(srcPath.getFileName());
- Files.createDirectories(dest);
- Files.walkFileTree(srcPath, new SimpleFileVisitor() {
+ /**
+ * Copy a file or directory to this volume.
+ *
+ * @param src is relative to {@code ./target/}
+ */
+ public Volume copy(String src) throws IOException {
+ Path srcPath = tmpDir.getParent().resolve(src);
+ if (Files.isRegularFile(srcPath)) {
+ Files.copy(srcPath, tmpDir.resolve(srcPath.getFileName()), REPLACE_EXISTING);
+ } else if (Files.isDirectory(srcPath)) {
+ Path dest = tmpDir.resolve(srcPath.getFileName());
+ Files.createDirectories(dest);
+ Files.walkFileTree(
+ srcPath,
+ new SimpleFileVisitor() {
- // create parent directories
- @Override
- public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
- Files.createDirectories(dest.resolve(srcPath.relativize(dir)));
- return FileVisitResult.CONTINUE;
- }
+ // create parent directories
+ @Override
+ public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs)
+ throws IOException {
+ Files.createDirectories(dest.resolve(srcPath.relativize(dir)));
+ return FileVisitResult.CONTINUE;
+ }
- // copy file
- @Override
- public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
- Files.copy(file, dest.resolve(srcPath.relativize(file)), REPLACE_EXISTING);
- return FileVisitResult.CONTINUE;
- }
- });
- } else {
- Assert.fail(src + ": No such file or directory");
- }
- return this;
+ // copy file
+ @Override
+ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
+ throws IOException {
+ Files.copy(file, dest.resolve(srcPath.relativize(file)), REPLACE_EXISTING);
+ return FileVisitResult.CONTINUE;
+ }
+ });
+ } else {
+ Assert.fail(src + ": No such file or directory");
}
+ return this;
+ }
- /**
- * Remove files in tmpDir if they match the predicate.
- */
- public void rm(Predicate predicate) throws IOException {
- Files.walkFileTree(tmpDir, new SimpleFileVisitor() {
- @Override
- public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
- if (predicate.test(file)) {
- Files.delete(file);
- }
- return FileVisitResult.CONTINUE;
+ /** Remove files in tmpDir if they match the predicate. */
+ public void rm(Predicate predicate) throws IOException {
+ Files.walkFileTree(
+ tmpDir,
+ new SimpleFileVisitor() {
+ @Override
+ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
+ throws IOException {
+ if (predicate.test(file)) {
+ Files.delete(file);
}
+ return FileVisitResult.CONTINUE;
+ }
});
- }
+ }
- public String getHostPath() {
- return tmpDir.toString();
- }
+ public String getHostPath() {
+ return tmpDir.toString();
+ }
- /**
- * Recursively remove tmpDir and its contents.
- */
- public void remove() throws IOException {
- if (!deleteRecursively(tmpDir.toFile())) {
- throw new IOException(tmpDir + ": Failed to remove temporary test directory.");
- }
+ /** Recursively remove tmpDir and its contents. */
+ public void remove() throws IOException {
+ if (!deleteRecursively(tmpDir.toFile())) {
+ throw new IOException(tmpDir + ": Failed to remove temporary test directory.");
}
+ }
- private boolean deleteRecursively(File file) {
- File[] allContents = file.listFiles();
- if (allContents != null) {
- for (File child : allContents) {
- deleteRecursively(child);
- }
- }
- return file.delete();
+ private boolean deleteRecursively(File file) {
+ File[] allContents = file.listFiles();
+ if (allContents != null) {
+ for (File child : allContents) {
+ deleteRecursively(child);
+ }
}
+ return file.delete();
+ }
}
diff --git a/integration-tests/it-exporter/it-exporter-httpserver-sample/src/main/java/io/prometheus/metrics/it/exporter/httpserver/HTTPServerSample.java b/integration-tests/it-exporter/it-exporter-httpserver-sample/src/main/java/io/prometheus/metrics/it/exporter/httpserver/HTTPServerSample.java
index b8cdc5141..4c665dd81 100644
--- a/integration-tests/it-exporter/it-exporter-httpserver-sample/src/main/java/io/prometheus/metrics/it/exporter/httpserver/HTTPServerSample.java
+++ b/integration-tests/it-exporter/it-exporter-httpserver-sample/src/main/java/io/prometheus/metrics/it/exporter/httpserver/HTTPServerSample.java
@@ -6,85 +6,87 @@
import io.prometheus.metrics.exporter.httpserver.HTTPServer;
import io.prometheus.metrics.model.registry.Collector;
import io.prometheus.metrics.model.registry.PrometheusRegistry;
-import io.prometheus.metrics.model.snapshots.MetricSnapshot;
import io.prometheus.metrics.model.snapshots.Unit;
-
import java.io.IOException;
public class HTTPServerSample {
- enum Mode {
- success,
- error
- }
-
- public static void main(String[] args) throws IOException, InterruptedException {
-
- if (args.length != 2) {
- System.err.println("Usage: java -jar exporter-httpserver-sample.jar ");
- System.err.println("Where mode is \"success\" or \"error\".");
- System.exit(1);
- }
-
- int port = parsePortOrExit(args[0]);
- Mode mode = parseModeOrExit(args[1]);
-
- Counter counter = Counter.builder()
- .name("uptime_seconds_total")
- .help("total number of seconds since this application was started")
- .unit(Unit.SECONDS)
- .register();
- counter.inc(17);
+ enum Mode {
+ success,
+ error
+ }
- Info info = Info.builder()
- .name("integration_test_info")
- .help("Info metric on this integration test")
- .labelNames("test_name")
- .register();
- info.addLabelValues("exporter-httpserver-sample");
+ public static void main(String[] args) throws IOException, InterruptedException {
- Gauge gauge = Gauge.builder()
- .name("temperature_celsius")
- .help("Temperature in Celsius")
- .unit(Unit.CELSIUS)
- .labelNames("location")
- .register();
- gauge.labelValues("inside").set(23.0);
- gauge.labelValues("outside").set(27.0);
+ if (args.length != 2) {
+ System.err.println("Usage: java -jar exporter-httpserver-sample.jar ");
+ System.err.println("Where mode is \"success\" or \"error\".");
+ System.exit(1);
+ }
- if (mode == Mode.error) {
- Collector failingCollector = () -> {
- throw new RuntimeException("Simulating an error.");
- };
+ int port = parsePortOrExit(args[0]);
+ Mode mode = parseModeOrExit(args[1]);
+
+ Counter counter =
+ Counter.builder()
+ .name("uptime_seconds_total")
+ .help("total number of seconds since this application was started")
+ .unit(Unit.SECONDS)
+ .register();
+ counter.inc(17);
+
+ Info info =
+ Info.builder()
+ .name("integration_test_info")
+ .help("Info metric on this integration test")
+ .labelNames("test_name")
+ .register();
+ info.addLabelValues("exporter-httpserver-sample");
+
+ Gauge gauge =
+ Gauge.builder()
+ .name("temperature_celsius")
+ .help("Temperature in Celsius")
+ .unit(Unit.CELSIUS)
+ .labelNames("location")
+ .register();
+ gauge.labelValues("inside").set(23.0);
+ gauge.labelValues("outside").set(27.0);
+
+ if (mode == Mode.error) {
+ Collector failingCollector =
+ () -> {
+ throw new RuntimeException("Simulating an error.");
+ };
+
+ PrometheusRegistry.defaultRegistry.register(failingCollector);
+ }
- PrometheusRegistry.defaultRegistry.register(failingCollector);
- }
+ HTTPServer server = HTTPServer.builder().port(port).buildAndStart();
- HTTPServer server = HTTPServer.builder()
- .port(port)
- .buildAndStart();
+ System.out.println(
+ "HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
+ Thread.currentThread().join(); // wait forever
+ }
- System.out.println("HTTPServer listening on port http://localhost:" + server.getPort() + "/metrics");
- Thread.currentThread().join(); // wait forever
+ private static int parsePortOrExit(String port) {
+ try {
+ return Integer.parseInt(port);
+ } catch (NumberFormatException e) {
+ System.err.println("\"" + port + "\": Invalid port number.");
+ System.exit(1);
}
-
- private static int parsePortOrExit(String port) {
- try {
- return Integer.parseInt(port);
- } catch (NumberFormatException e) {
- System.err.println("\"" + port + "\": Invalid port number.");
- System.exit(1);
- }
- return 0; // this won't happen
- }
-
- private static Mode parseModeOrExit(String mode) {
- try {
- return Mode.valueOf(mode);
- } catch (IllegalArgumentException e) {
- System.err.println("\"" + mode + "\": Invalid mode. Legal values are \"success\" and \"error\".");
- System.exit(1);
- }
- return null; // this won't happen
+ return 0; // this won't happen
+ }
+
+ private static Mode parseModeOrExit(String mode) {
+ try {
+ return Mode.valueOf(mode);
+ } catch (IllegalArgumentException e) {
+ System.err.println(
+ "\"" + mode + "\": Invalid mode. Legal values are \"success\" and \"error\".");
+ System.exit(1);
}
+ return null; // this won't happen
+ }
}
diff --git a/integration-tests/it-exporter/it-exporter-servlet-jetty-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/jetty/ExporterServletJettySample.java b/integration-tests/it-exporter/it-exporter-servlet-jetty-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/jetty/ExporterServletJettySample.java
index 9e1a22487..1cc16ee4b 100644
--- a/integration-tests/it-exporter/it-exporter-servlet-jetty-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/jetty/ExporterServletJettySample.java
+++ b/integration-tests/it-exporter/it-exporter-servlet-jetty-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/jetty/ExporterServletJettySample.java
@@ -6,99 +6,101 @@
import io.prometheus.metrics.exporter.servlet.jakarta.PrometheusMetricsServlet;
import io.prometheus.metrics.model.registry.Collector;
import io.prometheus.metrics.model.registry.PrometheusRegistry;
-import io.prometheus.metrics.model.snapshots.MetricSnapshot;
import io.prometheus.metrics.model.snapshots.Unit;
import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.servlet.ServletHandler;
-/**
- * Sample application using the {@link PrometheusMetricsServlet} in Jetty.
- */
+/** Sample application using the {@link PrometheusMetricsServlet} in Jetty. */
public class ExporterServletJettySample {
- enum Mode {
- success,
- error
- }
+ enum Mode {
+ success,
+ error
+ }
+
+ public static void main(String[] args) throws Exception {
- public static void main(String[] args) throws Exception {
-
- if (args.length != 2) {
- System.err.println("Usage: java -jar exporter-servlet-jetty-sample.jar ");
- System.err.println("Where mode is \"success\" or \"error\".");
- System.exit(1);
- }
-
- int port = parsePortOrExit(args[0]);
- Mode mode = parseModeOrExit(args[1]);
-
- Counter counter = Counter.builder()
- .name("uptime_seconds_total")
- .help("total number of seconds since this application was started")
- .unit(Unit.SECONDS)
- .register();
- counter.inc(17);
-
- Info info = Info.builder()
- .name("integration_test_info")
- .help("Info metric on this integration test")
- .labelNames("test_name")
- .register();
- info.addLabelValues("exporter-servlet-jetty-sample");
-
- Gauge gauge = Gauge.builder()
- .name("temperature_celsius")
- .help("Temperature in Celsius")
- .unit(Unit.CELSIUS)
- .labelNames("location")
- .register();
- gauge.labelValues("inside").set(23.0);
- gauge.labelValues("outside").set(27.0);
-
- if (mode == Mode.error) {
- Collector failingCollector = () -> {
- throw new RuntimeException("Simulating an error.");
- };
-
- PrometheusRegistry.defaultRegistry.register(failingCollector);
- }
-
- Server server = new Server();
-
- // set port
- ServerConnector connector = new ServerConnector(server);
- connector.setPort(port);
- server.setConnectors(new Connector[] {connector});
-
- // register servlet
- ServletHandler servletHandler = new ServletHandler();
- servletHandler.addServletWithMapping(PrometheusMetricsServlet.class, "/metrics");
- server.setHandler(servletHandler);
-
- System.out.println("Running on http://localhost:" + port + "/metrics");
-
- // run
- server.start();
+ if (args.length != 2) {
+ System.err.println("Usage: java -jar exporter-servlet-jetty-sample.jar ");
+ System.err.println("Where mode is \"success\" or \"error\".");
+ System.exit(1);
}
- private static int parsePortOrExit(String port) {
- try {
- return Integer.parseInt(port);
- } catch (NumberFormatException e) {
- System.err.println("\"" + port + "\": Invalid port number.");
- System.exit(1);
- }
- return 0; // this won't happen
+ int port = parsePortOrExit(args[0]);
+ Mode mode = parseModeOrExit(args[1]);
+
+ Counter counter =
+ Counter.builder()
+ .name("uptime_seconds_total")
+ .help("total number of seconds since this application was started")
+ .unit(Unit.SECONDS)
+ .register();
+ counter.inc(17);
+
+ Info info =
+ Info.builder()
+ .name("integration_test_info")
+ .help("Info metric on this integration test")
+ .labelNames("test_name")
+ .register();
+ info.addLabelValues("exporter-servlet-jetty-sample");
+
+ Gauge gauge =
+ Gauge.builder()
+ .name("temperature_celsius")
+ .help("Temperature in Celsius")
+ .unit(Unit.CELSIUS)
+ .labelNames("location")
+ .register();
+ gauge.labelValues("inside").set(23.0);
+ gauge.labelValues("outside").set(27.0);
+
+ if (mode == Mode.error) {
+ Collector failingCollector =
+ () -> {
+ throw new RuntimeException("Simulating an error.");
+ };
+
+ PrometheusRegistry.defaultRegistry.register(failingCollector);
}
- private static Mode parseModeOrExit(String mode) {
- try {
- return Mode.valueOf(mode);
- } catch (IllegalArgumentException e) {
- System.err.println("\"" + mode + "\": Invalid mode. Legal values are \"success\" and \"error\".");
- System.exit(1);
- }
- return null; // this won't happen
+ Server server = new Server();
+
+ // set port
+ ServerConnector connector = new ServerConnector(server);
+ connector.setPort(port);
+ server.setConnectors(new Connector[] {connector});
+
+ // register servlet
+ ServletHandler servletHandler = new ServletHandler();
+ servletHandler.addServletWithMapping(PrometheusMetricsServlet.class, "/metrics");
+ server.setHandler(servletHandler);
+
+ System.out.println("Running on http://localhost:" + port + "/metrics");
+
+ // run
+ server.start();
+ }
+
+ private static int parsePortOrExit(String port) {
+ try {
+ return Integer.parseInt(port);
+ } catch (NumberFormatException e) {
+ System.err.println("\"" + port + "\": Invalid port number.");
+ System.exit(1);
+ }
+ return 0; // this won't happen
+ }
+
+ private static Mode parseModeOrExit(String mode) {
+ try {
+ return Mode.valueOf(mode);
+ } catch (IllegalArgumentException e) {
+ System.err.println(
+ "\"" + mode + "\": Invalid mode. Legal values are \"success\" and \"error\".");
+ System.exit(1);
}
+ return null; // this won't happen
+ }
}
diff --git a/integration-tests/it-exporter/it-exporter-servlet-tomcat-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/tomcat/ExporterServletTomcatSample.java b/integration-tests/it-exporter/it-exporter-servlet-tomcat-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/tomcat/ExporterServletTomcatSample.java
index 8d13082b7..ead2ee88f 100644
--- a/integration-tests/it-exporter/it-exporter-servlet-tomcat-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/tomcat/ExporterServletTomcatSample.java
+++ b/integration-tests/it-exporter/it-exporter-servlet-tomcat-sample/src/main/java/io/prometheus/metrics/it/exporter/servlet/tomcat/ExporterServletTomcatSample.java
@@ -6,99 +6,100 @@
import io.prometheus.metrics.exporter.servlet.jakarta.PrometheusMetricsServlet;
import io.prometheus.metrics.model.registry.Collector;
import io.prometheus.metrics.model.registry.PrometheusRegistry;
-import io.prometheus.metrics.model.snapshots.MetricSnapshot;
import io.prometheus.metrics.model.snapshots.Unit;
-import org.apache.catalina.Context;
-import org.apache.catalina.LifecycleException;
-import org.apache.catalina.startup.Tomcat;
-
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
+import org.apache.catalina.Context;
+import org.apache.catalina.LifecycleException;
+import org.apache.catalina.startup.Tomcat;
-/**
- * Sample application using the {@link PrometheusMetricsServlet} in Tomcat.
- */
+/** Sample application using the {@link PrometheusMetricsServlet} in Tomcat. */
public class ExporterServletTomcatSample {
- enum Mode {
- success,
- error
- }
-
- public static void main(String[] args) throws LifecycleException, IOException {
+ enum Mode {
+ success,
+ error
+ }
- if (args.length != 2) {
- System.err.println("Usage: java -jar exporter-servlet-tomcat-sample.jar ");
- System.err.println("Where mode is \"success\" or \"error\".");
- System.exit(1);
- }
+ public static void main(String[] args) throws LifecycleException, IOException {
- int port = parsePortOrExit(args[0]);
- Mode mode = parseModeOrExit(args[1]);
-
- Counter counter = Counter.builder()
- .name("uptime_seconds_total")
- .help("total number of seconds since this application was started")
- .unit(Unit.SECONDS)
- .register();
- counter.inc(17);
-
- Info info = Info.builder()
- .name("integration_test_info")
- .help("Info metric on this integration test")
- .labelNames("test_name")
- .register();
- info.addLabelValues("exporter-servlet-tomcat-sample");
-
- Gauge gauge = Gauge.builder()
- .name("temperature_celsius")
- .help("Temperature in Celsius")
- .unit(Unit.CELSIUS)
- .labelNames("location")
- .register();
- gauge.labelValues("inside").set(23.0);
- gauge.labelValues("outside").set(27.0);
-
- if (mode == Mode.error) {
- Collector failingCollector = () -> {
- throw new RuntimeException("Simulating an error.");
- };
-
- PrometheusRegistry.defaultRegistry.register(failingCollector);
- }
-
- Tomcat tomcat = new Tomcat();
- tomcat.setPort(port);
-
- Path tmpDir = Files.createTempDirectory("exporter-servlet-tomcat-sample-");
- tomcat.setBaseDir(tmpDir.toFile().getAbsolutePath());
- Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
- Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
- ctx.addServletMappingDecoded("/metrics", "metrics");
-
- tomcat.getConnector();
- tomcat.start();
- tomcat.getServer().await();
+ if (args.length != 2) {
+ System.err.println("Usage: java -jar exporter-servlet-tomcat-sample.jar ");
+ System.err.println("Where mode is \"success\" or \"error\".");
+ System.exit(1);
}
- private static int parsePortOrExit(String port) {
- try {
- return Integer.parseInt(port);
- } catch (NumberFormatException e) {
- System.err.println("\"" + port + "\": Invalid port number.");
- System.exit(1);
- }
- return 0; // this won't happen
+ int port = parsePortOrExit(args[0]);
+ Mode mode = parseModeOrExit(args[1]);
+
+ Counter counter =
+ Counter.builder()
+ .name("uptime_seconds_total")
+ .help("total number of seconds since this application was started")
+ .unit(Unit.SECONDS)
+ .register();
+ counter.inc(17);
+
+ Info info =
+ Info.builder()
+ .name("integration_test_info")
+ .help("Info metric on this integration test")
+ .labelNames("test_name")
+ .register();
+ info.addLabelValues("exporter-servlet-tomcat-sample");
+
+ Gauge gauge =
+ Gauge.builder()
+ .name("temperature_celsius")
+ .help("Temperature in Celsius")
+ .unit(Unit.CELSIUS)
+ .labelNames("location")
+ .register();
+ gauge.labelValues("inside").set(23.0);
+ gauge.labelValues("outside").set(27.0);
+
+ if (mode == Mode.error) {
+ Collector failingCollector =
+ () -> {
+ throw new RuntimeException("Simulating an error.");
+ };
+
+ PrometheusRegistry.defaultRegistry.register(failingCollector);
}
- private static Mode parseModeOrExit(String mode) {
- try {
- return Mode.valueOf(mode);
- } catch (IllegalArgumentException e) {
- System.err.println("\"" + mode + "\": Invalid mode. Legal values are \"success\" and \"error\".");
- System.exit(1);
- }
- return null; // this won't happen
+ Tomcat tomcat = new Tomcat();
+ tomcat.setPort(port);
+
+ Path tmpDir = Files.createTempDirectory("exporter-servlet-tomcat-sample-");
+ tomcat.setBaseDir(tmpDir.toFile().getAbsolutePath());
+ Context ctx = tomcat.addContext("", new File(".").getAbsolutePath());
+ Tomcat.addServlet(ctx, "metrics", new PrometheusMetricsServlet());
+ ctx.addServletMappingDecoded("/metrics", "metrics");
+
+ tomcat.getConnector();
+ tomcat.start();
+ tomcat.getServer().await();
+ }
+
+ private static int parsePortOrExit(String port) {
+ try {
+ return Integer.parseInt(port);
+ } catch (NumberFormatException e) {
+ System.err.println("\"" + port + "\": Invalid port number.");
+ System.exit(1);
+ }
+ return 0; // this won't happen
+ }
+
+ private static Mode parseModeOrExit(String mode) {
+ try {
+ return Mode.valueOf(mode);
+ } catch (IllegalArgumentException e) {
+ System.err.println(
+ "\"" + mode + "\": Invalid mode. Legal values are \"success\" and \"error\".");
+ System.exit(1);
}
+ return null; // this won't happen
+ }
}
diff --git a/integration-tests/it-exporter/it-exporter-test/src/test/java/io/prometheus/metrics/it/exporter/test/ExporterIT.java b/integration-tests/it-exporter/it-exporter-test/src/test/java/io/prometheus/metrics/it/exporter/test/ExporterIT.java
index 657b890db..949f71840 100644
--- a/integration-tests/it-exporter/it-exporter-test/src/test/java/io/prometheus/metrics/it/exporter/test/ExporterIT.java
+++ b/integration-tests/it-exporter/it-exporter-test/src/test/java/io/prometheus/metrics/it/exporter/test/ExporterIT.java
@@ -1,17 +1,10 @@
package io.prometheus.metrics.it.exporter.test;
+import static java.nio.charset.StandardCharsets.UTF_8;
+
import io.prometheus.client.it.common.LogConsumer;
import io.prometheus.client.it.common.Volume;
import io.prometheus.metrics.expositionformats.generated.com_google_protobuf_3_25_3.Metrics;
-import org.apache.commons.io.IOUtils;
-import org.junit.After;
-import org.junit.Assert;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized;
-import org.testcontainers.containers.BindMode;
-import org.testcontainers.containers.GenericContainer;
-
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
@@ -26,317 +19,397 @@
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.zip.GZIPInputStream;
-
-import static java.nio.charset.StandardCharsets.UTF_8;
+import org.apache.commons.io.IOUtils;
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.testcontainers.containers.BindMode;
+import org.testcontainers.containers.GenericContainer;
@RunWith(Parameterized.class)
public class ExporterIT {
- private final GenericContainer sampleAppContainer;
- private final Volume sampleAppVolume;
- private final String sampleApp;
+ private final GenericContainer sampleAppContainer;
+ private final Volume sampleAppVolume;
+ private final String sampleApp;
- @Parameterized.Parameters(name = "{0}")
- public static String[] sampleApps() {
- return new String[]{
- "exporter-httpserver-sample",
- "exporter-servlet-tomcat-sample",
- "exporter-servlet-jetty-sample",
- };
- }
+ @Parameterized.Parameters(name = "{0}")
+ public static String[] sampleApps() {
+ return new String[] {
+ "exporter-httpserver-sample",
+ "exporter-servlet-tomcat-sample",
+ "exporter-servlet-jetty-sample",
+ };
+ }
- public ExporterIT(String sampleApp) throws IOException, URISyntaxException {
- this.sampleApp = sampleApp;
- this.sampleAppVolume = Volume.create("it-exporter")
- .copy("../../it-" + sampleApp + "/target/" + sampleApp + ".jar");
- this.sampleAppContainer = new GenericContainer<>("openjdk:17")
- .withFileSystemBind(sampleAppVolume.getHostPath(), "/app", BindMode.READ_ONLY)
- .withWorkingDirectory("/app")
- .withLogConsumer(LogConsumer.withPrefix(sampleApp))
- .withExposedPorts(9400);
- }
+ public ExporterIT(String sampleApp) throws IOException, URISyntaxException {
+ this.sampleApp = sampleApp;
+ this.sampleAppVolume =
+ Volume.create("it-exporter")
+ .copy("../../it-" + sampleApp + "/target/" + sampleApp + ".jar");
+ this.sampleAppContainer =
+ new GenericContainer<>("openjdk:17")
+ .withFileSystemBind(sampleAppVolume.getHostPath(), "/app", BindMode.READ_ONLY)
+ .withWorkingDirectory("/app")
+ .withLogConsumer(LogConsumer.withPrefix(sampleApp))
+ .withExposedPorts(9400);
+ }
- @After
- public void tearDown() throws IOException {
- sampleAppContainer.stop();
- sampleAppVolume.remove();
- }
+ @After
+ public void tearDown() throws IOException {
+ sampleAppContainer.stop();
+ sampleAppVolume.remove();
+ }
- @Test
- public void testOpenMetricsTextFormat() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", "", "Accept", "application/openmetrics-text; version=1.0.0; charset=utf-8");
- Assert.assertEquals(200, response.status);
- assertContentType("application/openmetrics-text; version=1.0.0; charset=utf-8", response.getHeader("Content-Type"));
- Assert.assertNull(response.getHeader("Content-Encoding"));
- Assert.assertNull(response.getHeader("Transfer-Encoding"));
- Assert.assertEquals(Integer.toString(response.body.length), response.getHeader("Content-Length"));
- String bodyString = new String(response.body);
- Assert.assertTrue(bodyString.contains("integration_test_info{test_name=\"" + sampleApp + "\"} 1"));
- Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"inside\"} 23.0"));
- Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"outside\"} 27.0"));
- Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
- // OpenMetrics text format has a UNIT.
- Assert.assertTrue(bodyString.contains("# UNIT uptime_seconds seconds"));
- }
+ @Test
+ public void testOpenMetricsTextFormat() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response =
+ scrape("GET", "", "Accept", "application/openmetrics-text; version=1.0.0; charset=utf-8");
+ Assert.assertEquals(200, response.status);
+ assertContentType(
+ "application/openmetrics-text; version=1.0.0; charset=utf-8",
+ response.getHeader("Content-Type"));
+ Assert.assertNull(response.getHeader("Content-Encoding"));
+ Assert.assertNull(response.getHeader("Transfer-Encoding"));
+ Assert.assertEquals(
+ Integer.toString(response.body.length), response.getHeader("Content-Length"));
+ String bodyString = new String(response.body);
+ Assert.assertTrue(
+ bodyString.contains("integration_test_info{test_name=\"" + sampleApp + "\"} 1"));
+ Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"inside\"} 23.0"));
+ Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"outside\"} 27.0"));
+ Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
+ // OpenMetrics text format has a UNIT.
+ Assert.assertTrue(bodyString.contains("# UNIT uptime_seconds seconds"));
+ }
- @Test
- public void testPrometheusTextFormat() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", "");
- Assert.assertEquals(200, response.status);
- assertContentType("text/plain; version=0.0.4; charset=utf-8", response.getHeader("Content-Type"));
- Assert.assertNull(response.getHeader("Content-Encoding"));
- Assert.assertNull(response.getHeader("Transfer-Encoding"));
- Assert.assertEquals(Integer.toString(response.body.length), response.getHeader("Content-Length"));
- String bodyString = new String(response.body);
- Assert.assertTrue(bodyString.contains("integration_test_info{test_name=\"" + sampleApp + "\"} 1"));
- Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"inside\"} 23.0"));
- Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"outside\"} 27.0"));
- Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
- // Prometheus text format does not have a UNIT.
- Assert.assertFalse(bodyString.contains("# UNIT uptime_seconds seconds"));
- }
+ @Test
+ public void testPrometheusTextFormat() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response = scrape("GET", "");
+ Assert.assertEquals(200, response.status);
+ assertContentType(
+ "text/plain; version=0.0.4; charset=utf-8", response.getHeader("Content-Type"));
+ Assert.assertNull(response.getHeader("Content-Encoding"));
+ Assert.assertNull(response.getHeader("Transfer-Encoding"));
+ Assert.assertEquals(
+ Integer.toString(response.body.length), response.getHeader("Content-Length"));
+ String bodyString = new String(response.body);
+ Assert.assertTrue(
+ bodyString.contains("integration_test_info{test_name=\"" + sampleApp + "\"} 1"));
+ Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"inside\"} 23.0"));
+ Assert.assertTrue(bodyString.contains("temperature_celsius{location=\"outside\"} 27.0"));
+ Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
+ // Prometheus text format does not have a UNIT.
+ Assert.assertFalse(bodyString.contains("# UNIT uptime_seconds seconds"));
+ }
- @Test
- public void testPrometheusProtobufFormat() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", "", "Accept", "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited");
- Assert.assertEquals(200, response.status);
- assertContentType("application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited", response.getHeader("Content-Type"));
- Assert.assertNull(response.getHeader("Content-Encoding"));
- Assert.assertNull(response.getHeader("Transfer-Encoding"));
- Assert.assertEquals(Integer.toString(response.body.length), response.getHeader("Content-Length"));
- List metrics = new ArrayList<>();
- InputStream in = new ByteArrayInputStream(response.body);
- while (in.available() > 0) {
- metrics.add(Metrics.MetricFamily.parseDelimitedFrom(in));
- }
- Assert.assertEquals(3, metrics.size());
- // metrics are sorted by name
- Assert.assertEquals("integration_test_info", metrics.get(0).getName());
- Assert.assertEquals("temperature_celsius", metrics.get(1).getName());
- Assert.assertEquals("uptime_seconds_total", metrics.get(2).getName());
+ @Test
+ public void testPrometheusProtobufFormat() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response =
+ scrape(
+ "GET",
+ "",
+ "Accept",
+ "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited");
+ Assert.assertEquals(200, response.status);
+ assertContentType(
+ "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited",
+ response.getHeader("Content-Type"));
+ Assert.assertNull(response.getHeader("Content-Encoding"));
+ Assert.assertNull(response.getHeader("Transfer-Encoding"));
+ Assert.assertEquals(
+ Integer.toString(response.body.length), response.getHeader("Content-Length"));
+ List metrics = new ArrayList<>();
+ InputStream in = new ByteArrayInputStream(response.body);
+ while (in.available() > 0) {
+ metrics.add(Metrics.MetricFamily.parseDelimitedFrom(in));
}
+ Assert.assertEquals(3, metrics.size());
+ // metrics are sorted by name
+ Assert.assertEquals("integration_test_info", metrics.get(0).getName());
+ Assert.assertEquals("temperature_celsius", metrics.get(1).getName());
+ Assert.assertEquals("uptime_seconds_total", metrics.get(2).getName());
+ }
- @Test
- public void testCompression() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", "",
- "Accept", "application/openmetrics-text; version=1.0.0; charset=utf-8",
- "Accept-Encoding", "gzip");
- Assert.assertEquals(200, response.status);
- Assert.assertEquals("gzip", response.getHeader("Content-Encoding"));
- if (response.getHeader("Content-Length") != null) {
- // The servlet container might set a content length as the body is very small.
- Assert.assertEquals(Integer.toString(response.body.length), response.getHeader("Content-Length"));
- Assert.assertNull(response.getHeader("Transfer-Encoding"));
- } else {
- // If no content length is set, transfer-encoding chunked must be used.
- Assert.assertEquals("chunked", response.getHeader("Transfer-Encoding"));
- }
- assertContentType("application/openmetrics-text; version=1.0.0; charset=utf-8", response.getHeader("Content-Type"));
- String body = new String(IOUtils.toByteArray(new GZIPInputStream(new ByteArrayInputStream(response.body))), UTF_8);
- Assert.assertTrue(body.contains("uptime_seconds_total 17.0"));
+ @Test
+ public void testCompression() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response =
+ scrape(
+ "GET",
+ "",
+ "Accept",
+ "application/openmetrics-text; version=1.0.0; charset=utf-8",
+ "Accept-Encoding",
+ "gzip");
+ Assert.assertEquals(200, response.status);
+ Assert.assertEquals("gzip", response.getHeader("Content-Encoding"));
+ if (response.getHeader("Content-Length") != null) {
+ // The servlet container might set a content length as the body is very small.
+ Assert.assertEquals(
+ Integer.toString(response.body.length), response.getHeader("Content-Length"));
+ Assert.assertNull(response.getHeader("Transfer-Encoding"));
+ } else {
+ // If no content length is set, transfer-encoding chunked must be used.
+ Assert.assertEquals("chunked", response.getHeader("Transfer-Encoding"));
}
+ assertContentType(
+ "application/openmetrics-text; version=1.0.0; charset=utf-8",
+ response.getHeader("Content-Type"));
+ String body =
+ new String(
+ IOUtils.toByteArray(new GZIPInputStream(new ByteArrayInputStream(response.body))),
+ UTF_8);
+ Assert.assertTrue(body.contains("uptime_seconds_total 17.0"));
+ }
- @Test
- public void testErrorHandling() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "error")
- .start();
- Response response = scrape("GET", "");
- Assert.assertEquals(500, response.status);
- Assert.assertTrue(new String(response.body, UTF_8).contains("Simulating an error."));
- }
+ @Test
+ public void testErrorHandling() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "error")
+ .start();
+ Response response = scrape("GET", "");
+ Assert.assertEquals(500, response.status);
+ Assert.assertTrue(new String(response.body, UTF_8).contains("Simulating an error."));
+ }
- @Test
- public void testHeadRequest() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response fullResponse = scrape("GET", "");
- int size = fullResponse.body.length;
- Assert.assertTrue(size > 0);
- Response headResponse = scrape("HEAD", "");
- Assert.assertEquals(200, headResponse.status);
- Assert.assertEquals(Integer.toString(size), headResponse.getHeader("Content-Length"));
- Assert.assertEquals(0, headResponse.body.length);
- }
+ @Test
+ public void testHeadRequest() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response fullResponse = scrape("GET", "");
+ int size = fullResponse.body.length;
+ Assert.assertTrue(size > 0);
+ Response headResponse = scrape("HEAD", "");
+ Assert.assertEquals(200, headResponse.status);
+ Assert.assertEquals(Integer.toString(size), headResponse.getHeader("Content-Length"));
+ Assert.assertEquals(0, headResponse.body.length);
+ }
- @Test
- public void testDebug() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", "debug=openmetrics");
- Assert.assertEquals(200, response.status);
- assertContentType("text/plain; charset=utf-8", response.getHeader("Content-Type"));
- String bodyString = new String(response.body, UTF_8);
- Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
- Assert.assertTrue(bodyString.contains("# UNIT uptime_seconds seconds"));
- }
+ @Test
+ public void testDebug() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response = scrape("GET", "debug=openmetrics");
+ Assert.assertEquals(200, response.status);
+ assertContentType("text/plain; charset=utf-8", response.getHeader("Content-Type"));
+ String bodyString = new String(response.body, UTF_8);
+ Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
+ Assert.assertTrue(bodyString.contains("# UNIT uptime_seconds seconds"));
+ }
- @Test
- public void testNameFilter() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", nameParam("integration_test_info") + "&" + nameParam("uptime_seconds_total"),
- "Accept", "application/openmetrics-text; version=1.0.0; charset=utf-8");
- Assert.assertEquals(200, response.status);
- assertContentType("application/openmetrics-text; version=1.0.0; charset=utf-8", response.getHeader("Content-Type"));
- String bodyString = new String(response.body, UTF_8);
- Assert.assertTrue(bodyString.contains("integration_test_info{test_name=\"" + sampleApp + "\"} 1"));
- Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
- Assert.assertFalse(bodyString.contains("temperature_celsius"));
- }
+ @Test
+ public void testNameFilter() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response =
+ scrape(
+ "GET",
+ nameParam("integration_test_info") + "&" + nameParam("uptime_seconds_total"),
+ "Accept",
+ "application/openmetrics-text; version=1.0.0; charset=utf-8");
+ Assert.assertEquals(200, response.status);
+ assertContentType(
+ "application/openmetrics-text; version=1.0.0; charset=utf-8",
+ response.getHeader("Content-Type"));
+ String bodyString = new String(response.body, UTF_8);
+ Assert.assertTrue(
+ bodyString.contains("integration_test_info{test_name=\"" + sampleApp + "\"} 1"));
+ Assert.assertTrue(bodyString.contains("uptime_seconds_total 17.0"));
+ Assert.assertFalse(bodyString.contains("temperature_celsius"));
+ }
- @Test
- public void testEmptyResponseOpenMetrics() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", nameParam("none_existing"),
- "Accept", "application/openmetrics-text; version=1.0.0; charset=utf-8");
- Assert.assertEquals(200, response.status);
- assertContentType("application/openmetrics-text; version=1.0.0; charset=utf-8", response.getHeader("Content-Type"));
- Assert.assertEquals(Integer.toString(response.body.length), response.getHeader("Content-Length"));
- Assert.assertEquals("# EOF\n", new String(response.body, UTF_8));
- }
+ @Test
+ public void testEmptyResponseOpenMetrics() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response =
+ scrape(
+ "GET",
+ nameParam("none_existing"),
+ "Accept",
+ "application/openmetrics-text; version=1.0.0; charset=utf-8");
+ Assert.assertEquals(200, response.status);
+ assertContentType(
+ "application/openmetrics-text; version=1.0.0; charset=utf-8",
+ response.getHeader("Content-Type"));
+ Assert.assertEquals(
+ Integer.toString(response.body.length), response.getHeader("Content-Length"));
+ Assert.assertEquals("# EOF\n", new String(response.body, UTF_8));
+ }
- @Test
- public void testEmptyResponseText() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", nameParam("none_existing"));
- Assert.assertEquals(200, response.status);
- assertContentType("text/plain; version=0.0.4; charset=utf-8", response.getHeader("Content-Type"));
- if (response.getHeader("Content-Length") != null) { // HTTPServer does not send a zero content length, which is ok
- Assert.assertEquals("0", response.getHeader("Content-Length"));
- }
- Assert.assertEquals(0, response.body.length);
+ @Test
+ public void testEmptyResponseText() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response = scrape("GET", nameParam("none_existing"));
+ Assert.assertEquals(200, response.status);
+ assertContentType(
+ "text/plain; version=0.0.4; charset=utf-8", response.getHeader("Content-Type"));
+ if (response.getHeader("Content-Length")
+ != null) { // HTTPServer does not send a zero content length, which is ok
+ Assert.assertEquals("0", response.getHeader("Content-Length"));
}
+ Assert.assertEquals(0, response.body.length);
+ }
- @Test
- public void testEmptyResponseProtobuf() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", nameParam("none_existing"),
- "Accept", "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited");
- Assert.assertEquals(200, response.status);
- assertContentType("application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited", response.getHeader("Content-Type"));
- Assert.assertEquals(0, response.body.length);
- }
+ @Test
+ public void testEmptyResponseProtobuf() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response =
+ scrape(
+ "GET",
+ nameParam("none_existing"),
+ "Accept",
+ "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited");
+ Assert.assertEquals(200, response.status);
+ assertContentType(
+ "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited",
+ response.getHeader("Content-Type"));
+ Assert.assertEquals(0, response.body.length);
+ }
- @Test
- public void testEmptyResponseGzipOpenMetrics() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", nameParam("none_existing"),
- "Accept", "application/openmetrics-text; version=1.0.0; charset=utf-8",
- "Accept-Encoding", "gzip");
- Assert.assertEquals(200, response.status);
- Assert.assertEquals("gzip", response.getHeader("Content-Encoding"));
- String body = new String(IOUtils.toByteArray(new GZIPInputStream(new ByteArrayInputStream(response.body))), UTF_8);
- Assert.assertEquals("# EOF\n", body);
- }
+ @Test
+ public void testEmptyResponseGzipOpenMetrics() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response =
+ scrape(
+ "GET",
+ nameParam("none_existing"),
+ "Accept",
+ "application/openmetrics-text; version=1.0.0; charset=utf-8",
+ "Accept-Encoding",
+ "gzip");
+ Assert.assertEquals(200, response.status);
+ Assert.assertEquals("gzip", response.getHeader("Content-Encoding"));
+ String body =
+ new String(
+ IOUtils.toByteArray(new GZIPInputStream(new ByteArrayInputStream(response.body))),
+ UTF_8);
+ Assert.assertEquals("# EOF\n", body);
+ }
- @Test
- public void testEmptyResponseGzipText() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", nameParam("none_existing"),
- "Accept-Encoding", "gzip");
- Assert.assertEquals(200, response.status);
- Assert.assertEquals("gzip", response.getHeader("Content-Encoding"));
- String body = new String(IOUtils.toByteArray(new GZIPInputStream(new ByteArrayInputStream(response.body))), UTF_8);
- Assert.assertEquals(0, body.length());
- }
+ @Test
+ public void testEmptyResponseGzipText() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response = scrape("GET", nameParam("none_existing"), "Accept-Encoding", "gzip");
+ Assert.assertEquals(200, response.status);
+ Assert.assertEquals("gzip", response.getHeader("Content-Encoding"));
+ String body =
+ new String(
+ IOUtils.toByteArray(new GZIPInputStream(new ByteArrayInputStream(response.body))),
+ UTF_8);
+ Assert.assertEquals(0, body.length());
+ }
- private String nameParam(String name) throws UnsupportedEncodingException {
- return URLEncoder.encode("name[]", UTF_8.name()) + "=" + URLEncoder.encode(name, UTF_8.name());
- }
+ private String nameParam(String name) throws UnsupportedEncodingException {
+ return URLEncoder.encode("name[]", UTF_8.name()) + "=" + URLEncoder.encode(name, UTF_8.name());
+ }
- @Test
- public void testDebugUnknown() throws IOException {
- sampleAppContainer
- .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
- .start();
- Response response = scrape("GET", "debug=unknown");
- Assert.assertEquals(500, response.status);
- assertContentType("text/plain; charset=utf-8", response.getHeader("Content-Type"));
- }
+ @Test
+ public void testDebugUnknown() throws IOException {
+ sampleAppContainer
+ .withCommand("java", "-jar", "/app/" + sampleApp + ".jar", "9400", "success")
+ .start();
+ Response response = scrape("GET", "debug=unknown");
+ Assert.assertEquals(500, response.status);
+ assertContentType("text/plain; charset=utf-8", response.getHeader("Content-Type"));
+ }
- private void assertContentType(String expected, String actual) {
- if (!expected.replace(" ", "").equals(actual)) {
- Assert.assertEquals(expected, actual);
- }
+ private void assertContentType(String expected, String actual) {
+ if (!expected.replace(" ", "").equals(actual)) {
+ Assert.assertEquals(expected, actual);
}
+ }
- private Response scrape(String method, String queryString, String... requestHeaders) throws IOException {
- long timeoutMillis = TimeUnit.SECONDS.toMillis(5);
- URL url = new URL("http://localhost:" + sampleAppContainer.getMappedPort(9400) + "/metrics?" + queryString);
- HttpURLConnection con = (HttpURLConnection) url.openConnection();
- con.setRequestMethod(method);
- for (int i = 0; i < requestHeaders.length; i += 2) {
- con.setRequestProperty(requestHeaders[i], requestHeaders[i + 1]);
- }
- long start = System.currentTimeMillis();
- Exception exception = null;
- while (System.currentTimeMillis() - start < timeoutMillis) {
- try {
- if (con.getResponseCode() == 200) {
- return new Response(con.getResponseCode(), con.getHeaderFields(), IOUtils.toByteArray(con.getInputStream()));
- } else {
- return new Response(con.getResponseCode(), con.getHeaderFields(), IOUtils.toByteArray(con.getErrorStream()));
- }
- } catch (Exception e) {
- exception = e;
- try {
- Thread.sleep(100);
- } catch (InterruptedException ignored) {
- }
- }
+ private Response scrape(String method, String queryString, String... requestHeaders)
+ throws IOException {
+ long timeoutMillis = TimeUnit.SECONDS.toMillis(5);
+ URL url =
+ new URL(
+ "http://localhost:"
+ + sampleAppContainer.getMappedPort(9400)
+ + "/metrics?"
+ + queryString);
+ HttpURLConnection con = (HttpURLConnection) url.openConnection();
+ con.setRequestMethod(method);
+ for (int i = 0; i < requestHeaders.length; i += 2) {
+ con.setRequestProperty(requestHeaders[i], requestHeaders[i + 1]);
+ }
+ long start = System.currentTimeMillis();
+ Exception exception = null;
+ while (System.currentTimeMillis() - start < timeoutMillis) {
+ try {
+ if (con.getResponseCode() == 200) {
+ return new Response(
+ con.getResponseCode(),
+ con.getHeaderFields(),
+ IOUtils.toByteArray(con.getInputStream()));
+ } else {
+ return new Response(
+ con.getResponseCode(),
+ con.getHeaderFields(),
+ IOUtils.toByteArray(con.getErrorStream()));
}
- if (exception != null) {
- exception.printStackTrace();
+ } catch (Exception e) {
+ exception = e;
+ try {
+ Thread.sleep(100);
+ } catch (InterruptedException ignored) {
}
- Assert.fail("timeout while getting metrics from " + url);
- return null; // will not happen
+ }
+ }
+ if (exception != null) {
+ exception.printStackTrace();
}
+ Assert.fail("timeout while getting metrics from " + url);
+ return null; // will not happen
+ }
- private static class Response {
- private final int status;
- private final Map headers;
- private final byte[] body;
+ private static class Response {
+ private final int status;
+ private final Map headers;
+ private final byte[] body;
- private Response(int status, Map> headers, byte[] body) {
- this.status = status;
- this.headers = new HashMap<>(headers.size());
- this.body = body;
- for (Map.Entry> entry : headers.entrySet()) {
- if (entry.getKey() != null) { // HttpUrlConnection uses pseudo key "null" for the status line
- this.headers.put(entry.getKey().toLowerCase(), entry.getValue().get(0));
- }
- }
+ private Response(int status, Map> headers, byte[] body) {
+ this.status = status;
+ this.headers = new HashMap<>(headers.size());
+ this.body = body;
+ for (Map.Entry> entry : headers.entrySet()) {
+ if (entry.getKey()
+ != null) { // HttpUrlConnection uses pseudo key "null" for the status line
+ this.headers.put(entry.getKey().toLowerCase(), entry.getValue().get(0));
}
+ }
+ }
- private String getHeader(String name) {
- // HTTP headers are case-insensitive
- return headers.get(name.toLowerCase());
- }
+ private String getHeader(String name) {
+ // HTTP headers are case-insensitive
+ return headers.get(name.toLowerCase());
}
+ }
}
diff --git a/integration-tests/it-pushgateway/src/main/java/io/prometheus/metrics/it/pushgateway/PushGatewayTestApp.java b/integration-tests/it-pushgateway/src/main/java/io/prometheus/metrics/it/pushgateway/PushGatewayTestApp.java
index 69ef63081..6376b03fb 100644
--- a/integration-tests/it-pushgateway/src/main/java/io/prometheus/metrics/it/pushgateway/PushGatewayTestApp.java
+++ b/integration-tests/it-pushgateway/src/main/java/io/prometheus/metrics/it/pushgateway/PushGatewayTestApp.java
@@ -1,131 +1,126 @@
package io.prometheus.metrics.it.pushgateway;
+import static io.prometheus.metrics.exporter.pushgateway.Scheme.HTTPS;
+
import io.prometheus.metrics.core.metrics.Gauge;
import io.prometheus.metrics.core.metrics.Histogram;
import io.prometheus.metrics.exporter.pushgateway.Format;
import io.prometheus.metrics.exporter.pushgateway.HttpConnectionFactory;
import io.prometheus.metrics.exporter.pushgateway.PushGateway;
import io.prometheus.metrics.model.snapshots.Unit;
-
-import javax.net.ssl.HttpsURLConnection;
-import javax.net.ssl.SSLContext;
-import javax.net.ssl.TrustManager;
-import javax.net.ssl.X509TrustManager;
import java.io.IOException;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.X509Certificate;
+import javax.net.ssl.HttpsURLConnection;
+import javax.net.ssl.SSLContext;
+import javax.net.ssl.TrustManager;
+import javax.net.ssl.X509TrustManager;
-import static io.prometheus.metrics.exporter.pushgateway.Scheme.HTTPS;
-
-/**
- * Example application using the {@link PushGateway}.
- */
+/** Example application using the {@link PushGateway}. */
public class PushGatewayTestApp {
- public static void main(String[] args) throws IOException {
- if (args.length != 1) {
- System.err.println("Usage: java -jar pushgateway-test-app.jar ");
- System.exit(-1);
- }
- switch (args[0]) {
- case "simple":
- runSimpleTest();
- break;
- case "textFormat":
- runTextFormatTest();
- break;
- case "basicauth":
- runBasicAuthTest();
- break;
- case "ssl":
- runSslTest();
- break;
- default:
- System.err.println(args[0] + ": Not implemented.");
- System.exit(-1);
- }
+ public static void main(String[] args) throws IOException {
+ if (args.length != 1) {
+ System.err.println("Usage: java -jar pushgateway-test-app.jar ");
+ System.exit(-1);
}
-
- private static void runSimpleTest() throws IOException {
- makeMetrics();
- PushGateway pg = PushGateway.builder().build();
- System.out.println("Pushing metrics...");
- pg.push();
- System.out.println("Push successful.");
+ switch (args[0]) {
+ case "simple":
+ runSimpleTest();
+ break;
+ case "textFormat":
+ runTextFormatTest();
+ break;
+ case "basicauth":
+ runBasicAuthTest();
+ break;
+ case "ssl":
+ runSslTest();
+ break;
+ default:
+ System.err.println(args[0] + ": Not implemented.");
+ System.exit(-1);
}
+ }
- private static void runTextFormatTest() throws IOException {
- makeMetrics();
- PushGateway pg = PushGateway.builder().format(Format.PROMETHEUS_TEXT).build();
- System.out.println("Pushing metrics...");
- pg.push();
- System.out.println("Push successful.");
- }
+ private static void runSimpleTest() throws IOException {
+ makeMetrics();
+ PushGateway pg = PushGateway.builder().build();
+ System.out.println("Pushing metrics...");
+ pg.push();
+ System.out.println("Push successful.");
+ }
- private static void runBasicAuthTest() throws IOException {
- makeMetrics();
- PushGateway pg = PushGateway.builder()
- .basicAuth("my_user", "secret_password")
- .build();
- System.out.println("Pushing metrics...");
- pg.push();
- System.out.println("Push successful.");
- }
+ private static void runTextFormatTest() throws IOException {
+ makeMetrics();
+ PushGateway pg = PushGateway.builder().format(Format.PROMETHEUS_TEXT).build();
+ System.out.println("Pushing metrics...");
+ pg.push();
+ System.out.println("Push successful.");
+ }
- private static void runSslTest() throws IOException {
- makeMetrics();
- PushGateway pg = PushGateway.builder()
- .scheme(HTTPS)
- .connectionFactory(insecureConnectionFactory)
- .build();
- System.out.println("Pushing metrics...");
- pg.push();
- System.out.println("Push successful.");
- }
+ private static void runBasicAuthTest() throws IOException {
+ makeMetrics();
+ PushGateway pg = PushGateway.builder().basicAuth("my_user", "secret_password").build();
+ System.out.println("Pushing metrics...");
+ pg.push();
+ System.out.println("Push successful.");
+ }
+
+ private static void runSslTest() throws IOException {
+ makeMetrics();
+ PushGateway pg =
+ PushGateway.builder().scheme(HTTPS).connectionFactory(insecureConnectionFactory).build();
+ System.out.println("Pushing metrics...");
+ pg.push();
+ System.out.println("Push successful.");
+ }
- static TrustManager insecureTrustManager = new X509TrustManager() {
+ static TrustManager insecureTrustManager =
+ new X509TrustManager() {
public java.security.cert.X509Certificate[] getAcceptedIssuers() {
- return null;
+ return null;
}
@Override
- public void checkClientTrusted(X509Certificate[] chain, String authType) {
- }
+ public void checkClientTrusted(X509Certificate[] chain, String authType) {}
@Override
- public void checkServerTrusted(X509Certificate[] chain, String authType) {
- }
- };
+ public void checkServerTrusted(X509Certificate[] chain, String authType) {}
+ };
- static HttpConnectionFactory insecureConnectionFactory = url -> {
+ static HttpConnectionFactory insecureConnectionFactory =
+ url -> {
try {
- SSLContext sslContext = SSLContext.getInstance("TLS");
- sslContext.init(null, new TrustManager[]{insecureTrustManager}, null);
- SSLContext.setDefault(sslContext);
+ SSLContext sslContext = SSLContext.getInstance("TLS");
+ sslContext.init(null, new TrustManager[] {insecureTrustManager}, null);
+ SSLContext.setDefault(sslContext);
- HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
- connection.setHostnameVerifier((hostname, session) -> true);
- return connection;
+ HttpsURLConnection connection = (HttpsURLConnection) url.openConnection();
+ connection.setHostnameVerifier((hostname, session) -> true);
+ return connection;
} catch (NoSuchAlgorithmException | KeyManagementException e) {
- throw new RuntimeException(e);
+ throw new RuntimeException(e);
}
- };
+ };
- private static void makeMetrics() {
- Histogram sizes = Histogram.builder()
- .name("file_sizes_bytes")
- .classicUpperBounds(256, 512, 1024, 2048)
- .unit(Unit.BYTES)
- .register();
- sizes.observe(513);
- sizes.observe(814);
- sizes.observe(1553);
- Gauge duration = Gauge.builder()
- .name("my_batch_job_duration_seconds")
- .help("Duration of my batch job in seconds.")
- .unit(Unit.SECONDS)
- .register();
- duration.set(0.5);
- }
+ private static void makeMetrics() {
+ Histogram sizes =
+ Histogram.builder()
+ .name("file_sizes_bytes")
+ .classicUpperBounds(256, 512, 1024, 2048)
+ .unit(Unit.BYTES)
+ .register();
+ sizes.observe(513);
+ sizes.observe(814);
+ sizes.observe(1553);
+ Gauge duration =
+ Gauge.builder()
+ .name("my_batch_job_duration_seconds")
+ .help("Duration of my batch job in seconds.")
+ .unit(Unit.SECONDS)
+ .register();
+ duration.set(0.5);
+ }
}
diff --git a/integration-tests/it-pushgateway/src/test/java/io/prometheus/metrics/it/pushgateway/PushGatewayIT.java b/integration-tests/it-pushgateway/src/test/java/io/prometheus/metrics/it/pushgateway/PushGatewayIT.java
index 6b89a8c58..7e1198a55 100644
--- a/integration-tests/it-pushgateway/src/test/java/io/prometheus/metrics/it/pushgateway/PushGatewayIT.java
+++ b/integration-tests/it-pushgateway/src/test/java/io/prometheus/metrics/it/pushgateway/PushGatewayIT.java
@@ -6,6 +6,9 @@
import com.squareup.okhttp.*;
import io.prometheus.client.it.common.LogConsumer;
import io.prometheus.client.it.common.Volume;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.concurrent.TimeUnit;
import net.minidev.json.JSONArray;
import org.junit.After;
import org.junit.Assert;
@@ -17,212 +20,247 @@
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.MountableFile;
-import java.io.IOException;
-import java.net.URISyntaxException;
-import java.util.concurrent.TimeUnit;
-
public class PushGatewayIT {
- private GenericContainer sampleAppContainer;
- private GenericContainer pushGatewayContainer;
- private GenericContainer prometheusContainer;
- private Volume sampleAppVolume;
-
- @Before
- public void setUp() throws IOException, URISyntaxException {
- Network network = Network.newNetwork();
- sampleAppVolume = Volume.create("it-pushgateway")
- .copy("pushgateway-test-app.jar");
- pushGatewayContainer = new GenericContainer<>("prom/pushgateway:v1.8.0")
- .withExposedPorts(9091)
- .withNetwork(network)
- .withNetworkAliases("pushgateway")
- .withLogConsumer(LogConsumer.withPrefix("pushgateway"))
- .waitingFor(Wait.forListeningPort());
- sampleAppContainer = new GenericContainer<>("openjdk:17")
- .withFileSystemBind(sampleAppVolume.getHostPath(), "/app", BindMode.READ_ONLY)
- .withNetwork(network)
- .withWorkingDirectory("/app")
- .dependsOn(pushGatewayContainer)
- .withLogConsumer(LogConsumer.withPrefix("test-app"));
- prometheusContainer = new GenericContainer<>("prom/prometheus:v2.51.2")
- .withNetwork(network)
- .dependsOn(pushGatewayContainer)
- .withExposedPorts(9090)
- .withLogConsumer(LogConsumer.withPrefix("prometheus"));
- }
+ private GenericContainer sampleAppContainer;
+ private GenericContainer pushGatewayContainer;
+ private GenericContainer prometheusContainer;
+ private Volume sampleAppVolume;
- @After
- public void tearDown() throws IOException {
- prometheusContainer.stop();
- pushGatewayContainer.stop();
- sampleAppContainer.stop();
- sampleAppVolume.remove();
- }
+ @Before
+ public void setUp() throws IOException, URISyntaxException {
+ Network network = Network.newNetwork();
+ sampleAppVolume = Volume.create("it-pushgateway").copy("pushgateway-test-app.jar");
+ pushGatewayContainer =
+ new GenericContainer<>("prom/pushgateway:v1.8.0")
+ .withExposedPorts(9091)
+ .withNetwork(network)
+ .withNetworkAliases("pushgateway")
+ .withLogConsumer(LogConsumer.withPrefix("pushgateway"))
+ .waitingFor(Wait.forListeningPort());
+ sampleAppContainer =
+ new GenericContainer<>("openjdk:17")
+ .withFileSystemBind(sampleAppVolume.getHostPath(), "/app", BindMode.READ_ONLY)
+ .withNetwork(network)
+ .withWorkingDirectory("/app")
+ .dependsOn(pushGatewayContainer)
+ .withLogConsumer(LogConsumer.withPrefix("test-app"));
+ prometheusContainer =
+ new GenericContainer<>("prom/prometheus:v2.51.2")
+ .withNetwork(network)
+ .dependsOn(pushGatewayContainer)
+ .withExposedPorts(9090)
+ .withLogConsumer(LogConsumer.withPrefix("prometheus"));
+ }
- final OkHttpClient client = new OkHttpClient();
-
- @Test
- public void testSimple() throws IOException, InterruptedException {
- pushGatewayContainer
- .start();
- sampleAppContainer
- .withCommand("java",
- "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
- "-jar",
- "/app/pushgateway-test-app.jar",
- "simple"
- ).start();
- prometheusContainer
- .withCopyFileToContainer(MountableFile.forClasspathResource("/prometheus.yaml"), "/etc/prometheus/prometheus.yml")
- .start();
- awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
- assertMetrics();
- }
+ @After
+ public void tearDown() throws IOException {
+ prometheusContainer.stop();
+ pushGatewayContainer.stop();
+ sampleAppContainer.stop();
+ sampleAppVolume.remove();
+ }
- @Test
- public void testTextFormat() throws IOException, InterruptedException {
- pushGatewayContainer
- .start();
- sampleAppContainer
- .withCommand("java",
- "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
- "-jar",
- "/app/pushgateway-test-app.jar",
- "textFormat"
- ).start();
- prometheusContainer
- .withCopyFileToContainer(MountableFile.forClasspathResource("/prometheus.yaml"), "/etc/prometheus/prometheus.yml")
- .start();
- awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
- assertMetrics();
- }
+ final OkHttpClient client = new OkHttpClient();
- @Test
- public void testBasicAuth() throws IOException, InterruptedException {
- pushGatewayContainer
- .withCopyFileToContainer(MountableFile.forClasspathResource("/pushgateway-basicauth.yaml"), "/pushgateway/pushgateway-basicauth.yaml")
- .withCommand("--web.config.file", "pushgateway-basicauth.yaml")
- .start();
- sampleAppContainer
- .withCommand("java",
- "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
- "-jar",
- "/app/pushgateway-test-app.jar",
- "basicauth"
- ).start();
- prometheusContainer
- .withCopyFileToContainer(MountableFile.forClasspathResource("/prometheus-basicauth.yaml"), "/etc/prometheus/prometheus.yml")
- .start();
- awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
- assertMetrics();
- }
+ @Test
+ public void testSimple() throws IOException, InterruptedException {
+ pushGatewayContainer.start();
+ sampleAppContainer
+ .withCommand(
+ "java",
+ "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
+ "-jar",
+ "/app/pushgateway-test-app.jar",
+ "simple")
+ .start();
+ prometheusContainer
+ .withCopyFileToContainer(
+ MountableFile.forClasspathResource("/prometheus.yaml"),
+ "/etc/prometheus/prometheus.yml")
+ .start();
+ awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
+ assertMetrics();
+ }
- @Test
- public void testSsl() throws InterruptedException, IOException {
- pushGatewayContainer
- .withCopyFileToContainer(MountableFile.forClasspathResource("/pushgateway-ssl.yaml"), "/pushgateway/pushgateway-ssl.yaml")
- .withCommand("--web.config.file", "pushgateway-ssl.yaml")
- .start();
- sampleAppContainer
- .withCommand("java",
- "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
- "-jar",
- "/app/pushgateway-test-app.jar",
- "ssl"
- ).start();
- prometheusContainer
- .withCopyFileToContainer(MountableFile.forClasspathResource("/prometheus-ssl.yaml"), "/etc/prometheus/prometheus.yml")
- .start();
- awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
- assertMetrics();
- }
+ @Test
+ public void testTextFormat() throws IOException, InterruptedException {
+ pushGatewayContainer.start();
+ sampleAppContainer
+ .withCommand(
+ "java",
+ "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
+ "-jar",
+ "/app/pushgateway-test-app.jar",
+ "textFormat")
+ .start();
+ prometheusContainer
+ .withCopyFileToContainer(
+ MountableFile.forClasspathResource("/prometheus.yaml"),
+ "/etc/prometheus/prometheus.yml")
+ .start();
+ awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
+ assertMetrics();
+ }
- @Test
- public void testProtobuf() throws IOException, InterruptedException {
- pushGatewayContainer
- .start();
- sampleAppContainer
- .withCommand("java",
- "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
- "-jar",
- "/app/pushgateway-test-app.jar",
- "simple"
- ).start();
- prometheusContainer
- .withCommand("--enable-feature=native-histograms", "--config.file", "/etc/prometheus/prometheus.yml")
- .withCopyFileToContainer(MountableFile.forClasspathResource("/prometheus.yaml"), "/etc/prometheus/prometheus.yml")
- .start();
- awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
- assertNativeHistogram();
- }
+ @Test
+ public void testBasicAuth() throws IOException, InterruptedException {
+ pushGatewayContainer
+ .withCopyFileToContainer(
+ MountableFile.forClasspathResource("/pushgateway-basicauth.yaml"),
+ "/pushgateway/pushgateway-basicauth.yaml")
+ .withCommand("--web.config.file", "pushgateway-basicauth.yaml")
+ .start();
+ sampleAppContainer
+ .withCommand(
+ "java",
+ "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
+ "-jar",
+ "/app/pushgateway-test-app.jar",
+ "basicauth")
+ .start();
+ prometheusContainer
+ .withCopyFileToContainer(
+ MountableFile.forClasspathResource("/prometheus-basicauth.yaml"),
+ "/etc/prometheus/prometheus.yml")
+ .start();
+ awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
+ assertMetrics();
+ }
- private void assertMetrics() throws IOException, InterruptedException {
- double value = getValue("my_batch_job_duration_seconds", "job", "pushgateway-test-app");
- Assert.assertEquals(0.5, value, 0.0);
- value = getValue("file_sizes_bytes_bucket", "job", "pushgateway-test-app", "le", "512");
- Assert.assertEquals(0.0, value, 0.0);
- value = getValue("file_sizes_bytes_bucket", "job", "pushgateway-test-app", "le", "1024");
- Assert.assertEquals(2.0, value, 0.0);
- value = getValue("file_sizes_bytes_bucket", "job", "pushgateway-test-app", "le", "+Inf");
- Assert.assertEquals(3.0, value, 0.0);
- }
+ @Test
+ public void testSsl() throws InterruptedException, IOException {
+ pushGatewayContainer
+ .withCopyFileToContainer(
+ MountableFile.forClasspathResource("/pushgateway-ssl.yaml"),
+ "/pushgateway/pushgateway-ssl.yaml")
+ .withCommand("--web.config.file", "pushgateway-ssl.yaml")
+ .start();
+ sampleAppContainer
+ .withCommand(
+ "java",
+ "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
+ "-jar",
+ "/app/pushgateway-test-app.jar",
+ "ssl")
+ .start();
+ prometheusContainer
+ .withCopyFileToContainer(
+ MountableFile.forClasspathResource("/prometheus-ssl.yaml"),
+ "/etc/prometheus/prometheus.yml")
+ .start();
+ awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
+ assertMetrics();
+ }
- private double getValue(String name, String... labels) throws IOException, InterruptedException {
- String scrapeResponseJson = scrape(name);
- Criteria criteria = Criteria.where("metric.__name__").eq(name);
- for (int i = 0; i < labels.length; i += 2) {
- criteria = criteria.and("metric." + labels[i]).eq(labels[i + 1]);
- }
- JSONArray result = JsonPath.parse(scrapeResponseJson).read("$.data.result" + Filter.filter(criteria) + ".value[1]");
- Assert.assertEquals(1, result.size());
- return Double.valueOf(result.get(0).toString());
- }
+ @Test
+ public void testProtobuf() throws IOException, InterruptedException {
+ pushGatewayContainer.start();
+ sampleAppContainer
+ .withCommand(
+ "java",
+ "-Dio.prometheus.exporter.pushgateway.address=pushgateway:9091",
+ "-jar",
+ "/app/pushgateway-test-app.jar",
+ "simple")
+ .start();
+ prometheusContainer
+ .withCommand(
+ "--enable-feature=native-histograms", "--config.file", "/etc/prometheus/prometheus.yml")
+ .withCopyFileToContainer(
+ MountableFile.forClasspathResource("/prometheus.yaml"),
+ "/etc/prometheus/prometheus.yml")
+ .start();
+ awaitTermination(sampleAppContainer, 10, TimeUnit.SECONDS);
+ assertNativeHistogram();
+ }
- private void assertNativeHistogram() throws IOException, InterruptedException {
- double count = getNativeHistogramCount("file_sizes_bytes", "pushgateway-test-app");
- Assert.assertEquals(3, count, 0.0);
- }
+ private void assertMetrics() throws IOException, InterruptedException {
+ double value = getValue("my_batch_job_duration_seconds", "job", "pushgateway-test-app");
+ Assert.assertEquals(0.5, value, 0.0);
+ value = getValue("file_sizes_bytes_bucket", "job", "pushgateway-test-app", "le", "512");
+ Assert.assertEquals(0.0, value, 0.0);
+ value = getValue("file_sizes_bytes_bucket", "job", "pushgateway-test-app", "le", "1024");
+ Assert.assertEquals(2.0, value, 0.0);
+ value = getValue("file_sizes_bytes_bucket", "job", "pushgateway-test-app", "le", "+Inf");
+ Assert.assertEquals(3.0, value, 0.0);
+ }
- private double getNativeHistogramCount(String name, String job) throws IOException, InterruptedException {
- String scrapeResponseJson = scrape("histogram_count(" + name + ")");
- Criteria criteria = Criteria.where("metric.job").eq(job);
- JSONArray result = JsonPath.parse(scrapeResponseJson).read("$.data.result" + Filter.filter(criteria) + ".value[1]");
- return Double.valueOf(result.get(0).toString());
+ private double getValue(String name, String... labels) throws IOException, InterruptedException {
+ String scrapeResponseJson = scrape(name);
+ Criteria criteria = Criteria.where("metric.__name__").eq(name);
+ for (int i = 0; i < labels.length; i += 2) {
+ criteria = criteria.and("metric." + labels[i]).eq(labels[i + 1]);
}
+ JSONArray result =
+ JsonPath.parse(scrapeResponseJson)
+ .read("$.data.result" + Filter.filter(criteria) + ".value[1]");
+ Assert.assertEquals(1, result.size());
+ return Double.valueOf(result.get(0).toString());
+ }
+
+ private void assertNativeHistogram() throws IOException, InterruptedException {
+ double count = getNativeHistogramCount("file_sizes_bytes", "pushgateway-test-app");
+ Assert.assertEquals(3, count, 0.0);
+ }
+
+ private double getNativeHistogramCount(String name, String job)
+ throws IOException, InterruptedException {
+ String scrapeResponseJson = scrape("histogram_count(" + name + ")");
+ Criteria criteria = Criteria.where("metric.job").eq(job);
+ JSONArray result =
+ JsonPath.parse(scrapeResponseJson)
+ .read("$.data.result" + Filter.filter(criteria) + ".value[1]");
+ return Double.valueOf(result.get(0).toString());
+ }
- private String scrape(String query) throws IOException, InterruptedException {
- System.out.println("Querying http://" + prometheusContainer.getHost() + ":" + prometheusContainer.getMappedPort(9090));
- HttpUrl baseUrl = HttpUrl.parse("http://" + prometheusContainer.getHost() + ":" + prometheusContainer.getMappedPort(9090) + "/api/v1/query");
- HttpUrl url = baseUrl.newBuilder()
- .addQueryParameter("query", query)
- .build();
- long timeRemaining = TimeUnit.SECONDS.toMillis(15);
- while (timeRemaining > 0) {
- Request request = new Request.Builder().url(url).build();
- Call call = client.newCall(request);
- Response response = call.execute();
- String body = response.body().string();
- if (!body.contains("\"result\":[]")) {
- // Result when data is not available yet:
- // {"status":"success","data":{"resultType":"vector","result":[]}}
- return body;
- }
- Thread.sleep(250);
- timeRemaining -= 250;
- }
- Assert.fail("timeout while scraping " + url);
- return null;
+ private String scrape(String query) throws IOException, InterruptedException {
+ System.out.println(
+ "Querying http://"
+ + prometheusContainer.getHost()
+ + ":"
+ + prometheusContainer.getMappedPort(9090));
+ HttpUrl baseUrl =
+ HttpUrl.parse(
+ "http://"
+ + prometheusContainer.getHost()
+ + ":"
+ + prometheusContainer.getMappedPort(9090)
+ + "/api/v1/query");
+ HttpUrl url = baseUrl.newBuilder().addQueryParameter("query", query).build();
+ long timeRemaining = TimeUnit.SECONDS.toMillis(15);
+ while (timeRemaining > 0) {
+ Request request = new Request.Builder().url(url).build();
+ Call call = client.newCall(request);
+ Response response = call.execute();
+ String body = response.body().string();
+ if (!body.contains("\"result\":[]")) {
+ // Result when data is not available yet:
+ // {"status":"success","data":{"resultType":"vector","result":[]}}
+ return body;
+ }
+ Thread.sleep(250);
+ timeRemaining -= 250;
}
+ Assert.fail("timeout while scraping " + url);
+ return null;
+ }
- private void awaitTermination(GenericContainer container, long timeout, TimeUnit unit) throws InterruptedException {
- long waitTimeMillis = 0;
- while (container.isRunning()) {
- if (waitTimeMillis > unit.toMillis(timeout)) {
- Assert.fail(container.getContainerName() + " did not terminate after " + timeout + " " + unit + ".");
- }
- Thread.sleep(20);
- waitTimeMillis += 20;
- }
+ private void awaitTermination(GenericContainer container, long timeout, TimeUnit unit)
+ throws InterruptedException {
+ long waitTimeMillis = 0;
+ while (container.isRunning()) {
+ if (waitTimeMillis > unit.toMillis(timeout)) {
+ Assert.fail(
+ container.getContainerName()
+ + " did not terminate after "
+ + timeout
+ + " "
+ + unit
+ + ".");
+ }
+ Thread.sleep(20);
+ waitTimeMillis += 20;
}
+ }
}
diff --git a/pom.xml b/pom.xml
index 44eadc391..5ab8f42e2 100644
--- a/pom.xml
+++ b/pom.xml
@@ -169,7 +169,6 @@
com.diffplug.spotless
spotless-maven-plugin
- origin/main
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExemplarsProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExemplarsProperties.java
index ff955bc50..f660725bf 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExemplarsProperties.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExemplarsProperties.java
@@ -2,113 +2,135 @@
import java.util.Map;
-/**
- * Properties starting with io.prometheus.exemplars
- */
+/** Properties starting with io.prometheus.exemplars */
public class ExemplarsProperties {
- private static final String MIN_RETENTION_PERIOD_SECONDS = "minRetentionPeriodSeconds";
- private static final String MAX_RETENTION_PERIOD_SECONDS = "maxRetentionPeriodSeconds";
- private static final String SAMPLE_INTERVAL_MILLISECONDS = "sampleIntervalMilliseconds";
-
- private final Integer minRetentionPeriodSeconds;
- private final Integer maxRetentionPeriodSeconds;
- private final Integer sampleIntervalMilliseconds;
-
- private ExemplarsProperties(
- Integer minRetentionPeriodSeconds,
- Integer maxRetentionPeriodSeconds,
- Integer sampleIntervalMilliseconds) {
- this.minRetentionPeriodSeconds = minRetentionPeriodSeconds;
- this.maxRetentionPeriodSeconds = maxRetentionPeriodSeconds;
- this.sampleIntervalMilliseconds = sampleIntervalMilliseconds;
+ private static final String MIN_RETENTION_PERIOD_SECONDS = "minRetentionPeriodSeconds";
+ private static final String MAX_RETENTION_PERIOD_SECONDS = "maxRetentionPeriodSeconds";
+ private static final String SAMPLE_INTERVAL_MILLISECONDS = "sampleIntervalMilliseconds";
+
+ private final Integer minRetentionPeriodSeconds;
+ private final Integer maxRetentionPeriodSeconds;
+ private final Integer sampleIntervalMilliseconds;
+
+ private ExemplarsProperties(
+ Integer minRetentionPeriodSeconds,
+ Integer maxRetentionPeriodSeconds,
+ Integer sampleIntervalMilliseconds) {
+ this.minRetentionPeriodSeconds = minRetentionPeriodSeconds;
+ this.maxRetentionPeriodSeconds = maxRetentionPeriodSeconds;
+ this.sampleIntervalMilliseconds = sampleIntervalMilliseconds;
+ }
+
+ /**
+ * Minimum time how long Exemplars are kept before they may be replaced by new Exemplars.
+ *
+ * Default see {@code ExemplarSamplerConfig.DEFAULT_MIN_RETENTION_PERIOD_SECONDS}
+ */
+ public Integer getMinRetentionPeriodSeconds() {
+ return minRetentionPeriodSeconds;
+ }
+
+ /**
+ * Maximum time how long Exemplars are kept before they are evicted.
+ *
+ *
Default see {@code ExemplarSamplerConfig.DEFAULT_MAX_RETENTION_PERIOD_SECONDS}
+ */
+ public Integer getMaxRetentionPeriodSeconds() {
+ return maxRetentionPeriodSeconds;
+ }
+
+ /**
+ * Time between attempts to sample new Exemplars. This is a performance improvement for
+ * high-frequency applications, because with the sample interval we make sure that the exemplar
+ * sampler is not called for every single request.
+ *
+ *
Default see {@code ExemplarSamplerConfig.DEFAULT_SAMPLE_INTERVAL_MILLISECONDS}
+ */
+ public Integer getSampleIntervalMilliseconds() {
+ return sampleIntervalMilliseconds;
+ }
+
+ /**
+ * 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.
+ */
+ static ExemplarsProperties load(String prefix, Map properties)
+ throws PrometheusPropertiesException {
+ Integer minRetentionPeriodSeconds =
+ Util.loadInteger(prefix + "." + MIN_RETENTION_PERIOD_SECONDS, properties);
+ Integer maxRetentionPeriodSeconds =
+ Util.loadInteger(prefix + "." + MAX_RETENTION_PERIOD_SECONDS, properties);
+ Integer sampleIntervalMilliseconds =
+ Util.loadInteger(prefix + "." + SAMPLE_INTERVAL_MILLISECONDS, properties);
+
+ Util.assertValue(
+ minRetentionPeriodSeconds,
+ t -> t > 0,
+ "Expecting value > 0.",
+ prefix,
+ MIN_RETENTION_PERIOD_SECONDS);
+ Util.assertValue(
+ minRetentionPeriodSeconds,
+ t -> t > 0,
+ "Expecting value > 0.",
+ prefix,
+ MAX_RETENTION_PERIOD_SECONDS);
+ Util.assertValue(
+ sampleIntervalMilliseconds,
+ t -> t > 0,
+ "Expecting value > 0.",
+ prefix,
+ SAMPLE_INTERVAL_MILLISECONDS);
+
+ if (minRetentionPeriodSeconds != null && maxRetentionPeriodSeconds != null) {
+ if (minRetentionPeriodSeconds > maxRetentionPeriodSeconds) {
+ throw new PrometheusPropertiesException(
+ prefix
+ + "."
+ + MIN_RETENTION_PERIOD_SECONDS
+ + " must not be greater than "
+ + prefix
+ + "."
+ + MAX_RETENTION_PERIOD_SECONDS
+ + ".");
+ }
}
- /**
- * Minimum time how long Exemplars are kept before they may be replaced by new Exemplars.
- *
- * Default see {@code ExemplarSamplerConfig.DEFAULT_MIN_RETENTION_PERIOD_SECONDS}
- */
- public Integer getMinRetentionPeriodSeconds() {
- return minRetentionPeriodSeconds;
- }
-
- /**
- * Maximum time how long Exemplars are kept before they are evicted.
- *
- * Default see {@code ExemplarSamplerConfig.DEFAULT_MAX_RETENTION_PERIOD_SECONDS}
- */
- public Integer getMaxRetentionPeriodSeconds() {
- return maxRetentionPeriodSeconds;
- }
+ return new ExemplarsProperties(
+ minRetentionPeriodSeconds, maxRetentionPeriodSeconds, sampleIntervalMilliseconds);
+ }
- /**
- * Time between attempts to sample new Exemplars. This is a performance improvement for high-frequency
- * applications, because with the sample interval we make sure that the exemplar sampler is not called
- * for every single request.
- *
- * Default see {@code ExemplarSamplerConfig.DEFAULT_SAMPLE_INTERVAL_MILLISECONDS}
- */
- public Integer getSampleIntervalMilliseconds() {
- return sampleIntervalMilliseconds;
- }
+ public static Builder builder() {
+ return new Builder();
+ }
- /**
- * 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.
- */
- static ExemplarsProperties load(String prefix, Map properties) throws PrometheusPropertiesException {
- Integer minRetentionPeriodSeconds = Util.loadInteger(prefix + "." + MIN_RETENTION_PERIOD_SECONDS, properties);
- Integer maxRetentionPeriodSeconds = Util.loadInteger(prefix + "." + MAX_RETENTION_PERIOD_SECONDS, properties);
- Integer sampleIntervalMilliseconds = Util.loadInteger(prefix + "." + SAMPLE_INTERVAL_MILLISECONDS, properties);
-
- Util.assertValue(minRetentionPeriodSeconds, t -> t > 0, "Expecting value > 0.", prefix, MIN_RETENTION_PERIOD_SECONDS);
- Util.assertValue(minRetentionPeriodSeconds, t -> t > 0, "Expecting value > 0.", prefix, MAX_RETENTION_PERIOD_SECONDS);
- Util.assertValue(sampleIntervalMilliseconds, t -> t > 0, "Expecting value > 0.", prefix, SAMPLE_INTERVAL_MILLISECONDS);
-
- if (minRetentionPeriodSeconds != null && maxRetentionPeriodSeconds != null) {
- if (minRetentionPeriodSeconds > maxRetentionPeriodSeconds) {
- throw new PrometheusPropertiesException(prefix + "." + MIN_RETENTION_PERIOD_SECONDS + " must not be greater than " + prefix + "." + MAX_RETENTION_PERIOD_SECONDS + ".");
- }
- }
-
- return new ExemplarsProperties(
- minRetentionPeriodSeconds,
- maxRetentionPeriodSeconds,
- sampleIntervalMilliseconds
- );
- }
+ public static class Builder {
- public static Builder builder() {
- return new Builder();
- }
+ private Integer minRetentionPeriodSeconds;
+ private Integer maxRetentionPeriodSeconds;
+ private Integer sampleIntervalMilliseconds;
- public static class Builder {
+ private Builder() {}
- private Integer minRetentionPeriodSeconds;
- private Integer maxRetentionPeriodSeconds;
- private Integer sampleIntervalMilliseconds;
-
- private Builder() {
- }
-
- public Builder minRetentionPeriodSeconds(int minRetentionPeriodSeconds) {
- this.minRetentionPeriodSeconds = minRetentionPeriodSeconds;
- return this;
- }
+ public Builder minRetentionPeriodSeconds(int minRetentionPeriodSeconds) {
+ this.minRetentionPeriodSeconds = minRetentionPeriodSeconds;
+ return this;
+ }
- public Builder maxRetentionPeriodSeconds(int maxRetentionPeriodSeconds) {
- this.maxRetentionPeriodSeconds = maxRetentionPeriodSeconds;
- return this;
- }
+ public Builder maxRetentionPeriodSeconds(int maxRetentionPeriodSeconds) {
+ this.maxRetentionPeriodSeconds = maxRetentionPeriodSeconds;
+ return this;
+ }
- public Builder sampleIntervalMilliseconds(int sampleIntervalMilliseconds) {
- this.sampleIntervalMilliseconds = sampleIntervalMilliseconds;
- return this;
- }
+ public Builder sampleIntervalMilliseconds(int sampleIntervalMilliseconds) {
+ this.sampleIntervalMilliseconds = sampleIntervalMilliseconds;
+ return this;
+ }
- public ExemplarsProperties build() {
- return new ExemplarsProperties(minRetentionPeriodSeconds, maxRetentionPeriodSeconds, sampleIntervalMilliseconds);
- }
+ public ExemplarsProperties build() {
+ return new ExemplarsProperties(
+ minRetentionPeriodSeconds, maxRetentionPeriodSeconds, sampleIntervalMilliseconds);
}
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterFilterProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterFilterProperties.java
index e9cc46767..4758a48fe 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterFilterProperties.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterFilterProperties.java
@@ -6,112 +6,124 @@
import java.util.List;
import java.util.Map;
-/**
- * Properties starting with io.prometheus.exporter.filter
- */
+/** Properties starting with io.prometheus.exporter.filter */
public class ExporterFilterProperties {
- public static final String METRIC_NAME_MUST_BE_EQUAL_TO = "metricNameMustBeEqualTo";
- public static final String METRIC_NAME_MUST_NOT_BE_EQUAL_TO = "metricNameMustNotBeEqualTo";
- public static final String METRIC_NAME_MUST_START_WITH = "metricNameMustStartWith";
- public static final String METRIC_NAME_MUST_NOT_START_WITH = "metricNameMustNotStartWith";
-
- private final List allowedNames;
- private final List excludedNames;
- private final List allowedPrefixes;
- private final List excludedPrefixes;
-
- private ExporterFilterProperties(List allowedNames, List excludedNames, List allowedPrefixes, List excludedPrefixes) {
- this(allowedNames, excludedNames, allowedPrefixes, excludedPrefixes, "");
- }
-
- private ExporterFilterProperties(List allowedNames, List excludedNames, List allowedPrefixes, List excludedPrefixes, String prefix) {
- this.allowedNames = allowedNames == null ? null : Collections.unmodifiableList(new ArrayList<>(allowedNames));
- this.excludedNames = excludedNames == null ? null : Collections.unmodifiableList(new ArrayList<>(excludedNames));
- this.allowedPrefixes = allowedPrefixes == null ? null : Collections.unmodifiableList(new ArrayList<>(allowedPrefixes));
- this.excludedPrefixes = excludedPrefixes == null ? null : Collections.unmodifiableList(new ArrayList<>(excludedPrefixes));
- validate(prefix);
- }
-
- public List getAllowedMetricNames() {
- return allowedNames;
- }
-
- public List getExcludedMetricNames() {
- return excludedNames;
- }
-
- public List getAllowedMetricNamePrefixes() {
- return allowedPrefixes;
- }
-
- public List getExcludedMetricNamePrefixes() {
- return excludedPrefixes;
+ public static final String METRIC_NAME_MUST_BE_EQUAL_TO = "metricNameMustBeEqualTo";
+ public static final String METRIC_NAME_MUST_NOT_BE_EQUAL_TO = "metricNameMustNotBeEqualTo";
+ public static final String METRIC_NAME_MUST_START_WITH = "metricNameMustStartWith";
+ public static final String METRIC_NAME_MUST_NOT_START_WITH = "metricNameMustNotStartWith";
+
+ private final List allowedNames;
+ private final List excludedNames;
+ private final List allowedPrefixes;
+ private final List excludedPrefixes;
+
+ private ExporterFilterProperties(
+ List allowedNames,
+ List excludedNames,
+ List allowedPrefixes,
+ List excludedPrefixes) {
+ this(allowedNames, excludedNames, allowedPrefixes, excludedPrefixes, "");
+ }
+
+ private ExporterFilterProperties(
+ List allowedNames,
+ List excludedNames,
+ List allowedPrefixes,
+ List excludedPrefixes,
+ String prefix) {
+ this.allowedNames =
+ allowedNames == null ? null : Collections.unmodifiableList(new ArrayList<>(allowedNames));
+ this.excludedNames =
+ excludedNames == null ? null : Collections.unmodifiableList(new ArrayList<>(excludedNames));
+ this.allowedPrefixes =
+ allowedPrefixes == null
+ ? null
+ : Collections.unmodifiableList(new ArrayList<>(allowedPrefixes));
+ this.excludedPrefixes =
+ excludedPrefixes == null
+ ? null
+ : Collections.unmodifiableList(new ArrayList<>(excludedPrefixes));
+ validate(prefix);
+ }
+
+ public List getAllowedMetricNames() {
+ return allowedNames;
+ }
+
+ public List getExcludedMetricNames() {
+ return excludedNames;
+ }
+
+ public List getAllowedMetricNamePrefixes() {
+ return allowedPrefixes;
+ }
+
+ public List getExcludedMetricNamePrefixes() {
+ return excludedPrefixes;
+ }
+
+ private void validate(String prefix) throws PrometheusPropertiesException {}
+
+ /**
+ * 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.
+ */
+ static ExporterFilterProperties load(String prefix, Map properties)
+ throws PrometheusPropertiesException {
+ List allowedNames =
+ Util.loadStringList(prefix + "." + METRIC_NAME_MUST_BE_EQUAL_TO, properties);
+ List excludedNames =
+ Util.loadStringList(prefix + "." + METRIC_NAME_MUST_NOT_BE_EQUAL_TO, properties);
+ List allowedPrefixes =
+ Util.loadStringList(prefix + "." + METRIC_NAME_MUST_START_WITH, properties);
+ List excludedPrefixes =
+ Util.loadStringList(prefix + "." + METRIC_NAME_MUST_NOT_START_WITH, properties);
+ return new ExporterFilterProperties(
+ allowedNames, excludedNames, allowedPrefixes, excludedPrefixes, prefix);
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ public static class Builder {
+
+ private List allowedNames;
+ private List excludedNames;
+ private List allowedPrefixes;
+ private List excludedPrefixes;
+
+ private Builder() {}
+
+ /** Only allowed metric names will be exposed. */
+ public Builder allowedNames(String... allowedNames) {
+ this.allowedNames = Arrays.asList(allowedNames);
+ return this;
}
- private void validate(String prefix) throws PrometheusPropertiesException {
+ /** Excluded metric names will not be exposed. */
+ public Builder excludedNames(String... excludedNames) {
+ this.excludedNames = Arrays.asList(excludedNames);
+ return this;
}
- /**
- * 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.
- */
- static ExporterFilterProperties load(String prefix, Map properties) throws PrometheusPropertiesException {
- List allowedNames = Util.loadStringList(prefix + "." + METRIC_NAME_MUST_BE_EQUAL_TO, properties);
- List excludedNames = Util.loadStringList(prefix + "." + METRIC_NAME_MUST_NOT_BE_EQUAL_TO, properties);
- List allowedPrefixes = Util.loadStringList(prefix + "." + METRIC_NAME_MUST_START_WITH, properties);
- List excludedPrefixes = Util.loadStringList(prefix + "." + METRIC_NAME_MUST_NOT_START_WITH, properties);
- return new ExporterFilterProperties(allowedNames, excludedNames, allowedPrefixes, excludedPrefixes, prefix);
+ /** Only metrics with a name starting with an allowed prefix will be exposed. */
+ public Builder allowedPrefixes(String... allowedPrefixes) {
+ this.allowedPrefixes = Arrays.asList(allowedPrefixes);
+ return this;
}
- public static Builder builder() {
- return new Builder();
+ /** Metrics with a name starting with an excluded prefix will not be exposed. */
+ public Builder excludedPrefixes(String... excludedPrefixes) {
+ this.excludedPrefixes = Arrays.asList(excludedPrefixes);
+ return this;
}
- public static class Builder {
-
- private List allowedNames;
- private List excludedNames;
- private List allowedPrefixes;
- private List excludedPrefixes;
-
- private Builder() {
- }
-
- /**
- * Only allowed metric names will be exposed.
- */
- public Builder allowedNames(String... allowedNames) {
- this.allowedNames = Arrays.asList(allowedNames);
- return this;
- }
-
- /**
- * Excluded metric names will not be exposed.
- */
- public Builder excludedNames(String... excludedNames) {
- this.excludedNames = Arrays.asList(excludedNames);
- return this;
- }
-
- /**
- * Only metrics with a name starting with an allowed prefix will be exposed.
- */
- public Builder allowedPrefixes(String... allowedPrefixes) {
- this.allowedPrefixes = Arrays.asList(allowedPrefixes);
- return this;
- }
-
- /**
- * Metrics with a name starting with an excluded prefix will not be exposed.
- */
- public Builder excludedPrefixes(String... excludedPrefixes) {
- this.excludedPrefixes = Arrays.asList(excludedPrefixes);
- return this;
- }
-
- public ExporterFilterProperties build() {
- return new ExporterFilterProperties(allowedNames, excludedNames, allowedPrefixes, excludedPrefixes);
- }
+ public ExporterFilterProperties build() {
+ return new ExporterFilterProperties(
+ allowedNames, excludedNames, allowedPrefixes, excludedPrefixes);
}
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterHttpServerProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterHttpServerProperties.java
index c458d69d1..fe048ac6b 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterHttpServerProperties.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterHttpServerProperties.java
@@ -2,49 +2,48 @@
import java.util.Map;
-/**
- * Properties starting with io.prometheus.exporter.httpServer
- */
+/** Properties starting with io.prometheus.exporter.httpServer */
public class ExporterHttpServerProperties {
- private static final String PORT = "port";
- private final Integer port;
+ private static final String PORT = "port";
+ private final Integer port;
- private ExporterHttpServerProperties(Integer port) {
- this.port = port;
- }
+ private ExporterHttpServerProperties(Integer port) {
+ this.port = port;
+ }
- public Integer getPort() {
- return port;
- }
+ public Integer getPort() {
+ return port;
+ }
- /**
- * 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.
- */
- static ExporterHttpServerProperties load(String prefix, Map properties) throws PrometheusPropertiesException {
- Integer port = Util.loadInteger(prefix + "." + PORT, properties);
- Util.assertValue(port, t -> t > 0, "Expecting value > 0", prefix, PORT);
- return new ExporterHttpServerProperties(port);
- }
+ /**
+ * 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.
+ */
+ static ExporterHttpServerProperties load(String prefix, Map properties)
+ throws PrometheusPropertiesException {
+ Integer port = Util.loadInteger(prefix + "." + PORT, properties);
+ Util.assertValue(port, t -> t > 0, "Expecting value > 0", prefix, PORT);
+ return new ExporterHttpServerProperties(port);
+ }
- public static Builder builder() {
- return new Builder();
- }
+ public static Builder builder() {
+ return new Builder();
+ }
- public static class Builder {
+ public static class Builder {
- private Integer port;
+ private Integer port;
- private Builder() {}
+ private Builder() {}
- public Builder port(int port) {
- this.port = port;
- return this;
- }
+ public Builder port(int port) {
+ this.port = port;
+ return this;
+ }
- public ExporterHttpServerProperties build() {
- return new ExporterHttpServerProperties(port);
- }
+ public ExporterHttpServerProperties build() {
+ return new ExporterHttpServerProperties(port);
}
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterOpenTelemetryProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterOpenTelemetryProperties.java
index 77bcc21cb..b8498d6c5 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterOpenTelemetryProperties.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterOpenTelemetryProperties.java
@@ -6,188 +6,222 @@
// TODO: JavaDoc is currently only in OpenTelemetryExporter.Builder. Look there for reference.
public class ExporterOpenTelemetryProperties {
- // See https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md
- private static String PROTOCOL = "protocol"; // otel.exporter.otlp.protocol
- private static String ENDPOINT = "endpoint"; // otel.exporter.otlp.endpoint
- private static String HEADERS = "headers"; // otel.exporter.otlp.headers
- private static String INTERVAL_SECONDS = "intervalSeconds"; // otel.metric.export.interval
- private static String TIMEOUT_SECONDS = "timeoutSeconds"; // otel.exporter.otlp.timeout
- private static String SERVICE_NAME = "serviceName"; // otel.service.name
- private static String SERVICE_NAMESPACE = "serviceNamespace";
- private static String SERVICE_INSTANCE_ID = "serviceInstanceId";
- private static String SERVICE_VERSION = "serviceVersion";
- private static String RESOURCE_ATTRIBUTES = "resourceAttributes"; // otel.resource.attributes
-
- private final String protocol;
- private final String endpoint;
- private final Map headers;
- private final Integer intervalSeconds;
- private final Integer timeoutSeconds;
- private final String serviceName;
- private final String serviceNamespace;
- private final String serviceInstanceId;
- private final String serviceVersion;
- private final Map resourceAttributes;
-
- private ExporterOpenTelemetryProperties(String protocol, String endpoint, Map headers, Integer intervalSeconds, Integer timeoutSeconds, String serviceName, String serviceNamespace, String serviceInstanceId, String serviceVersion, Map resourceAttributes) {
- this.protocol = protocol;
- this.endpoint = endpoint;
- this.headers = headers;
- this.intervalSeconds = intervalSeconds;
- this.timeoutSeconds = timeoutSeconds;
- this.serviceName = serviceName;
- this.serviceNamespace = serviceNamespace;
- this.serviceInstanceId = serviceInstanceId;
- this.serviceVersion = serviceVersion;
- this.resourceAttributes = resourceAttributes;
+ // See
+ // https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md
+ private static String PROTOCOL = "protocol"; // otel.exporter.otlp.protocol
+ private static String ENDPOINT = "endpoint"; // otel.exporter.otlp.endpoint
+ private static String HEADERS = "headers"; // otel.exporter.otlp.headers
+ private static String INTERVAL_SECONDS = "intervalSeconds"; // otel.metric.export.interval
+ private static String TIMEOUT_SECONDS = "timeoutSeconds"; // otel.exporter.otlp.timeout
+ private static String SERVICE_NAME = "serviceName"; // otel.service.name
+ private static String SERVICE_NAMESPACE = "serviceNamespace";
+ private static String SERVICE_INSTANCE_ID = "serviceInstanceId";
+ private static String SERVICE_VERSION = "serviceVersion";
+ private static String RESOURCE_ATTRIBUTES = "resourceAttributes"; // otel.resource.attributes
+
+ private final String protocol;
+ private final String endpoint;
+ private final Map headers;
+ private final Integer intervalSeconds;
+ private final Integer timeoutSeconds;
+ private final String serviceName;
+ private final String serviceNamespace;
+ private final String serviceInstanceId;
+ private final String serviceVersion;
+ private final Map resourceAttributes;
+
+ private ExporterOpenTelemetryProperties(
+ String protocol,
+ String endpoint,
+ Map headers,
+ Integer intervalSeconds,
+ Integer timeoutSeconds,
+ String serviceName,
+ String serviceNamespace,
+ String serviceInstanceId,
+ String serviceVersion,
+ Map resourceAttributes) {
+ this.protocol = protocol;
+ this.endpoint = endpoint;
+ this.headers = headers;
+ this.intervalSeconds = intervalSeconds;
+ this.timeoutSeconds = timeoutSeconds;
+ this.serviceName = serviceName;
+ this.serviceNamespace = serviceNamespace;
+ this.serviceInstanceId = serviceInstanceId;
+ this.serviceVersion = serviceVersion;
+ this.resourceAttributes = resourceAttributes;
+ }
+
+ public String getProtocol() {
+ return protocol;
+ }
+
+ public String getEndpoint() {
+ return endpoint;
+ }
+
+ public Map getHeaders() {
+ return headers;
+ }
+
+ public Integer getIntervalSeconds() {
+ return intervalSeconds;
+ }
+
+ public Integer getTimeoutSeconds() {
+ return timeoutSeconds;
+ }
+
+ public String getServiceName() {
+ return serviceName;
+ }
+
+ public String getServiceNamespace() {
+ return serviceNamespace;
+ }
+
+ public String getServiceInstanceId() {
+ return serviceInstanceId;
+ }
+
+ public String getServiceVersion() {
+ return serviceVersion;
+ }
+
+ public Map getResourceAttributes() {
+ return resourceAttributes;
+ }
+
+ /**
+ * 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.
+ */
+ static ExporterOpenTelemetryProperties load(String prefix, Map properties)
+ throws PrometheusPropertiesException {
+ String protocol = Util.loadString(prefix + "." + PROTOCOL, properties);
+ String endpoint = Util.loadString(prefix + "." + ENDPOINT, properties);
+ Map headers = Util.loadMap(prefix + "." + HEADERS, properties);
+ Integer intervalSeconds = Util.loadInteger(prefix + "." + INTERVAL_SECONDS, properties);
+ Integer timeoutSeconds = Util.loadInteger(prefix + "." + TIMEOUT_SECONDS, properties);
+ String serviceName = Util.loadString(prefix + "." + SERVICE_NAME, properties);
+ String serviceNamespace = Util.loadString(prefix + "." + SERVICE_NAMESPACE, properties);
+ String serviceInstanceId = Util.loadString(prefix + "." + SERVICE_INSTANCE_ID, properties);
+ String serviceVersion = Util.loadString(prefix + "." + SERVICE_VERSION, properties);
+ Map resourceAttributes =
+ Util.loadMap(prefix + "." + RESOURCE_ATTRIBUTES, properties);
+ Util.assertValue(intervalSeconds, t -> t > 0, "Expecting value > 0", prefix, INTERVAL_SECONDS);
+ Util.assertValue(timeoutSeconds, t -> t > 0, "Expecting value > 0", prefix, TIMEOUT_SECONDS);
+ if (protocol != null && !protocol.equals("grpc") && !protocol.equals("http/protobuf")) {
+ throw new PrometheusPropertiesException(
+ protocol
+ + ": Unsupported OpenTelemetry exporter protocol. Expecting grpc or http/protobuf");
}
-
- public String getProtocol() {
- return protocol;
- }
-
- public String getEndpoint() {
- return endpoint;
- }
-
- public Map getHeaders() {
- return headers;
+ return new ExporterOpenTelemetryProperties(
+ protocol,
+ endpoint,
+ headers,
+ intervalSeconds,
+ timeoutSeconds,
+ serviceName,
+ serviceNamespace,
+ serviceInstanceId,
+ serviceVersion,
+ resourceAttributes);
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ public static class Builder {
+
+ private String protocol;
+ private String endpoint;
+ private Map headers = new HashMap<>();
+ private Integer intervalSeconds;
+ private Integer timeoutSeconds;
+ private String serviceName;
+ private String serviceNamespace;
+ private String serviceInstanceId;
+ private String serviceVersion;
+ private Map resourceAttributes = new HashMap<>();
+
+ private Builder() {}
+
+ public Builder protocol(String protocol) {
+ if (!protocol.equals("grpc") && !protocol.equals("http/protobuf")) {
+ throw new IllegalArgumentException(
+ protocol + ": Unsupported protocol. Expecting grpc or http/protobuf");
+ }
+ this.protocol = protocol;
+ return this;
}
- public Integer getIntervalSeconds() {
- return intervalSeconds;
+ public Builder endpoint(String endpoint) {
+ this.endpoint = endpoint;
+ return this;
}
- public Integer getTimeoutSeconds() {
- return timeoutSeconds;
+ /** Add a request header. Call multiple times to add multiple headers. */
+ public Builder header(String name, String value) {
+ this.headers.put(name, value);
+ return this;
}
- public String getServiceName() {
- return serviceName;
+ public Builder intervalSeconds(int intervalSeconds) {
+ if (intervalSeconds <= 0) {
+ throw new IllegalArgumentException(intervalSeconds + ": Expecting intervalSeconds > 0");
+ }
+ this.intervalSeconds = intervalSeconds;
+ return this;
}
- public String getServiceNamespace() {
- return serviceNamespace;
+ public Builder timeoutSeconds(int timeoutSeconds) {
+ if (timeoutSeconds <= 0) {
+ throw new IllegalArgumentException(timeoutSeconds + ": Expecting timeoutSeconds > 0");
+ }
+ this.timeoutSeconds = timeoutSeconds;
+ return this;
}
- public String getServiceInstanceId() {
- return serviceInstanceId;
+ public Builder serviceName(String serviceName) {
+ this.serviceName = serviceName;
+ return this;
}
- public String getServiceVersion() {
- return serviceVersion;
+ public Builder serviceNamespace(String serviceNamespace) {
+ this.serviceNamespace = serviceNamespace;
+ return this;
}
- public Map getResourceAttributes() {
- return resourceAttributes;
+ public Builder serviceInstanceId(String serviceInstanceId) {
+ this.serviceInstanceId = serviceInstanceId;
+ return this;
}
- /**
- * 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.
- */
- static ExporterOpenTelemetryProperties load(String prefix, Map properties) throws PrometheusPropertiesException {
- String protocol = Util.loadString(prefix + "." + PROTOCOL, properties);
- String endpoint = Util.loadString(prefix + "." + ENDPOINT, properties);
- Map headers = Util.loadMap(prefix + "." + HEADERS, properties);
- Integer intervalSeconds = Util.loadInteger(prefix + "." + INTERVAL_SECONDS, properties);
- Integer timeoutSeconds = Util.loadInteger(prefix + "." + TIMEOUT_SECONDS, properties);
- String serviceName = Util.loadString(prefix + "." + SERVICE_NAME, properties);
- String serviceNamespace = Util.loadString(prefix + "." + SERVICE_NAMESPACE, properties);
- String serviceInstanceId = Util.loadString(prefix + "." + SERVICE_INSTANCE_ID, properties);
- String serviceVersion = Util.loadString(prefix + "." + SERVICE_VERSION, properties);
- Map resourceAttributes = Util.loadMap(prefix + "." + RESOURCE_ATTRIBUTES, properties);
- Util.assertValue(intervalSeconds, t -> t > 0, "Expecting value > 0", prefix, INTERVAL_SECONDS);
- Util.assertValue(timeoutSeconds, t -> t > 0, "Expecting value > 0", prefix, TIMEOUT_SECONDS);
- if (protocol != null && !protocol.equals("grpc") && !protocol.equals("http/protobuf")) {
- throw new PrometheusPropertiesException(protocol + ": Unsupported OpenTelemetry exporter protocol. Expecting grpc or http/protobuf");
- }
- return new ExporterOpenTelemetryProperties(protocol, endpoint, headers, intervalSeconds, timeoutSeconds, serviceName, serviceNamespace, serviceInstanceId, serviceVersion, resourceAttributes);
+ public Builder serviceVersion(String serviceVersion) {
+ this.serviceVersion = serviceVersion;
+ return this;
}
- public static Builder builder() {
- return new Builder();
+ public Builder resourceAttribute(String name, String value) {
+ this.resourceAttributes.put(name, value);
+ return this;
}
- public static class Builder {
-
- private String protocol;
- private String endpoint;
- private Map headers = new HashMap<>();
- private Integer intervalSeconds;
- private Integer timeoutSeconds;
- private String serviceName;
- private String serviceNamespace;
- private String serviceInstanceId;
- private String serviceVersion;
- private Map resourceAttributes = new HashMap<>();
-
- private Builder() {}
-
- public Builder protocol(String protocol) {
- if (!protocol.equals("grpc") && !protocol.equals("http/protobuf")) {
- throw new IllegalArgumentException(protocol + ": Unsupported protocol. Expecting grpc or http/protobuf");
- }
- this.protocol = protocol;
- return this;
- }
-
- public Builder endpoint(String endpoint) {
- this.endpoint = endpoint;
- return this;
- }
-
- /**
- * Add a request header. Call multiple times to add multiple headers.
- */
- public Builder header(String name, String value) {
- this.headers.put(name, value);
- return this;
- }
-
- public Builder intervalSeconds(int intervalSeconds) {
- if (intervalSeconds <= 0) {
- throw new IllegalArgumentException(intervalSeconds + ": Expecting intervalSeconds > 0");
- }
- this.intervalSeconds = intervalSeconds;
- return this;
- }
-
- public Builder timeoutSeconds(int timeoutSeconds) {
- if (timeoutSeconds <= 0) {
- throw new IllegalArgumentException(timeoutSeconds + ": Expecting timeoutSeconds > 0");
- }
- this.timeoutSeconds = timeoutSeconds;
- return this;
- }
-
- public Builder serviceName(String serviceName) {
- this.serviceName = serviceName;
- return this;
- }
-
- public Builder serviceNamespace(String serviceNamespace) {
- this.serviceNamespace = serviceNamespace;
- return this;
- }
-
- public Builder serviceInstanceId(String serviceInstanceId) {
- this.serviceInstanceId = serviceInstanceId;
- return this;
- }
-
- public Builder serviceVersion(String serviceVersion) {
- this.serviceVersion = serviceVersion;
- return this;
- }
-
- public Builder resourceAttribute(String name, String value) {
- this.resourceAttributes.put(name, value);
- return this;
- }
-
- public ExporterOpenTelemetryProperties build() {
- return new ExporterOpenTelemetryProperties(protocol, endpoint, headers, intervalSeconds, timeoutSeconds, serviceName, serviceNamespace, serviceInstanceId, serviceVersion, resourceAttributes);
- }
+ public ExporterOpenTelemetryProperties build() {
+ return new ExporterOpenTelemetryProperties(
+ protocol,
+ endpoint,
+ headers,
+ intervalSeconds,
+ timeoutSeconds,
+ serviceName,
+ serviceNamespace,
+ serviceInstanceId,
+ serviceVersion,
+ resourceAttributes);
}
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterProperties.java
index 9493b571c..dd0606e6d 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterProperties.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/ExporterProperties.java
@@ -2,77 +2,71 @@
import java.util.Map;
-/**
- * Properties starting with io.prometheus.exporter
- */
+/** Properties starting with io.prometheus.exporter */
public class ExporterProperties {
- private static final String INCLUDE_CREATED_TIMESTAMPS = "includeCreatedTimestamps";
- private static final String EXEMPLARS_ON_ALL_METRIC_TYPES = "exemplarsOnAllMetricTypes";
+ private static final String INCLUDE_CREATED_TIMESTAMPS = "includeCreatedTimestamps";
+ private static final String EXEMPLARS_ON_ALL_METRIC_TYPES = "exemplarsOnAllMetricTypes";
- private final Boolean includeCreatedTimestamps;
- private final Boolean exemplarsOnAllMetricTypes;
+ private final Boolean includeCreatedTimestamps;
+ private final Boolean exemplarsOnAllMetricTypes;
- private ExporterProperties(Boolean includeCreatedTimestamps, Boolean exemplarsOnAllMetricTypes) {
- this.includeCreatedTimestamps = includeCreatedTimestamps;
- this.exemplarsOnAllMetricTypes = exemplarsOnAllMetricTypes;
- }
+ private ExporterProperties(Boolean includeCreatedTimestamps, Boolean exemplarsOnAllMetricTypes) {
+ this.includeCreatedTimestamps = includeCreatedTimestamps;
+ this.exemplarsOnAllMetricTypes = exemplarsOnAllMetricTypes;
+ }
- /**
- * Include the {@code _created} timestamps in text format? Default is {@code false}.
- */
- public boolean getIncludeCreatedTimestamps() {
- return includeCreatedTimestamps != null && includeCreatedTimestamps;
- }
+ /** Include the {@code _created} timestamps in text format? Default is {@code false}. */
+ public boolean getIncludeCreatedTimestamps() {
+ return includeCreatedTimestamps != null && includeCreatedTimestamps;
+ }
- /**
- * Allow Exemplars on all metric types in OpenMetrics format?
- * Default is {@code false}, which means Exemplars will only be added for Counters and Histogram buckets.
- */
- public boolean getExemplarsOnAllMetricTypes() {
- return exemplarsOnAllMetricTypes != null && exemplarsOnAllMetricTypes;
- }
+ /**
+ * Allow Exemplars on all metric types in OpenMetrics format? Default is {@code false}, which
+ * means Exemplars will only be added for Counters and Histogram buckets.
+ */
+ public boolean getExemplarsOnAllMetricTypes() {
+ return exemplarsOnAllMetricTypes != null && exemplarsOnAllMetricTypes;
+ }
- /**
- * 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.
- */
- static ExporterProperties load(String prefix, Map properties) throws PrometheusPropertiesException {
- Boolean includeCreatedTimestamps = Util.loadBoolean(prefix + "." + INCLUDE_CREATED_TIMESTAMPS, properties);
- Boolean exemplarsOnAllMetricTypes = Util.loadBoolean(prefix + "." + EXEMPLARS_ON_ALL_METRIC_TYPES, properties);
- return new ExporterProperties(includeCreatedTimestamps, exemplarsOnAllMetricTypes);
- }
+ /**
+ * 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.
+ */
+ static ExporterProperties load(String prefix, Map properties)
+ throws PrometheusPropertiesException {
+ Boolean includeCreatedTimestamps =
+ Util.loadBoolean(prefix + "." + INCLUDE_CREATED_TIMESTAMPS, properties);
+ Boolean exemplarsOnAllMetricTypes =
+ Util.loadBoolean(prefix + "." + EXEMPLARS_ON_ALL_METRIC_TYPES, properties);
+ return new ExporterProperties(includeCreatedTimestamps, exemplarsOnAllMetricTypes);
+ }
- public static Builder builder() {
- return new Builder();
- }
+ public static Builder builder() {
+ return new Builder();
+ }
- public static class Builder {
+ public static class Builder {
- private Boolean includeCreatedTimestamps;
- private Boolean exemplarsOnAllMetricTypes;
+ private Boolean includeCreatedTimestamps;
+ private Boolean exemplarsOnAllMetricTypes;
- private Builder() {
- }
+ private Builder() {}
- /**
- * See {@link #getIncludeCreatedTimestamps()}
- */
- public Builder includeCreatedTimestamps(boolean includeCreatedTimestamps) {
- this.includeCreatedTimestamps = includeCreatedTimestamps;
- return this;
- }
+ /** See {@link #getIncludeCreatedTimestamps()} */
+ public Builder includeCreatedTimestamps(boolean includeCreatedTimestamps) {
+ this.includeCreatedTimestamps = includeCreatedTimestamps;
+ return this;
+ }
- /**
- * See {@link #getExemplarsOnAllMetricTypes()}.
- */
- public Builder exemplarsOnAllMetricTypes(boolean exemplarsOnAllMetricTypes) {
- this.exemplarsOnAllMetricTypes = exemplarsOnAllMetricTypes;
- return this;
- }
+ /** See {@link #getExemplarsOnAllMetricTypes()}. */
+ public Builder exemplarsOnAllMetricTypes(boolean exemplarsOnAllMetricTypes) {
+ this.exemplarsOnAllMetricTypes = exemplarsOnAllMetricTypes;
+ return this;
+ }
- public ExporterProperties build() {
- return new ExporterProperties(includeCreatedTimestamps, exemplarsOnAllMetricTypes);
- }
+ public ExporterProperties build() {
+ return new ExporterProperties(includeCreatedTimestamps, exemplarsOnAllMetricTypes);
}
+ }
}
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
index f38a7f4af..4a794eba2 100644
--- 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
@@ -4,56 +4,55 @@
public class ExporterPushgatewayProperties {
- private static final String ADDRESS = "address";
- private static final String JOB = "job";
- private static final String SCHEME = "scheme";
- private final String scheme;
- private final String address;
- private final String job;
-
- private ExporterPushgatewayProperties(String address, String job, String scheme) {
- this.address = address;
- this.job = job;
- this.scheme = scheme;
- }
-
- /**
- * Address of the Pushgateway in the form {@code host:port}.
- * Default is {@code localhost:9091}
- */
- public String getAddress() {
- return address;
- }
-
- /**
- * {@code job} label for metrics being pushed.
- * Default is the name of the JAR file that is running.
- */
- public String getJob() {
- return job;
- }
-
- /**
- * Scheme to be used when pushing metrics to the pushgateway.
- * Must be "http" or "https". Default is "http".
- */
- public String getScheme() {
- return scheme;
- }
-
- /**
- * 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.
- */
- static ExporterPushgatewayProperties load(String prefix, Map properties) throws PrometheusPropertiesException {
- String address = Util.loadString(prefix + "." + ADDRESS, properties);
- String job = Util.loadString(prefix + "." + JOB, properties);
- String scheme = Util.loadString(prefix + "." + SCHEME, properties);
- if (scheme != null) {
- if (!scheme.equals("http") && !scheme.equals("https")) {
- throw new PrometheusPropertiesException(prefix + "." + SCHEME + "=" + scheme + ": Illegal value. Expecting 'http' or 'https'.");
- }
- }
- return new ExporterPushgatewayProperties(address, job, scheme);
+ private static final String ADDRESS = "address";
+ private static final String JOB = "job";
+ private static final String SCHEME = "scheme";
+ private final String scheme;
+ private final String address;
+ private final String job;
+
+ private ExporterPushgatewayProperties(String address, String job, String scheme) {
+ this.address = address;
+ this.job = job;
+ this.scheme = scheme;
+ }
+
+ /** Address of the Pushgateway in the form {@code host:port}. Default is {@code localhost:9091} */
+ public String getAddress() {
+ return address;
+ }
+
+ /**
+ * {@code job} label for metrics being pushed. Default is the name of the JAR file that is
+ * running.
+ */
+ public String getJob() {
+ return job;
+ }
+
+ /**
+ * Scheme to be used when pushing metrics to the pushgateway. Must be "http" or "https". Default
+ * is "http".
+ */
+ public String getScheme() {
+ return scheme;
+ }
+
+ /**
+ * 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.
+ */
+ static ExporterPushgatewayProperties load(String prefix, Map properties)
+ throws PrometheusPropertiesException {
+ String address = Util.loadString(prefix + "." + ADDRESS, properties);
+ String job = Util.loadString(prefix + "." + JOB, properties);
+ String scheme = Util.loadString(prefix + "." + SCHEME, properties);
+ if (scheme != null) {
+ if (!scheme.equals("http") && !scheme.equals("https")) {
+ throw new PrometheusPropertiesException(
+ prefix + "." + SCHEME + "=" + scheme + ": Illegal value. Expecting 'http' or 'https'.");
+ }
}
+ return new ExporterPushgatewayProperties(address, job, scheme);
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/MetricsProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/MetricsProperties.java
index 4574d0198..744822005 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/MetricsProperties.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/MetricsProperties.java
@@ -1,432 +1,455 @@
package io.prometheus.metrics.config;
+import static java.util.Collections.unmodifiableList;
+
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
-import static java.util.Collections.unmodifiableList;
-
-/**
- * Properties starting with io.prometheus.metrics
- */
+/** Properties starting with io.prometheus.metrics */
public class MetricsProperties {
- private static final String EXEMPLARS_ENABLED = "exemplarsEnabled";
- private static final String HISTOGRAM_NATIVE_ONLY = "histogramNativeOnly";
- private static final String HISTOGRAM_CLASSIC_ONLY = "histogramClassicOnly";
- private static final String HISTOGRAM_CLASSIC_UPPER_BOUNDS = "histogramClassicUpperBounds";
- private static final String HISTOGRAM_NATIVE_INITIAL_SCHEMA = "histogramNativeInitialSchema";
- private static final String HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD = "histogramNativeMinZeroThreshold";
- private static final String HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD = "histogramNativeMaxZeroThreshold";
- private static final String HISTOGRAM_NATIVE_MAX_NUMBER_OF_BUCKETS = "histogramNativeMaxNumberOfBuckets"; // 0 means unlimited number of buckets
- private static final String HISTOGRAM_NATIVE_RESET_DURATION_SECONDS = "histogramNativeResetDurationSeconds"; // 0 means no reset
- private static final String SUMMARY_QUANTILES = "summaryQuantiles";
- private static final String SUMMARY_QUANTILE_ERRORS = "summaryQuantileErrors";
- private static final String SUMMARY_MAX_AGE_SECONDS = "summaryMaxAgeSeconds";
- private static final String SUMMARY_NUMBER_OF_AGE_BUCKETS = "summaryNumberOfAgeBuckets";
-
- private final Boolean exemplarsEnabled;
- private final Boolean histogramNativeOnly;
- private final Boolean histogramClassicOnly;
- private final List histogramClassicUpperBounds;
- private final Integer histogramNativeInitialSchema;
- private final Double histogramNativeMinZeroThreshold;
- private final Double histogramNativeMaxZeroThreshold;
- private final Integer histogramNativeMaxNumberOfBuckets;
- private final Long histogramNativeResetDurationSeconds;
- private final List summaryQuantiles;
- private final List summaryQuantileErrors;
- private final Long summaryMaxAgeSeconds;
- private final Integer summaryNumberOfAgeBuckets;
-
- public MetricsProperties(
- Boolean exemplarsEnabled,
- Boolean histogramNativeOnly,
- Boolean histogramClassicOnly,
- List histogramClassicUpperBounds,
- Integer histogramNativeInitialSchema,
- Double histogramNativeMinZeroThreshold,
- Double histogramNativeMaxZeroThreshold,
- Integer histogramNativeMaxNumberOfBuckets,
- Long histogramNativeResetDurationSeconds,
- List summaryQuantiles,
- List summaryQuantileErrors,
- Long summaryMaxAgeSeconds,
- Integer summaryNumberOfAgeBuckets) {
- this(exemplarsEnabled,
- histogramNativeOnly,
- histogramClassicOnly,
- histogramClassicUpperBounds,
- histogramNativeInitialSchema,
- histogramNativeMinZeroThreshold,
- histogramNativeMaxZeroThreshold,
- histogramNativeMaxNumberOfBuckets,
- histogramNativeResetDurationSeconds,
- summaryQuantiles,
- summaryQuantileErrors,
- summaryMaxAgeSeconds,
- summaryNumberOfAgeBuckets,
- "");
+ private static final String EXEMPLARS_ENABLED = "exemplarsEnabled";
+ private static final String HISTOGRAM_NATIVE_ONLY = "histogramNativeOnly";
+ private static final String HISTOGRAM_CLASSIC_ONLY = "histogramClassicOnly";
+ private static final String HISTOGRAM_CLASSIC_UPPER_BOUNDS = "histogramClassicUpperBounds";
+ private static final String HISTOGRAM_NATIVE_INITIAL_SCHEMA = "histogramNativeInitialSchema";
+ private static final String HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD =
+ "histogramNativeMinZeroThreshold";
+ private static final String HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD =
+ "histogramNativeMaxZeroThreshold";
+ private static final String HISTOGRAM_NATIVE_MAX_NUMBER_OF_BUCKETS =
+ "histogramNativeMaxNumberOfBuckets"; // 0 means unlimited number of buckets
+ private static final String HISTOGRAM_NATIVE_RESET_DURATION_SECONDS =
+ "histogramNativeResetDurationSeconds"; // 0 means no reset
+ private static final String SUMMARY_QUANTILES = "summaryQuantiles";
+ private static final String SUMMARY_QUANTILE_ERRORS = "summaryQuantileErrors";
+ private static final String SUMMARY_MAX_AGE_SECONDS = "summaryMaxAgeSeconds";
+ private static final String SUMMARY_NUMBER_OF_AGE_BUCKETS = "summaryNumberOfAgeBuckets";
+
+ private final Boolean exemplarsEnabled;
+ private final Boolean histogramNativeOnly;
+ private final Boolean histogramClassicOnly;
+ private final List histogramClassicUpperBounds;
+ private final Integer histogramNativeInitialSchema;
+ private final Double histogramNativeMinZeroThreshold;
+ private final Double histogramNativeMaxZeroThreshold;
+ private final Integer histogramNativeMaxNumberOfBuckets;
+ private final Long histogramNativeResetDurationSeconds;
+ private final List summaryQuantiles;
+ private final List summaryQuantileErrors;
+ private final Long summaryMaxAgeSeconds;
+ private final Integer summaryNumberOfAgeBuckets;
+
+ public MetricsProperties(
+ Boolean exemplarsEnabled,
+ Boolean histogramNativeOnly,
+ Boolean histogramClassicOnly,
+ List histogramClassicUpperBounds,
+ Integer histogramNativeInitialSchema,
+ Double histogramNativeMinZeroThreshold,
+ Double histogramNativeMaxZeroThreshold,
+ Integer histogramNativeMaxNumberOfBuckets,
+ Long histogramNativeResetDurationSeconds,
+ List summaryQuantiles,
+ List summaryQuantileErrors,
+ Long summaryMaxAgeSeconds,
+ Integer summaryNumberOfAgeBuckets) {
+ this(
+ exemplarsEnabled,
+ histogramNativeOnly,
+ histogramClassicOnly,
+ histogramClassicUpperBounds,
+ histogramNativeInitialSchema,
+ histogramNativeMinZeroThreshold,
+ histogramNativeMaxZeroThreshold,
+ histogramNativeMaxNumberOfBuckets,
+ histogramNativeResetDurationSeconds,
+ summaryQuantiles,
+ summaryQuantileErrors,
+ summaryMaxAgeSeconds,
+ summaryNumberOfAgeBuckets,
+ "");
+ }
+
+ private MetricsProperties(
+ Boolean exemplarsEnabled,
+ Boolean histogramNativeOnly,
+ Boolean histogramClassicOnly,
+ List histogramClassicUpperBounds,
+ Integer histogramNativeInitialSchema,
+ Double histogramNativeMinZeroThreshold,
+ Double histogramNativeMaxZeroThreshold,
+ Integer histogramNativeMaxNumberOfBuckets,
+ Long histogramNativeResetDurationSeconds,
+ List summaryQuantiles,
+ List summaryQuantileErrors,
+ Long summaryMaxAgeSeconds,
+ Integer summaryNumberOfAgeBuckets,
+ String configPropertyPrefix) {
+ this.exemplarsEnabled = exemplarsEnabled;
+ this.histogramNativeOnly = isHistogramNativeOnly(histogramClassicOnly, histogramNativeOnly);
+ this.histogramClassicOnly = isHistogramClassicOnly(histogramClassicOnly, histogramNativeOnly);
+ this.histogramClassicUpperBounds =
+ histogramClassicUpperBounds == null
+ ? null
+ : unmodifiableList(new ArrayList<>(histogramClassicUpperBounds));
+ this.histogramNativeInitialSchema = histogramNativeInitialSchema;
+ this.histogramNativeMinZeroThreshold = histogramNativeMinZeroThreshold;
+ this.histogramNativeMaxZeroThreshold = histogramNativeMaxZeroThreshold;
+ this.histogramNativeMaxNumberOfBuckets = histogramNativeMaxNumberOfBuckets;
+ this.histogramNativeResetDurationSeconds = histogramNativeResetDurationSeconds;
+ this.summaryQuantiles =
+ summaryQuantiles == null ? null : unmodifiableList(new ArrayList<>(summaryQuantiles));
+ this.summaryQuantileErrors =
+ summaryQuantileErrors == null
+ ? null
+ : unmodifiableList(new ArrayList<>(summaryQuantileErrors));
+ this.summaryMaxAgeSeconds = summaryMaxAgeSeconds;
+ this.summaryNumberOfAgeBuckets = summaryNumberOfAgeBuckets;
+ validate(configPropertyPrefix);
+ }
+
+ private Boolean isHistogramClassicOnly(
+ Boolean histogramClassicOnly, Boolean histogramNativeOnly) {
+ if (histogramClassicOnly == null && histogramNativeOnly == null) {
+ return null;
}
-
- private MetricsProperties(
- Boolean exemplarsEnabled,
- Boolean histogramNativeOnly,
- Boolean histogramClassicOnly,
- List histogramClassicUpperBounds,
- Integer histogramNativeInitialSchema,
- Double histogramNativeMinZeroThreshold,
- Double histogramNativeMaxZeroThreshold,
- Integer histogramNativeMaxNumberOfBuckets,
- Long histogramNativeResetDurationSeconds,
- List summaryQuantiles,
- List summaryQuantileErrors,
- Long summaryMaxAgeSeconds,
- Integer summaryNumberOfAgeBuckets,
- String configPropertyPrefix) {
- this.exemplarsEnabled = exemplarsEnabled;
- this.histogramNativeOnly = isHistogramNativeOnly(histogramClassicOnly, histogramNativeOnly);
- this.histogramClassicOnly = isHistogramClassicOnly(histogramClassicOnly, histogramNativeOnly);
- this.histogramClassicUpperBounds = histogramClassicUpperBounds == null ? null : unmodifiableList(new ArrayList<>(histogramClassicUpperBounds));
- this.histogramNativeInitialSchema = histogramNativeInitialSchema;
- this.histogramNativeMinZeroThreshold = histogramNativeMinZeroThreshold;
- this.histogramNativeMaxZeroThreshold = histogramNativeMaxZeroThreshold;
- this.histogramNativeMaxNumberOfBuckets = histogramNativeMaxNumberOfBuckets;
- this.histogramNativeResetDurationSeconds = histogramNativeResetDurationSeconds;
- this.summaryQuantiles = summaryQuantiles == null ? null : unmodifiableList(new ArrayList<>(summaryQuantiles));
- this.summaryQuantileErrors = summaryQuantileErrors == null ? null : unmodifiableList(new ArrayList<>(summaryQuantileErrors));
- this.summaryMaxAgeSeconds = summaryMaxAgeSeconds;
- this.summaryNumberOfAgeBuckets = summaryNumberOfAgeBuckets;
- validate(configPropertyPrefix);
+ if (histogramClassicOnly != null) {
+ return histogramClassicOnly;
}
+ return !histogramNativeOnly;
+ }
-
- private Boolean isHistogramClassicOnly(Boolean histogramClassicOnly, Boolean histogramNativeOnly) {
- if (histogramClassicOnly == null && histogramNativeOnly == null) {
- return null;
- }
- if (histogramClassicOnly != null) {
- return histogramClassicOnly;
- }
- return !histogramNativeOnly;
+ private Boolean isHistogramNativeOnly(Boolean histogramClassicOnly, Boolean histogramNativeOnly) {
+ if (histogramClassicOnly == null && histogramNativeOnly == null) {
+ return null;
}
-
- private Boolean isHistogramNativeOnly(Boolean histogramClassicOnly, Boolean histogramNativeOnly) {
- if (histogramClassicOnly == null && histogramNativeOnly == null) {
- return null;
- }
- if (histogramNativeOnly != null) {
- return histogramNativeOnly;
- }
- return !histogramClassicOnly;
+ if (histogramNativeOnly != null) {
+ return histogramNativeOnly;
+ }
+ return !histogramClassicOnly;
+ }
+
+ private void validate(String prefix) throws PrometheusPropertiesException {
+ Util.assertValue(
+ histogramNativeInitialSchema,
+ s -> s >= -4 && s <= 8,
+ "Expecting number between -4 and +8.",
+ prefix,
+ HISTOGRAM_NATIVE_INITIAL_SCHEMA);
+ Util.assertValue(
+ histogramNativeMinZeroThreshold,
+ t -> t >= 0,
+ "Expecting value >= 0.",
+ prefix,
+ HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD);
+ Util.assertValue(
+ histogramNativeMaxZeroThreshold,
+ t -> t >= 0,
+ "Expecting value >= 0.",
+ prefix,
+ HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD);
+ Util.assertValue(
+ histogramNativeMaxNumberOfBuckets,
+ n -> n >= 0,
+ "Expecting value >= 0.",
+ prefix,
+ HISTOGRAM_NATIVE_MAX_NUMBER_OF_BUCKETS);
+ Util.assertValue(
+ histogramNativeResetDurationSeconds,
+ t -> t >= 0,
+ "Expecting value >= 0.",
+ prefix,
+ HISTOGRAM_NATIVE_RESET_DURATION_SECONDS);
+ Util.assertValue(
+ summaryMaxAgeSeconds, t -> t > 0, "Expecting value > 0", prefix, SUMMARY_MAX_AGE_SECONDS);
+ Util.assertValue(
+ summaryNumberOfAgeBuckets,
+ t -> t > 0,
+ "Expecting value > 0",
+ prefix,
+ SUMMARY_NUMBER_OF_AGE_BUCKETS);
+
+ if (Boolean.TRUE.equals(histogramNativeOnly) && Boolean.TRUE.equals(histogramClassicOnly)) {
+ throw new PrometheusPropertiesException(
+ prefix
+ + "."
+ + HISTOGRAM_NATIVE_ONLY
+ + " and "
+ + prefix
+ + "."
+ + HISTOGRAM_CLASSIC_ONLY
+ + " cannot both be true");
}
- private void validate(String prefix) throws PrometheusPropertiesException {
- Util.assertValue(histogramNativeInitialSchema, s -> s >= -4 && s <= 8, "Expecting number between -4 and +8.", prefix, HISTOGRAM_NATIVE_INITIAL_SCHEMA);
- Util.assertValue(histogramNativeMinZeroThreshold, t -> t >= 0, "Expecting value >= 0.", prefix, HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD);
- Util.assertValue(histogramNativeMaxZeroThreshold, t -> t >= 0, "Expecting value >= 0.", prefix, HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD);
- Util.assertValue(histogramNativeMaxNumberOfBuckets, n -> n >= 0, "Expecting value >= 0.", prefix, HISTOGRAM_NATIVE_MAX_NUMBER_OF_BUCKETS);
- Util.assertValue(histogramNativeResetDurationSeconds, t -> t >= 0, "Expecting value >= 0.", prefix, HISTOGRAM_NATIVE_RESET_DURATION_SECONDS);
- Util.assertValue(summaryMaxAgeSeconds, t -> t > 0, "Expecting value > 0", prefix, SUMMARY_MAX_AGE_SECONDS);
- Util.assertValue(summaryNumberOfAgeBuckets, t -> t > 0, "Expecting value > 0", prefix, SUMMARY_NUMBER_OF_AGE_BUCKETS);
-
- if (Boolean.TRUE.equals(histogramNativeOnly) && Boolean.TRUE.equals(histogramClassicOnly)) {
- throw new PrometheusPropertiesException(prefix + "." + HISTOGRAM_NATIVE_ONLY + " and " + prefix + "." + HISTOGRAM_CLASSIC_ONLY + " cannot both be true");
- }
-
- if (histogramNativeMinZeroThreshold != null && histogramNativeMaxZeroThreshold != null) {
- if (histogramNativeMinZeroThreshold > histogramNativeMaxZeroThreshold) {
- throw new PrometheusPropertiesException(prefix + "." + HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD + " cannot be greater than " + prefix + "." + HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD);
- }
- }
+ if (histogramNativeMinZeroThreshold != null && histogramNativeMaxZeroThreshold != null) {
+ if (histogramNativeMinZeroThreshold > histogramNativeMaxZeroThreshold) {
+ throw new PrometheusPropertiesException(
+ prefix
+ + "."
+ + HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD
+ + " cannot be greater than "
+ + prefix
+ + "."
+ + HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD);
+ }
+ }
- if (summaryQuantiles != null) {
- for (double quantile : summaryQuantiles) {
- if (quantile < 0 || quantile > 1) {
- throw new PrometheusPropertiesException(prefix + "." + SUMMARY_QUANTILES + ": Expecting 0.0 <= quantile <= 1.0");
- }
- }
+ if (summaryQuantiles != null) {
+ for (double quantile : summaryQuantiles) {
+ if (quantile < 0 || quantile > 1) {
+ throw new PrometheusPropertiesException(
+ prefix + "." + SUMMARY_QUANTILES + ": Expecting 0.0 <= quantile <= 1.0");
}
+ }
+ }
- if (summaryQuantileErrors != null) {
- if (summaryQuantiles == null) {
- throw new PrometheusPropertiesException(prefix + "." + SUMMARY_QUANTILE_ERRORS + ": Can't configure " + SUMMARY_QUANTILE_ERRORS + " without configuring " + SUMMARY_QUANTILES);
- }
- if (summaryQuantileErrors.size() != summaryQuantiles.size()) {
- throw new PrometheusPropertiesException(prefix + "." + SUMMARY_QUANTILE_ERRORS + ": must have the same length as " + SUMMARY_QUANTILES);
- }
- for (double error : summaryQuantileErrors) {
- if (error < 0 || error > 1) {
- throw new PrometheusPropertiesException(prefix + "." + SUMMARY_QUANTILE_ERRORS + ": Expecting 0.0 <= error <= 1.0");
- }
- }
+ if (summaryQuantileErrors != null) {
+ if (summaryQuantiles == null) {
+ throw new PrometheusPropertiesException(
+ prefix
+ + "."
+ + SUMMARY_QUANTILE_ERRORS
+ + ": Can't configure "
+ + SUMMARY_QUANTILE_ERRORS
+ + " without configuring "
+ + SUMMARY_QUANTILES);
+ }
+ if (summaryQuantileErrors.size() != summaryQuantiles.size()) {
+ throw new PrometheusPropertiesException(
+ prefix
+ + "."
+ + SUMMARY_QUANTILE_ERRORS
+ + ": must have the same length as "
+ + SUMMARY_QUANTILES);
+ }
+ for (double error : summaryQuantileErrors) {
+ if (error < 0 || error > 1) {
+ throw new PrometheusPropertiesException(
+ prefix + "." + SUMMARY_QUANTILE_ERRORS + ": Expecting 0.0 <= error <= 1.0");
}
+ }
}
-
- /**
- * This is the only configuration property that can be applied to all metric types.
- * You can use it to turn Exemplar support off. Default is {@code true}.
- */
- public Boolean getExemplarsEnabled() {
- return exemplarsEnabled;
+ }
+
+ /**
+ * This is the only configuration property that can be applied to all metric types. You can use it
+ * to turn Exemplar support off. Default is {@code true}.
+ */
+ public Boolean getExemplarsEnabled() {
+ return exemplarsEnabled;
+ }
+
+ /** See {@code Histogram.Builder.nativeOnly()} */
+ public Boolean getHistogramNativeOnly() {
+ return histogramNativeOnly;
+ }
+
+ /** See {@code Histogram.Builder.classicOnly()} */
+ public Boolean getHistogramClassicOnly() {
+ return histogramClassicOnly;
+ }
+
+ /** See {@code Histogram.Builder.classicBuckets()} */
+ public List getHistogramClassicUpperBounds() {
+ return histogramClassicUpperBounds;
+ }
+
+ /** See {@code Histogram.Builder.nativeInitialSchema()} */
+ public Integer getHistogramNativeInitialSchema() {
+ return histogramNativeInitialSchema;
+ }
+
+ /** See {@code Histogram.Builder.nativeMinZeroThreshold()} */
+ public Double getHistogramNativeMinZeroThreshold() {
+ return histogramNativeMinZeroThreshold;
+ }
+
+ /** See {@code Histogram.Builder.nativeMaxZeroThreshold()} */
+ public Double getHistogramNativeMaxZeroThreshold() {
+ return histogramNativeMaxZeroThreshold;
+ }
+
+ /** See {@code Histogram.Builder.nativeMaxNumberOfBuckets()} */
+ public Integer getHistogramNativeMaxNumberOfBuckets() {
+ return histogramNativeMaxNumberOfBuckets;
+ }
+
+ /** See {@code Histogram.Builder.nativeResetDuration()} */
+ public Long getHistogramNativeResetDurationSeconds() {
+ return histogramNativeResetDurationSeconds;
+ }
+
+ /** See {@code Summary.Builder.quantile()} */
+ public List getSummaryQuantiles() {
+ return summaryQuantiles;
+ }
+
+ /**
+ * See {@code Summary.Builder.quantile()}
+ *
+ * Returns {@code null} only if {@link #getSummaryQuantiles()} is also {@code null}. Returns an
+ * empty list if {@link #getSummaryQuantiles()} are specified without specifying errors. If the
+ * list is not empty, it has the same size as {@link #getSummaryQuantiles()}.
+ */
+ public List getSummaryQuantileErrors() {
+ if (summaryQuantiles != null) {
+ if (summaryQuantileErrors == null) {
+ return Collections.emptyList();
+ }
}
-
- /**
- * See {@code Histogram.Builder.nativeOnly()}
- */
- public Boolean getHistogramNativeOnly() {
- return histogramNativeOnly;
+ return summaryQuantileErrors;
+ }
+
+ /** See {@code Summary.Builder.maxAgeSeconds()} */
+ public Long getSummaryMaxAgeSeconds() {
+ return summaryMaxAgeSeconds;
+ }
+
+ /** See {@code Summary.Builder.numberOfAgeBuckets()} */
+ public Integer getSummaryNumberOfAgeBuckets() {
+ return summaryNumberOfAgeBuckets;
+ }
+
+ /**
+ * 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.
+ */
+ static MetricsProperties load(String prefix, Map properties)
+ throws PrometheusPropertiesException {
+ return new MetricsProperties(
+ Util.loadBoolean(prefix + "." + EXEMPLARS_ENABLED, properties),
+ Util.loadBoolean(prefix + "." + HISTOGRAM_NATIVE_ONLY, properties),
+ Util.loadBoolean(prefix + "." + HISTOGRAM_CLASSIC_ONLY, properties),
+ Util.loadDoubleList(prefix + "." + HISTOGRAM_CLASSIC_UPPER_BOUNDS, properties),
+ Util.loadInteger(prefix + "." + HISTOGRAM_NATIVE_INITIAL_SCHEMA, properties),
+ Util.loadDouble(prefix + "." + HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD, properties),
+ Util.loadDouble(prefix + "." + HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD, properties),
+ Util.loadInteger(prefix + "." + HISTOGRAM_NATIVE_MAX_NUMBER_OF_BUCKETS, properties),
+ Util.loadLong(prefix + "." + HISTOGRAM_NATIVE_RESET_DURATION_SECONDS, properties),
+ Util.loadDoubleList(prefix + "." + SUMMARY_QUANTILES, properties),
+ Util.loadDoubleList(prefix + "." + SUMMARY_QUANTILE_ERRORS, properties),
+ Util.loadLong(prefix + "." + SUMMARY_MAX_AGE_SECONDS, properties),
+ Util.loadInteger(prefix + "." + SUMMARY_NUMBER_OF_AGE_BUCKETS, properties),
+ prefix);
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ public static class Builder {
+ private Boolean exemplarsEnabled;
+ private Boolean histogramNativeOnly;
+ private Boolean histogramClassicOnly;
+ private List histogramClassicUpperBounds;
+ private Integer histogramNativeInitialSchema;
+ private Double histogramNativeMinZeroThreshold;
+ private Double histogramNativeMaxZeroThreshold;
+ private Integer histogramNativeMaxNumberOfBuckets;
+ private Long histogramNativeResetDurationSeconds;
+ private List summaryQuantiles;
+ private List summaryQuantileErrors;
+ private Long summaryMaxAgeSeconds;
+ private Integer summaryNumberOfAgeBuckets;
+
+ private Builder() {}
+
+ public MetricsProperties build() {
+ return new MetricsProperties(
+ exemplarsEnabled,
+ histogramNativeOnly,
+ histogramClassicOnly,
+ histogramClassicUpperBounds,
+ histogramNativeInitialSchema,
+ histogramNativeMinZeroThreshold,
+ histogramNativeMaxZeroThreshold,
+ histogramNativeMaxNumberOfBuckets,
+ histogramNativeResetDurationSeconds,
+ summaryQuantiles,
+ summaryQuantileErrors,
+ summaryMaxAgeSeconds,
+ summaryNumberOfAgeBuckets);
}
- /**
- * See {@code Histogram.Builder.classicOnly()}
- */
- public Boolean getHistogramClassicOnly() {
- return histogramClassicOnly;
+ /** See {@link MetricsProperties#getExemplarsEnabled()} */
+ public Builder exemplarsEnabled(Boolean exemplarsEnabled) {
+ this.exemplarsEnabled = exemplarsEnabled;
+ return this;
}
- /**
- * See {@code Histogram.Builder.classicBuckets()}
- */
- public List getHistogramClassicUpperBounds() {
- return histogramClassicUpperBounds;
+ /** See {@link MetricsProperties#getHistogramNativeOnly()} */
+ public Builder histogramNativeOnly(Boolean histogramNativeOnly) {
+ this.histogramNativeOnly = histogramNativeOnly;
+ return this;
}
- /**
- * See {@code Histogram.Builder.nativeInitialSchema()}
- */
- public Integer getHistogramNativeInitialSchema() {
- return histogramNativeInitialSchema;
+ /** See {@link MetricsProperties#getHistogramClassicOnly()} */
+ public Builder histogramClassicOnly(Boolean histogramClassicOnly) {
+ this.histogramClassicOnly = histogramClassicOnly;
+ return this;
}
- /**
- * See {@code Histogram.Builder.nativeMinZeroThreshold()}
- */
- public Double getHistogramNativeMinZeroThreshold() {
- return histogramNativeMinZeroThreshold;
+ /** See {@link MetricsProperties#getHistogramClassicUpperBounds()} */
+ public Builder histogramClassicUpperBounds(double... histogramClassicUpperBounds) {
+ this.histogramClassicUpperBounds = Util.toList(histogramClassicUpperBounds);
+ return this;
}
- /**
- * See {@code Histogram.Builder.nativeMaxZeroThreshold()}
- */
- public Double getHistogramNativeMaxZeroThreshold() {
- return histogramNativeMaxZeroThreshold;
+ /** See {@link MetricsProperties#getHistogramNativeInitialSchema()} */
+ public Builder histogramNativeInitialSchema(Integer histogramNativeInitialSchema) {
+ this.histogramNativeInitialSchema = histogramNativeInitialSchema;
+ return this;
}
- /**
- * See {@code Histogram.Builder.nativeMaxNumberOfBuckets()}
- */
- public Integer getHistogramNativeMaxNumberOfBuckets() {
- return histogramNativeMaxNumberOfBuckets;
+ /** See {@link MetricsProperties#getHistogramNativeMinZeroThreshold()} */
+ public Builder histogramNativeMinZeroThreshold(Double histogramNativeMinZeroThreshold) {
+ this.histogramNativeMinZeroThreshold = histogramNativeMinZeroThreshold;
+ return this;
}
- /**
- * See {@code Histogram.Builder.nativeResetDuration()}
- */
- public Long getHistogramNativeResetDurationSeconds() {
- return histogramNativeResetDurationSeconds;
+ /** See {@link MetricsProperties#getHistogramNativeMaxZeroThreshold()} */
+ public Builder histogramNativeMaxZeroThreshold(Double histogramNativeMaxZeroThreshold) {
+ this.histogramNativeMaxZeroThreshold = histogramNativeMaxZeroThreshold;
+ return this;
}
- /**
- * See {@code Summary.Builder.quantile()}
- */
- public List getSummaryQuantiles() {
- return summaryQuantiles;
+ /** See {@link MetricsProperties#getHistogramNativeMaxNumberOfBuckets()} */
+ public Builder histogramNativeMaxNumberOfBuckets(Integer histogramNativeMaxNumberOfBuckets) {
+ this.histogramNativeMaxNumberOfBuckets = histogramNativeMaxNumberOfBuckets;
+ return this;
}
- /**
- * See {@code Summary.Builder.quantile()}
- *
- * Returns {@code null} only if {@link #getSummaryQuantiles()} is also {@code null}.
- * Returns an empty list if {@link #getSummaryQuantiles()} are specified without specifying errors.
- * If the list is not empty, it has the same size as {@link #getSummaryQuantiles()}.
- */
- public List getSummaryQuantileErrors() {
- if (summaryQuantiles != null) {
- if (summaryQuantileErrors == null) {
- return Collections.emptyList();
- }
- }
- return summaryQuantileErrors;
+ /** See {@link MetricsProperties#getHistogramNativeResetDurationSeconds()} */
+ public Builder histogramNativeResetDurationSeconds(Long histogramNativeResetDurationSeconds) {
+ this.histogramNativeResetDurationSeconds = histogramNativeResetDurationSeconds;
+ return this;
}
- /**
- * See {@code Summary.Builder.maxAgeSeconds()}
- */
- public Long getSummaryMaxAgeSeconds() {
- return summaryMaxAgeSeconds;
+ /** See {@link MetricsProperties#getSummaryQuantiles()} */
+ public Builder summaryQuantiles(double... summaryQuantiles) {
+ this.summaryQuantiles = Util.toList(summaryQuantiles);
+ return this;
}
- /**
- * See {@code Summary.Builder.numberOfAgeBuckets()}
- */
- public Integer getSummaryNumberOfAgeBuckets() {
- return summaryNumberOfAgeBuckets;
+ /** See {@link MetricsProperties#getSummaryQuantileErrors()} */
+ public Builder summaryQuantileErrors(double... summaryQuantileErrors) {
+ this.summaryQuantileErrors = Util.toList(summaryQuantileErrors);
+ return this;
}
- /**
- * 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.
- */
- static MetricsProperties load(String prefix, Map properties) throws PrometheusPropertiesException {
- return new MetricsProperties(
- Util.loadBoolean(prefix + "." + EXEMPLARS_ENABLED, properties),
- Util.loadBoolean(prefix + "." + HISTOGRAM_NATIVE_ONLY, properties),
- Util.loadBoolean(prefix + "." + HISTOGRAM_CLASSIC_ONLY, properties),
- Util.loadDoubleList(prefix + "." + HISTOGRAM_CLASSIC_UPPER_BOUNDS, properties),
- Util.loadInteger(prefix + "." + HISTOGRAM_NATIVE_INITIAL_SCHEMA, properties),
- Util.loadDouble(prefix + "." + HISTOGRAM_NATIVE_MIN_ZERO_THRESHOLD, properties),
- Util.loadDouble(prefix + "." + HISTOGRAM_NATIVE_MAX_ZERO_THRESHOLD, properties),
- Util.loadInteger(prefix + "." + HISTOGRAM_NATIVE_MAX_NUMBER_OF_BUCKETS, properties),
- Util.loadLong(prefix + "." + HISTOGRAM_NATIVE_RESET_DURATION_SECONDS, properties),
- Util.loadDoubleList(prefix + "." + SUMMARY_QUANTILES, properties),
- Util.loadDoubleList(prefix + "." + SUMMARY_QUANTILE_ERRORS, properties),
- Util.loadLong(prefix + "." + SUMMARY_MAX_AGE_SECONDS, properties),
- Util.loadInteger(prefix + "." + SUMMARY_NUMBER_OF_AGE_BUCKETS, properties),
- prefix);
+ /** See {@link MetricsProperties#getSummaryMaxAgeSeconds()} */
+ public Builder summaryMaxAgeSeconds(Long summaryMaxAgeSeconds) {
+ this.summaryMaxAgeSeconds = summaryMaxAgeSeconds;
+ return this;
}
- public static Builder builder() {
- return new Builder();
- }
-
- public static class Builder {
- private Boolean exemplarsEnabled;
- private Boolean histogramNativeOnly;
- private Boolean histogramClassicOnly;
- private List histogramClassicUpperBounds;
- private Integer histogramNativeInitialSchema;
- private Double histogramNativeMinZeroThreshold;
- private Double histogramNativeMaxZeroThreshold;
- private Integer histogramNativeMaxNumberOfBuckets;
- private Long histogramNativeResetDurationSeconds;
- private List summaryQuantiles;
- private List summaryQuantileErrors;
- private Long summaryMaxAgeSeconds;
- private Integer summaryNumberOfAgeBuckets;
-
- private Builder() {
- }
-
- public MetricsProperties build() {
- return new MetricsProperties(exemplarsEnabled,
- histogramNativeOnly,
- histogramClassicOnly,
- histogramClassicUpperBounds,
- histogramNativeInitialSchema,
- histogramNativeMinZeroThreshold,
- histogramNativeMaxZeroThreshold,
- histogramNativeMaxNumberOfBuckets,
- histogramNativeResetDurationSeconds,
- summaryQuantiles,
- summaryQuantileErrors,
- summaryMaxAgeSeconds,
- summaryNumberOfAgeBuckets);
- }
-
- /**
- * See {@link MetricsProperties#getExemplarsEnabled()}
- */
- public Builder exemplarsEnabled(Boolean exemplarsEnabled) {
- this.exemplarsEnabled = exemplarsEnabled;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramNativeOnly()}
- */
- public Builder histogramNativeOnly(Boolean histogramNativeOnly) {
- this.histogramNativeOnly = histogramNativeOnly;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramClassicOnly()}
- */
- public Builder histogramClassicOnly(Boolean histogramClassicOnly) {
- this.histogramClassicOnly = histogramClassicOnly;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramClassicUpperBounds()}
- */
- public Builder histogramClassicUpperBounds(double... histogramClassicUpperBounds) {
- this.histogramClassicUpperBounds = Util.toList(histogramClassicUpperBounds);
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramNativeInitialSchema()}
- */
- public Builder histogramNativeInitialSchema(Integer histogramNativeInitialSchema) {
- this.histogramNativeInitialSchema = histogramNativeInitialSchema;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramNativeMinZeroThreshold()}
- */
- public Builder histogramNativeMinZeroThreshold(Double histogramNativeMinZeroThreshold) {
- this.histogramNativeMinZeroThreshold = histogramNativeMinZeroThreshold;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramNativeMaxZeroThreshold()}
- */
- public Builder histogramNativeMaxZeroThreshold(Double histogramNativeMaxZeroThreshold) {
- this.histogramNativeMaxZeroThreshold = histogramNativeMaxZeroThreshold;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramNativeMaxNumberOfBuckets()}
- */
- public Builder histogramNativeMaxNumberOfBuckets(Integer histogramNativeMaxNumberOfBuckets) {
- this.histogramNativeMaxNumberOfBuckets = histogramNativeMaxNumberOfBuckets;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getHistogramNativeResetDurationSeconds()}
- */
- public Builder histogramNativeResetDurationSeconds(Long histogramNativeResetDurationSeconds) {
- this.histogramNativeResetDurationSeconds = histogramNativeResetDurationSeconds;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getSummaryQuantiles()}
- */
- public Builder summaryQuantiles(double... summaryQuantiles) {
- this.summaryQuantiles = Util.toList(summaryQuantiles);
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getSummaryQuantileErrors()}
- */
- public Builder summaryQuantileErrors(double... summaryQuantileErrors) {
- this.summaryQuantileErrors = Util.toList(summaryQuantileErrors);
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getSummaryMaxAgeSeconds()}
- */
- public Builder summaryMaxAgeSeconds(Long summaryMaxAgeSeconds) {
- this.summaryMaxAgeSeconds = summaryMaxAgeSeconds;
- return this;
- }
-
- /**
- * See {@link MetricsProperties#getSummaryNumberOfAgeBuckets()}
- */
- public Builder summaryNumberOfAgeBuckets(Integer summaryNumberOfAgeBuckets) {
- this.summaryNumberOfAgeBuckets = summaryNumberOfAgeBuckets;
- return this;
- }
+ /** See {@link MetricsProperties#getSummaryNumberOfAgeBuckets()} */
+ public Builder summaryNumberOfAgeBuckets(Integer summaryNumberOfAgeBuckets) {
+ this.summaryNumberOfAgeBuckets = summaryNumberOfAgeBuckets;
+ return this;
}
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusProperties.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusProperties.java
index 2e26a4c7b..da31fe8cc 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusProperties.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusProperties.java
@@ -5,89 +5,94 @@
/**
* The Prometheus Java client library can be configured at runtime (e.g. using a properties file).
- *
- * This class represents the runtime configuration.
+ *
+ *
This class represents the runtime configuration.
*/
public class PrometheusProperties {
- private static final PrometheusProperties instance = PrometheusPropertiesLoader.load();
+ private static final PrometheusProperties instance = PrometheusPropertiesLoader.load();
- private final MetricsProperties defaultMetricsProperties;
- private final Map metricProperties = new HashMap<>();
- private final ExemplarsProperties exemplarProperties;
- private final ExporterProperties exporterProperties;
- private final ExporterFilterProperties exporterFilterProperties;
- private final ExporterHttpServerProperties exporterHttpServerProperties;
- private final ExporterOpenTelemetryProperties exporterOpenTelemetryProperties;
- private final ExporterPushgatewayProperties exporterPushgatewayProperties;
+ private final MetricsProperties defaultMetricsProperties;
+ private final Map metricProperties = new HashMap<>();
+ private final ExemplarsProperties exemplarProperties;
+ private final ExporterProperties exporterProperties;
+ private final ExporterFilterProperties exporterFilterProperties;
+ private final ExporterHttpServerProperties exporterHttpServerProperties;
+ private final ExporterOpenTelemetryProperties exporterOpenTelemetryProperties;
+ private final ExporterPushgatewayProperties exporterPushgatewayProperties;
- /**
- * Get the properties instance. When called for the first time, {@code get()} loads the properties from the following locations:
- *
- * - {@code prometheus.properties} file found in the classpath.
- * - Properties file specified in the {@code PROMETHEUS_CONFIG} environment variable or the {@code prometheus.config} system property.
- * - Individual properties from system properties.
- *
- */
- public static PrometheusProperties get() throws PrometheusPropertiesException {
- return instance;
- }
+ /**
+ * Get the properties instance. When called for the first time, {@code get()} loads the properties
+ * from the following locations:
+ *
+ *
+ * - {@code prometheus.properties} file found in the classpath.
+ *
- Properties file specified in the {@code PROMETHEUS_CONFIG} environment variable or the
+ * {@code prometheus.config} system property.
+ *
- Individual properties from system properties.
+ *
+ */
+ public static PrometheusProperties get() throws PrometheusPropertiesException {
+ return instance;
+ }
- public PrometheusProperties(
- MetricsProperties defaultMetricsProperties,
- Map metricProperties,
- ExemplarsProperties exemplarProperties,
- ExporterProperties exporterProperties,
- ExporterFilterProperties exporterFilterProperties,
- ExporterHttpServerProperties httpServerConfig,
- ExporterPushgatewayProperties pushgatewayProperties,
- ExporterOpenTelemetryProperties otelConfig) {
- this.defaultMetricsProperties = defaultMetricsProperties;
- this.metricProperties.putAll(metricProperties);
- this.exemplarProperties = exemplarProperties;
- this.exporterProperties = exporterProperties;
- this.exporterFilterProperties = exporterFilterProperties;
- this.exporterHttpServerProperties = httpServerConfig;
- this.exporterPushgatewayProperties = pushgatewayProperties;
- this.exporterOpenTelemetryProperties = otelConfig;
- }
+ public PrometheusProperties(
+ MetricsProperties defaultMetricsProperties,
+ Map metricProperties,
+ ExemplarsProperties exemplarProperties,
+ ExporterProperties exporterProperties,
+ ExporterFilterProperties exporterFilterProperties,
+ ExporterHttpServerProperties httpServerConfig,
+ ExporterPushgatewayProperties pushgatewayProperties,
+ ExporterOpenTelemetryProperties otelConfig) {
+ this.defaultMetricsProperties = defaultMetricsProperties;
+ this.metricProperties.putAll(metricProperties);
+ this.exemplarProperties = exemplarProperties;
+ this.exporterProperties = exporterProperties;
+ this.exporterFilterProperties = exporterFilterProperties;
+ this.exporterHttpServerProperties = httpServerConfig;
+ this.exporterPushgatewayProperties = pushgatewayProperties;
+ this.exporterOpenTelemetryProperties = otelConfig;
+ }
- /**
- * The default metric properties apply for metrics where {@link #getMetricProperties(String)} is {@code null}.
- */
- public MetricsProperties getDefaultMetricProperties() {
- return defaultMetricsProperties;
- }
+ /**
+ * The default metric properties apply for metrics where {@link #getMetricProperties(String)} is
+ * {@code null}.
+ */
+ public MetricsProperties getDefaultMetricProperties() {
+ return defaultMetricsProperties;
+ }
- /**
- * Properties specific for one metric. Should be merged with {@link #getDefaultMetricProperties()}.
- * May return {@code null} if no metric-specific properties are configured for a metric name.
- */
- public MetricsProperties getMetricProperties(String metricName) {
- return metricProperties.get(metricName.replace(".", "_"));
- }
+ /**
+ * Properties specific for one metric. Should be merged with {@link
+ * #getDefaultMetricProperties()}. May return {@code null} if no metric-specific properties are
+ * configured for a metric name.
+ */
+ public MetricsProperties getMetricProperties(String metricName) {
+ return metricProperties.get(metricName.replace(".", "_"));
+ }
- public ExemplarsProperties getExemplarProperties() {
- return exemplarProperties;
- }
+ public ExemplarsProperties getExemplarProperties() {
+ return exemplarProperties;
+ }
- public ExporterProperties getExporterProperties() {
- return exporterProperties;
- }
+ public ExporterProperties getExporterProperties() {
+ return exporterProperties;
+ }
- public ExporterFilterProperties getExporterFilterProperties() {
- return exporterFilterProperties;
- }
+ public ExporterFilterProperties getExporterFilterProperties() {
+ return exporterFilterProperties;
+ }
- public ExporterHttpServerProperties getExporterHttpServerProperties() {
- return exporterHttpServerProperties;
- }
+ public ExporterHttpServerProperties getExporterHttpServerProperties() {
+ return exporterHttpServerProperties;
+ }
- public ExporterPushgatewayProperties getExporterPushgatewayProperties() {
- return exporterPushgatewayProperties;
- }
+ public ExporterPushgatewayProperties getExporterPushgatewayProperties() {
+ return exporterPushgatewayProperties;
+ }
- public ExporterOpenTelemetryProperties getExporterOpenTelemetryProperties() {
- return exporterOpenTelemetryProperties;
- }
+ public ExporterOpenTelemetryProperties getExporterOpenTelemetryProperties() {
+ return exporterOpenTelemetryProperties;
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesException.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesException.java
index e41009ca2..5024cc45a 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesException.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesException.java
@@ -2,11 +2,11 @@
public class PrometheusPropertiesException extends RuntimeException {
- public PrometheusPropertiesException(String msg) {
- super(msg);
- }
+ public PrometheusPropertiesException(String msg) {
+ super(msg);
+ }
- public PrometheusPropertiesException(String msg, Exception cause) {
- super(msg, cause);
- }
+ public PrometheusPropertiesException(String msg, Exception cause) {
+ super(msg, cause);
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesLoader.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesLoader.java
index bb9b3c2cb..9d1fde4ab 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesLoader.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/PrometheusPropertiesLoader.java
@@ -14,101 +14,123 @@
/**
* The Properties Loader is early stages.
- *
- * It would be great to implement a subset of
- * Spring Boot's Externalized Configuration,
- * like support for YAML, Properties, and env vars, or support for Spring's naming conventions for properties.
+ *
+ *
It would be great to implement a subset of Spring
+ * Boot's Externalized Configuration, like support for YAML, Properties, and env vars, or
+ * support for Spring's naming conventions for properties.
*/
public class PrometheusPropertiesLoader {
- /**
- * See {@link PrometheusProperties#get()}.
- */
- public static PrometheusProperties load() throws PrometheusPropertiesException {
- return load(new Properties());
- }
+ /** See {@link PrometheusProperties#get()}. */
+ public static PrometheusProperties load() throws PrometheusPropertiesException {
+ return load(new Properties());
+ }
- public static PrometheusProperties load(Map externalProperties) throws PrometheusPropertiesException {
- Map properties = loadProperties(externalProperties);
- Map metricsConfigs = loadMetricsConfigs(properties);
- MetricsProperties defaultMetricsProperties = MetricsProperties.load("io.prometheus.metrics", properties);
- ExemplarsProperties exemplarConfig = ExemplarsProperties.load("io.prometheus.exemplars", properties);
- ExporterProperties exporterProperties = ExporterProperties.load("io.prometheus.exporter", properties);
- ExporterFilterProperties exporterFilterProperties = ExporterFilterProperties.load("io.prometheus.exporter.filter", properties);
- ExporterHttpServerProperties exporterHttpServerProperties = ExporterHttpServerProperties.load("io.prometheus.exporter.httpServer", properties);
- ExporterPushgatewayProperties exporterPushgatewayProperties = ExporterPushgatewayProperties.load("io.prometheus.exporter.pushgateway", properties);
- ExporterOpenTelemetryProperties exporterOpenTelemetryProperties = ExporterOpenTelemetryProperties.load("io.prometheus.exporter.opentelemetry", properties);
- validateAllPropertiesProcessed(properties);
- return new PrometheusProperties(defaultMetricsProperties, metricsConfigs, exemplarConfig, exporterProperties, exporterFilterProperties, exporterHttpServerProperties, exporterPushgatewayProperties, exporterOpenTelemetryProperties);
- }
+ public static PrometheusProperties load(Map externalProperties)
+ throws PrometheusPropertiesException {
+ Map properties = loadProperties(externalProperties);
+ Map metricsConfigs = loadMetricsConfigs(properties);
+ MetricsProperties defaultMetricsProperties =
+ MetricsProperties.load("io.prometheus.metrics", properties);
+ ExemplarsProperties exemplarConfig =
+ ExemplarsProperties.load("io.prometheus.exemplars", properties);
+ ExporterProperties exporterProperties =
+ ExporterProperties.load("io.prometheus.exporter", properties);
+ ExporterFilterProperties exporterFilterProperties =
+ ExporterFilterProperties.load("io.prometheus.exporter.filter", properties);
+ ExporterHttpServerProperties exporterHttpServerProperties =
+ ExporterHttpServerProperties.load("io.prometheus.exporter.httpServer", properties);
+ ExporterPushgatewayProperties exporterPushgatewayProperties =
+ ExporterPushgatewayProperties.load("io.prometheus.exporter.pushgateway", properties);
+ ExporterOpenTelemetryProperties exporterOpenTelemetryProperties =
+ ExporterOpenTelemetryProperties.load("io.prometheus.exporter.opentelemetry", properties);
+ validateAllPropertiesProcessed(properties);
+ return new PrometheusProperties(
+ defaultMetricsProperties,
+ metricsConfigs,
+ exemplarConfig,
+ exporterProperties,
+ exporterFilterProperties,
+ exporterHttpServerProperties,
+ exporterPushgatewayProperties,
+ exporterOpenTelemetryProperties);
+ }
- // This will remove entries from properties when they are processed.
- private static Map loadMetricsConfigs(Map properties) {
- Map result = new HashMap<>();
- // Note that the metric name in the properties file must be as exposed in the Prometheus exposition formats,
- // i.e. all dots replaced with underscores.
- Pattern pattern = Pattern.compile("io\\.prometheus\\.metrics\\.([^.]+)\\.");
- // Create a copy of the keySet() for iterating. We cannot iterate directly over keySet()
- // because entries are removed when MetricsConfig.load(...) is called.
- Set propertyNames = new HashSet<>();
- for (Object key : properties.keySet()) {
- propertyNames.add(key.toString());
- }
- for (String propertyName : propertyNames) {
- Matcher matcher = pattern.matcher(propertyName);
- if (matcher.find()) {
- String metricName = matcher.group(1).replace(".", "_");
- if (!result.containsKey(metricName)) {
- result.put(metricName, MetricsProperties.load("io.prometheus.metrics." + metricName, properties));
- }
- }
- }
- return result;
+ // This will remove entries from properties when they are processed.
+ private static Map loadMetricsConfigs(Map properties) {
+ Map result = new HashMap<>();
+ // Note that the metric name in the properties file must be as exposed in the Prometheus
+ // exposition formats,
+ // i.e. all dots replaced with underscores.
+ Pattern pattern = Pattern.compile("io\\.prometheus\\.metrics\\.([^.]+)\\.");
+ // Create a copy of the keySet() for iterating. We cannot iterate directly over keySet()
+ // because entries are removed when MetricsConfig.load(...) is called.
+ Set propertyNames = new HashSet<>();
+ for (Object key : properties.keySet()) {
+ propertyNames.add(key.toString());
}
-
- // If there are properties left starting with io.prometheus it's likely a typo,
- // because we didn't use that property.
- // Throw a config error to let the user know that this property doesn't exist.
- private static void validateAllPropertiesProcessed(Map properties) {
- for (Object key : properties.keySet()) {
- if (key.toString().startsWith("io.prometheus")) {
- throw new PrometheusPropertiesException(key + ": Unknown property");
- }
+ for (String propertyName : propertyNames) {
+ Matcher matcher = pattern.matcher(propertyName);
+ if (matcher.find()) {
+ String metricName = matcher.group(1).replace(".", "_");
+ if (!result.containsKey(metricName)) {
+ result.put(
+ metricName,
+ MetricsProperties.load("io.prometheus.metrics." + metricName, properties));
}
+ }
}
+ return result;
+ }
- private static Map loadProperties(Map externalProperties) {
- Map properties = new HashMap<>();
- properties.putAll(loadPropertiesFromClasspath());
- properties.putAll(loadPropertiesFromFile()); // overriding the entries from the classpath file
- properties.putAll(System.getProperties()); // overriding the entries from the properties file
- properties.putAll(externalProperties); // overriding all the entries above
- // TODO: Add environment variables like EXEMPLARS_ENABLED.
- return properties;
+ // If there are properties left starting with io.prometheus it's likely a typo,
+ // because we didn't use that property.
+ // Throw a config error to let the user know that this property doesn't exist.
+ private static void validateAllPropertiesProcessed(Map properties) {
+ for (Object key : properties.keySet()) {
+ if (key.toString().startsWith("io.prometheus")) {
+ throw new PrometheusPropertiesException(key + ": Unknown property");
+ }
}
+ }
- private static Properties loadPropertiesFromClasspath() {
- Properties properties = new Properties();
- try (InputStream stream = Thread.currentThread().getContextClassLoader().getResourceAsStream("prometheus.properties")) {
- properties.load(stream);
- } catch (Exception ignored) {
- }
- return properties;
+ private static Map loadProperties(Map externalProperties) {
+ Map properties = new HashMap<>();
+ properties.putAll(loadPropertiesFromClasspath());
+ properties.putAll(loadPropertiesFromFile()); // overriding the entries from the classpath file
+ properties.putAll(System.getProperties()); // overriding the entries from the properties file
+ properties.putAll(externalProperties); // overriding all the entries above
+ // TODO: Add environment variables like EXEMPLARS_ENABLED.
+ return properties;
+ }
+
+ private static Properties loadPropertiesFromClasspath() {
+ Properties properties = new Properties();
+ try (InputStream stream =
+ Thread.currentThread()
+ .getContextClassLoader()
+ .getResourceAsStream("prometheus.properties")) {
+ properties.load(stream);
+ } catch (Exception ignored) {
}
+ return properties;
+ }
- private static Properties loadPropertiesFromFile() throws PrometheusPropertiesException {
- Properties properties = new Properties();
- String path = System.getProperty("prometheus.config");
- if (System.getenv("PROMETHEUS_CONFIG") != null) {
- path = System.getenv("PROMETHEUS_CONFIG");
- }
- if (path != null) {
- try (InputStream stream = Files.newInputStream(Paths.get(path))) {
- properties.load(stream);
- } catch (IOException e) {
- throw new PrometheusPropertiesException("Failed to read Prometheus properties from " + path + ": " + e.getMessage(), e);
- }
- }
- return properties;
+ private static Properties loadPropertiesFromFile() throws PrometheusPropertiesException {
+ Properties properties = new Properties();
+ String path = System.getProperty("prometheus.config");
+ if (System.getenv("PROMETHEUS_CONFIG") != null) {
+ path = System.getenv("PROMETHEUS_CONFIG");
+ }
+ if (path != null) {
+ try (InputStream stream = Files.newInputStream(Paths.get(path))) {
+ properties.load(stream);
+ } catch (IOException e) {
+ throw new PrometheusPropertiesException(
+ "Failed to read Prometheus properties from " + path + ": " + e.getMessage(), e);
+ }
}
+ return properties;
+ }
}
diff --git a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/Util.java b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/Util.java
index 5b3f97252..66d6b2d92 100644
--- a/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/Util.java
+++ b/prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/Util.java
@@ -9,131 +9,145 @@
class Util {
- private static String getProperty(String name, Map properties) {
- Object object = properties.remove(name);
- if (object != null) {
- return object.toString();
- }
- return null;
+ private static String getProperty(String name, Map properties) {
+ Object object = properties.remove(name);
+ if (object != null) {
+ return object.toString();
}
+ return null;
+ }
- static Boolean loadBoolean(String name, Map properties) throws PrometheusPropertiesException {
- String property = getProperty(name, properties);
- if (property != null) {
- if (!"true".equalsIgnoreCase(property) && !"false".equalsIgnoreCase(property)) {
- throw new PrometheusPropertiesException(name + "=" + property + ": Expecting 'true' or 'false'");
- }
- return Boolean.parseBoolean(property);
- }
- return null;
+ static Boolean loadBoolean(String name, Map properties)
+ throws PrometheusPropertiesException {
+ String property = getProperty(name, properties);
+ if (property != null) {
+ if (!"true".equalsIgnoreCase(property) && !"false".equalsIgnoreCase(property)) {
+ throw new PrometheusPropertiesException(
+ name + "=" + property + ": Expecting 'true' or 'false'");
+ }
+ return Boolean.parseBoolean(property);
}
+ return null;
+ }
- static List toList(double... values) {
- if (values == null) {
- return null;
- }
- List result = new ArrayList<>(values.length);
- for (double value : values) {
- result.add(value);
- }
- return result;
+ static List toList(double... values) {
+ if (values == null) {
+ return null;
}
-
- static String loadString(String name, Map properties) throws PrometheusPropertiesException {
- return getProperty(name, properties);
+ List result = new ArrayList<>(values.length);
+ for (double value : values) {
+ result.add(value);
}
+ return result;
+ }
- static List loadStringList(String name, Map properties) throws PrometheusPropertiesException {
- String property = getProperty(name, properties);
- if (property != null) {
- return Arrays.asList(property.split("\\s*,\\s*"));
- }
- return null;
+ static String loadString(String name, Map properties)
+ throws PrometheusPropertiesException {
+ return getProperty(name, properties);
+ }
+
+ static List loadStringList(String name, Map properties)
+ throws PrometheusPropertiesException {
+ String property = getProperty(name, properties);
+ if (property != null) {
+ return Arrays.asList(property.split("\\s*,\\s*"));
}
+ return null;
+ }
- static List loadDoubleList(String name, Map properties) throws PrometheusPropertiesException {
- String property = getProperty(name, properties);
- if (property != null) {
- String[] numbers = property.split("\\s*,\\s*");
- Double[] result = new Double[numbers.length];
- for (int i = 0; i < numbers.length; i++) {
- try {
- if ("+Inf".equals(numbers[i].trim())) {
- result[i] = Double.POSITIVE_INFINITY;
- } else {
- result[i] = Double.parseDouble(numbers[i]);
- }
- } catch (NumberFormatException e) {
- throw new PrometheusPropertiesException(name + "=" + property + ": Expecting comma separated list of double values");
- }
- }
- return Arrays.asList(result);
+ static List loadDoubleList(String name, Map properties)
+ throws PrometheusPropertiesException {
+ String property = getProperty(name, properties);
+ if (property != null) {
+ String[] numbers = property.split("\\s*,\\s*");
+ Double[] result = new Double[numbers.length];
+ for (int i = 0; i < numbers.length; i++) {
+ try {
+ if ("+Inf".equals(numbers[i].trim())) {
+ result[i] = Double.POSITIVE_INFINITY;
+ } else {
+ result[i] = Double.parseDouble(numbers[i]);
+ }
+ } catch (NumberFormatException e) {
+ throw new PrometheusPropertiesException(
+ name + "=" + property + ": Expecting comma separated list of double values");
}
- return null;
+ }
+ return Arrays.asList(result);
}
+ return null;
+ }
- // Map is represented as "key1=value1,key2=value2"
- static Map loadMap(String name, Map properties) throws PrometheusPropertiesException {
- Map result = new HashMap<>();
- String property = getProperty(name, properties);
- if (property != null) {
- String[] pairs = property.split(",");
- for (String pair : pairs) {
- if (pair.contains("=")) {
- String[] keyValue = pair.split("=", 1);
- if (keyValue.length == 2) {
- String key = keyValue[0].trim();
- String value = keyValue[1].trim();
- if (key.length() > 0 && value.length() > 0) {
- result.putIfAbsent(key, value);
- }
- }
- }
+ // Map is represented as "key1=value1,key2=value2"
+ static Map loadMap(String name, Map properties)
+ throws PrometheusPropertiesException {
+ Map result = new HashMap<>();
+ String property = getProperty(name, properties);
+ if (property != null) {
+ String[] pairs = property.split(",");
+ for (String pair : pairs) {
+ if (pair.contains("=")) {
+ String[] keyValue = pair.split("=", 1);
+ if (keyValue.length == 2) {
+ String key = keyValue[0].trim();
+ String value = keyValue[1].trim();
+ if (key.length() > 0 && value.length() > 0) {
+ result.putIfAbsent(key, value);
}
+ }
}
- return result;
+ }
}
+ return result;
+ }
- static Integer loadInteger(String name, Map properties) throws PrometheusPropertiesException {
- String property = getProperty(name, properties);
- if (property != null) {
- try {
- return Integer.parseInt(property);
- } catch (NumberFormatException e) {
- throw new PrometheusPropertiesException(name + "=" + property + ": Expecting integer value");
- }
- }
- return null;
+ static Integer loadInteger(String name, Map properties)
+ throws PrometheusPropertiesException {
+ String property = getProperty(name, properties);
+ if (property != null) {
+ try {
+ return Integer.parseInt(property);
+ } catch (NumberFormatException e) {
+ throw new PrometheusPropertiesException(
+ name + "=" + property + ": Expecting integer value");
+ }
}
+ return null;
+ }
- static Double loadDouble(String name, Map properties) throws PrometheusPropertiesException {
- String property = getProperty(name, properties);
- if (property != null) {
- try {
- return Double.parseDouble(property);
- } catch (NumberFormatException e) {
- throw new PrometheusPropertiesException(name + "=" + property + ": Expecting double value");
- }
- }
- return null;
+ static Double loadDouble(String name, Map properties)
+ throws PrometheusPropertiesException {
+ String property = getProperty(name, properties);
+ if (property != null) {
+ try {
+ return Double.parseDouble(property);
+ } catch (NumberFormatException e) {
+ throw new PrometheusPropertiesException(name + "=" + property + ": Expecting double value");
+ }
}
+ return null;
+ }
- static Long loadLong(String name, Map properties) throws PrometheusPropertiesException {
- String property = getProperty(name, properties);
- if (property != null) {
- try {
- return Long.parseLong(property);
- } catch (NumberFormatException e) {
- throw new PrometheusPropertiesException(name + "=" + property + ": Expecting long value");
- }
- }
- return null;
+ static Long loadLong(String name, Map properties)
+ throws PrometheusPropertiesException {
+ String property = getProperty(name, properties);
+ if (property != null) {
+ try {
+ return Long.parseLong(property);
+ } catch (NumberFormatException e) {
+ throw new PrometheusPropertiesException(name + "=" + property + ": Expecting long value");
+ }
}
+ return null;
+ }
- static void assertValue(T number, Predicate predicate, String message, String prefix, String name) throws PrometheusPropertiesException {
- if (number != null && !predicate.test(number)) {
- String fullMessage = prefix == null ? name + ": " + message : prefix + "." + name + ": " + message;
- throw new PrometheusPropertiesException(fullMessage);
- }
+ static void assertValue(
+ T number, Predicate predicate, String message, String prefix, String name)
+ throws PrometheusPropertiesException {
+ if (number != null && !predicate.test(number)) {
+ String fullMessage =
+ prefix == null ? name + ": " + message : prefix + "." + name + ": " + message;
+ throw new PrometheusPropertiesException(fullMessage);
}
+ }
}
diff --git a/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesLoaderTests.java b/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesLoaderTests.java
index 79c20702c..8d16eadb7 100644
--- a/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesLoaderTests.java
+++ b/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesLoaderTests.java
@@ -1,33 +1,46 @@
package io.prometheus.metrics.config;
import java.util.Properties;
-
import org.junit.Assert;
import org.junit.Test;
-/**
- * Tests for {@link PrometheusPropertiesLoader}.
- */
+/** Tests for {@link PrometheusPropertiesLoader}. */
public class PrometheusPropertiesLoaderTests {
- @Test
- public void propertiesShouldBeLoadedFromPropertiesFile() {
- PrometheusProperties prometheusProperties = PrometheusPropertiesLoader.load();
- Assert.assertEquals(11, prometheusProperties.getDefaultMetricProperties().getHistogramClassicUpperBounds().size());
- Assert.assertEquals(4, prometheusProperties.getMetricProperties("http_duration_seconds").getHistogramClassicUpperBounds().size());
- Assert.assertTrue(prometheusProperties.getExporterProperties().getExemplarsOnAllMetricTypes());
- }
+ @Test
+ public void propertiesShouldBeLoadedFromPropertiesFile() {
+ PrometheusProperties prometheusProperties = PrometheusPropertiesLoader.load();
+ Assert.assertEquals(
+ 11,
+ prometheusProperties.getDefaultMetricProperties().getHistogramClassicUpperBounds().size());
+ Assert.assertEquals(
+ 4,
+ prometheusProperties
+ .getMetricProperties("http_duration_seconds")
+ .getHistogramClassicUpperBounds()
+ .size());
+ Assert.assertTrue(prometheusProperties.getExporterProperties().getExemplarsOnAllMetricTypes());
+ }
- @Test
- public void externalPropertiesShouldOverridePropertiesFile() {
- Properties properties = new Properties();
- properties.setProperty("io.prometheus.metrics.histogramClassicUpperBounds", ".005, .01");
- properties.setProperty("io.prometheus.metrics.http_duration_seconds.histogramClassicUpperBounds", ".005, .01, .015");
- properties.setProperty("io.prometheus.exporter.exemplarsOnAllMetricTypes", "false");
+ @Test
+ public void externalPropertiesShouldOverridePropertiesFile() {
+ Properties properties = new Properties();
+ properties.setProperty("io.prometheus.metrics.histogramClassicUpperBounds", ".005, .01");
+ properties.setProperty(
+ "io.prometheus.metrics.http_duration_seconds.histogramClassicUpperBounds",
+ ".005, .01, .015");
+ properties.setProperty("io.prometheus.exporter.exemplarsOnAllMetricTypes", "false");
- PrometheusProperties prometheusProperties = PrometheusPropertiesLoader.load(properties);
- Assert.assertEquals(2, prometheusProperties.getDefaultMetricProperties().getHistogramClassicUpperBounds().size());
- Assert.assertEquals(3, prometheusProperties.getMetricProperties("http_duration_seconds").getHistogramClassicUpperBounds().size());
- Assert.assertFalse(prometheusProperties.getExporterProperties().getExemplarsOnAllMetricTypes());
- }
+ PrometheusProperties prometheusProperties = PrometheusPropertiesLoader.load(properties);
+ Assert.assertEquals(
+ 2,
+ prometheusProperties.getDefaultMetricProperties().getHistogramClassicUpperBounds().size());
+ Assert.assertEquals(
+ 3,
+ prometheusProperties
+ .getMetricProperties("http_duration_seconds")
+ .getHistogramClassicUpperBounds()
+ .size());
+ Assert.assertFalse(prometheusProperties.getExporterProperties().getExemplarsOnAllMetricTypes());
+ }
}
diff --git a/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesTest.java b/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesTest.java
index 45fec1be0..f9ef25a7a 100644
--- a/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesTest.java
+++ b/prometheus-metrics-config/src/test/java/io/prometheus/metrics/config/PrometheusPropertiesTest.java
@@ -1,29 +1,37 @@
package io.prometheus.metrics.config;
-import org.junit.Assert;
-import org.junit.Test;
-
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
+import org.junit.Assert;
+import org.junit.Test;
public class PrometheusPropertiesTest {
- @Test
- public void testPrometheusConfig() {
- PrometheusProperties result = PrometheusProperties.get();
- Assert.assertEquals(11, result.getDefaultMetricProperties().getHistogramClassicUpperBounds().size());
- Assert.assertEquals(4, result.getMetricProperties("http_duration_seconds").getHistogramClassicUpperBounds().size());
- }
+ @Test
+ public void testPrometheusConfig() {
+ PrometheusProperties result = PrometheusProperties.get();
+ Assert.assertEquals(
+ 11, result.getDefaultMetricProperties().getHistogramClassicUpperBounds().size());
+ Assert.assertEquals(
+ 4,
+ result
+ .getMetricProperties("http_duration_seconds")
+ .getHistogramClassicUpperBounds()
+ .size());
+ }
- @Test
- public void testEmptyUpperBounds() throws IOException {
- Properties properties = new Properties();
- try (InputStream stream = Thread.currentThread().getContextClassLoader().getResourceAsStream("emptyUpperBounds.properties")) {
- properties.load(stream);
- }
- Assert.assertEquals(1, properties.size());
- MetricsProperties.load("io.prometheus.metrics", properties);
- Assert.assertEquals(0, properties.size());
+ @Test
+ public void testEmptyUpperBounds() throws IOException {
+ Properties properties = new Properties();
+ try (InputStream stream =
+ Thread.currentThread()
+ .getContextClassLoader()
+ .getResourceAsStream("emptyUpperBounds.properties")) {
+ properties.load(stream);
}
+ Assert.assertEquals(1, properties.size());
+ MetricsProperties.load("io.prometheus.metrics", properties);
+ Assert.assertEquals(0, properties.size());
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/CounterDataPoint.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/CounterDataPoint.java
index 51b45c62a..7055d7565 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/CounterDataPoint.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/CounterDataPoint.java
@@ -3,9 +3,11 @@
import io.prometheus.metrics.model.snapshots.Labels;
/**
- * Represents a single counter data point, i.e. a single line for a counter metric in Prometheus text format.
- *
- * Example usage:
+ * Represents a single counter data point, i.e. a single line for a counter metric in Prometheus
+ * text format.
+ *
+ *
Example usage:
+ *
*
{@code
* Counter counter = Counter.builder()
* .name("tasks_total")
@@ -15,84 +17,86 @@
* CounterDataPoint pendingTasks = counter.labelValues("pending");
* CounterDataPoint completedTasks = counter.labelValues("completed");
* }
- *
- * Using {@code DataPoint} directly improves performance. If you increment a counter like this:
+ *
+ *
Using {@code DataPoint} directly improves performance. If you increment a counter like this:
+ *
*
{@code
* counter.labelValues("pending").inc();
* }
- * the label value {@code "pending"} needs to be looked up every single time.
- * Using the {@code CounterDataPoint} like this:
+ *
+ * the label value {@code "pending"} needs to be looked up every single time. Using the {@code
+ * CounterDataPoint} like this:
+ *
* {@code
* CounterDataPoint pendingTasks = counter.labelValues("pending");
* pendingTasks.inc();
* }
- * allows you to look up the label value only once, and then use the {@code CounterDataPoint} directly.
- * This is a worthwhile performance improvement when instrumenting a performance-critical code path.
- *
- * If you have a counter without labels like this:
+ *
+ * allows you to look up the label value only once, and then use the {@code CounterDataPoint}
+ * directly. This is a worthwhile performance improvement when instrumenting a performance-critical
+ * code path.
+ *
+ *
If you have a counter without labels like this:
+ *
*
{@code
* Counter counterWithoutLabels = Counter.builder()
* .name("events_total")
* .register();
* }
+ *
* You can use it as a {@code CounterDataPoint} directly. So the following:
+ *
* {@code
* CounterDataPoint counterData = counterWithoutLabels.labelValues(); // empty label values
* }
+ *
* is equivalent to
+ *
* {@code
* CounterDataPoint counterData = counterWithoutLabels;
* }
*/
public interface CounterDataPoint extends DataPoint {
- /**
- * Add one.
- */
- default void inc() {
- inc(1L);
- }
+ /** Add one. */
+ default void inc() {
+ inc(1L);
+ }
- /**
- * Add {@code amount}. Throws an {@link IllegalArgumentException} if {@code amount} is negative.
- */
- default void inc(long amount) {
- inc((double) amount);
- }
+ /**
+ * Add {@code amount}. Throws an {@link IllegalArgumentException} if {@code amount} is negative.
+ */
+ default void inc(long amount) {
+ inc((double) amount);
+ }
- /**
- * Add {@code amount}. Throws an {@link IllegalArgumentException} if {@code amount} is negative.
- */
- void inc(double amount);
+ /**
+ * Add {@code amount}. Throws an {@link IllegalArgumentException} if {@code amount} is negative.
+ */
+ void inc(double amount);
- /**
- * Add one, and create a custom exemplar with the given labels.
- */
- default void incWithExemplar(Labels labels) {
- incWithExemplar(1.0, labels);
- }
+ /** Add one, and create a custom exemplar with the given labels. */
+ default void incWithExemplar(Labels labels) {
+ incWithExemplar(1.0, labels);
+ }
- /**
- * Add {@code amount}, and create a custom exemplar with the given labels.
- * Throws an {@link IllegalArgumentException} if {@code amount} is negative.
- */
- default void incWithExemplar(long amount, Labels labels) {
- inc((double) amount);
- }
+ /**
+ * Add {@code amount}, and create a custom exemplar with the given labels. Throws an {@link
+ * IllegalArgumentException} if {@code amount} is negative.
+ */
+ default void incWithExemplar(long amount, Labels labels) {
+ inc((double) amount);
+ }
- /**
- * Add {@code amount}, and create a custom exemplar with the given labels.
- * Throws an {@link IllegalArgumentException} if {@code amount} is negative.
- */
- void incWithExemplar(double amount, Labels labels);
+ /**
+ * Add {@code amount}, and create a custom exemplar with the given labels. Throws an {@link
+ * IllegalArgumentException} if {@code amount} is negative.
+ */
+ void incWithExemplar(double amount, Labels labels);
- /**
- * Get the current value.
- */
- double get();
+ /** Get the current value. */
+ double get();
- /**
- * Get the current value as a {@code long}. Decimal places will be discarded.
- */
- long getLongValue();
+ /** Get the current value as a {@code long}. Decimal places will be discarded. */
+ long getLongValue();
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DataPoint.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DataPoint.java
index 8dd277d81..5b6017ddf 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DataPoint.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DataPoint.java
@@ -1,4 +1,3 @@
package io.prometheus.metrics.core.datapoints;
-public interface DataPoint {
-}
+public interface DataPoint {}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DistributionDataPoint.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DistributionDataPoint.java
index f08ccae9c..57e7a3e86 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DistributionDataPoint.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/DistributionDataPoint.java
@@ -4,33 +4,29 @@
/**
* Represents a single data point of a histogram or a summary metric.
- *
- * Single data point means identified label values like {@code {method="GET", path="/", status_code="200"}},
- * ignoring the {@code "le"} label for histograms or the {@code "quantile"} label for summaries.
- *
- * This interface is named DistributionDataPoint because both histograms and summaries are used to observe
- * distributions, like latency distributions or distributions of request sizes. Therefore
- * DistributionDataPoint is a good name for a common interface implemented by histogram data points
- * and summary data points.
- *
- * See JavaDoc of {@link CounterDataPoint} on how using data points directly can improve performance.
+ *
+ *
Single data point means identified label values like {@code {method="GET", path="/",
+ * status_code="200"}}, ignoring the {@code "le"} label for histograms or the {@code "quantile"}
+ * label for summaries.
+ *
+ *
This interface is named DistributionDataPoint because both histograms and summaries are
+ * used to observe distributions, like latency distributions or distributions of request sizes.
+ * Therefore DistributionDataPoint is a good name for a common interface implemented by
+ * histogram data points and summary data points.
+ *
+ *
See JavaDoc of {@link CounterDataPoint} on how using data points directly can improve
+ * performance.
*/
public interface DistributionDataPoint extends DataPoint, TimerApi {
- /**
- * Observe {@code value}.
- */
- void observe(double value);
+ /** Observe {@code value}. */
+ void observe(double value);
- /**
- * Observe {@code value}, and create a custom exemplar with the given labels.
- */
- void observeWithExemplar(double value, Labels labels);
+ /** Observe {@code value}, and create a custom exemplar with the given labels. */
+ void observeWithExemplar(double value, Labels labels);
- /**
- * {@inheritDoc}
- */
- default Timer startTimer() {
- return new Timer(this::observe);
- }
+ /** {@inheritDoc} */
+ default Timer startTimer() {
+ return new Timer(this::observe);
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/GaugeDataPoint.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/GaugeDataPoint.java
index c208d5414..003e3e5e8 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/GaugeDataPoint.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/GaugeDataPoint.java
@@ -3,83 +3,61 @@
import io.prometheus.metrics.model.snapshots.Labels;
/**
- * Represents a single gauge data point, i.e. a single line for a gauge metric in Prometheus text format.
- *
- * See JavaDoc of {@link CounterDataPoint} on how using data points directly can improve performance.
+ * Represents a single gauge data point, i.e. a single line for a gauge metric in Prometheus text
+ * format.
+ *
+ *
See JavaDoc of {@link CounterDataPoint} on how using data points directly can improve
+ * performance.
*/
public interface GaugeDataPoint extends DataPoint, TimerApi {
- /**
- * Add one.
- */
- default void inc() {
- inc(1.0);
- }
+ /** Add one. */
+ default void inc() {
+ inc(1.0);
+ }
- /**
- * Add {@code amount}.
- */
- void inc(double amount);
+ /** Add {@code amount}. */
+ void inc(double amount);
- /**
- * Add one, and create a custom exemplar with the given labels.
- */
- default void incWithExemplar(Labels labels) {
- incWithExemplar(1.0, labels);
- }
+ /** Add one, and create a custom exemplar with the given labels. */
+ default void incWithExemplar(Labels labels) {
+ incWithExemplar(1.0, labels);
+ }
- /**
- * Add {@code amount}, and create a custom exemplar with the given labels.
- */
- void incWithExemplar(double amount, Labels labels);
+ /** Add {@code amount}, and create a custom exemplar with the given labels. */
+ void incWithExemplar(double amount, Labels labels);
- /**
- * Subtract one.
- */
- default void dec() {
- inc(-1.0);
- }
+ /** Subtract one. */
+ default void dec() {
+ inc(-1.0);
+ }
- /**
- * Subtract {@code amount}.
- */
- default void dec(double amount) {
- inc(-amount);
- }
+ /** Subtract {@code amount}. */
+ default void dec(double amount) {
+ inc(-amount);
+ }
- /**
- * Subtract one, and create a custom exemplar with the given labels.
- */
- default void decWithExemplar(Labels labels) {
- incWithExemplar(-1.0, labels);
- }
+ /** Subtract one, and create a custom exemplar with the given labels. */
+ default void decWithExemplar(Labels labels) {
+ incWithExemplar(-1.0, labels);
+ }
- /**
- * Subtract {@code amount}, and create a custom exemplar with the given labels.
- */
- default void decWithExemplar(double amount, Labels labels) {
- incWithExemplar(-amount, labels);
- }
+ /** Subtract {@code amount}, and create a custom exemplar with the given labels. */
+ default void decWithExemplar(double amount, Labels labels) {
+ incWithExemplar(-amount, labels);
+ }
- /**
- * Set the gauge to {@code value}.
- */
- void set(double value);
+ /** Set the gauge to {@code value}. */
+ void set(double value);
- /**
- * Get the current value.
- */
- double get();
+ /** Get the current value. */
+ double get();
- /**
- * Set the gauge to {@code value}, and create a custom exemplar with the given labels.
- */
- void setWithExemplar(double value, Labels labels);
+ /** Set the gauge to {@code value}, and create a custom exemplar with the given labels. */
+ void setWithExemplar(double value, Labels labels);
- /**
- * {@inheritDoc}
- */
- default Timer startTimer() {
- return new Timer(this::set);
- }
+ /** {@inheritDoc} */
+ default Timer startTimer() {
+ return new Timer(this::set);
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/StateSetDataPoint.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/StateSetDataPoint.java
index 7dd8f68a4..61b458ba8 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/StateSetDataPoint.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/StateSetDataPoint.java
@@ -2,32 +2,37 @@
/**
* Represents a single StateSet data point.
- *
- * See JavaDoc of {@link CounterDataPoint} on how using data points directly can improve performance.
+ *
+ *
See JavaDoc of {@link CounterDataPoint} on how using data points directly can improve
+ * performance.
*/
public interface StateSetDataPoint extends DataPoint {
- /**
- * {@code state} must be one of the states from when the {@code StateSet} was created with {@link io.prometheus.metrics.core.metrics.StateSet.Builder#states(String...)}.
- */
- void setTrue(String state);
+ /**
+ * {@code state} must be one of the states from when the {@code StateSet} was created with {@link
+ * io.prometheus.metrics.core.metrics.StateSet.Builder#states(String...)}.
+ */
+ void setTrue(String state);
- /**
- * {@code state} must be one of the states from when the {@code StateSet} was created with {@link io.prometheus.metrics.core.metrics.StateSet.Builder#states(String...)}.
- */
- void setFalse(String state);
+ /**
+ * {@code state} must be one of the states from when the {@code StateSet} was created with {@link
+ * io.prometheus.metrics.core.metrics.StateSet.Builder#states(String...)}.
+ */
+ void setFalse(String state);
- /**
- * {@code state} must be one of the states from when the {@code StateSet} was created with {@link io.prometheus.metrics.core.metrics.StateSet.Builder#states(Class)}.
- */
- default void setTrue(Enum state) {
- setTrue(state.toString());
- }
+ /**
+ * {@code state} must be one of the states from when the {@code StateSet} was created with {@link
+ * io.prometheus.metrics.core.metrics.StateSet.Builder#states(Class)}.
+ */
+ default void setTrue(Enum state) {
+ setTrue(state.toString());
+ }
- /**
- * {@code state} must be one of the states from when the {@code StateSet} was created with {@link io.prometheus.metrics.core.metrics.StateSet.Builder#states(Class)}.
- */
- default void setFalse(Enum state) {
- setFalse(state.toString());
- }
+ /**
+ * {@code state} must be one of the states from when the {@code StateSet} was created with {@link
+ * io.prometheus.metrics.core.metrics.StateSet.Builder#states(Class)}.
+ */
+ default void setFalse(Enum state) {
+ setFalse(state.toString());
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/Timer.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/Timer.java
index fd6461869..d860bfa08 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/Timer.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/Timer.java
@@ -1,40 +1,37 @@
package io.prometheus.metrics.core.datapoints;
import io.prometheus.metrics.model.snapshots.Unit;
-
import java.io.Closeable;
import java.util.function.DoubleConsumer;
-/**
- * Helper class for observing durations.
- */
+/** Helper class for observing durations. */
public class Timer implements Closeable {
- private final DoubleConsumer observeFunction;
- private final long startTimeNanos = System.nanoTime();
+ private final DoubleConsumer observeFunction;
+ private final long startTimeNanos = System.nanoTime();
- /**
- * Constructor is package private. Use the {@link TimerApi} provided by the implementation of the {@link DataPoint}.
- */
- Timer(DoubleConsumer observeFunction) {
- this.observeFunction = observeFunction;
- }
+ /**
+ * Constructor is package private. Use the {@link TimerApi} provided by the implementation of the
+ * {@link DataPoint}.
+ */
+ Timer(DoubleConsumer observeFunction) {
+ this.observeFunction = observeFunction;
+ }
- /**
- * Records the observed duration in seconds since this {@code Timer} instance was created.
- * @return the observed duration in seconds.
- */
- public double observeDuration() {
- double elapsed = Unit.nanosToSeconds(System.nanoTime() - startTimeNanos);
- observeFunction.accept(elapsed);
- return elapsed;
- }
+ /**
+ * Records the observed duration in seconds since this {@code Timer} instance was created.
+ *
+ * @return the observed duration in seconds.
+ */
+ public double observeDuration() {
+ double elapsed = Unit.nanosToSeconds(System.nanoTime() - startTimeNanos);
+ observeFunction.accept(elapsed);
+ return elapsed;
+ }
- /**
- * Same as {@link #observeDuration()}.
- */
- @Override
- public void close() {
- observeDuration();
- }
+ /** Same as {@link #observeDuration()}. */
+ @Override
+ public void close() {
+ observeDuration();
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/TimerApi.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/TimerApi.java
index 27245bbcb..d4266c04c 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/TimerApi.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/datapoints/TimerApi.java
@@ -5,70 +5,75 @@
/**
* Convenience API for timing durations.
- *
- * Durations are recorded in seconds. The Prometheus instrumentation guidelines say:
- * "Metrics must use base units (e.g. seconds, bytes) and leave converting them to something more readable to graphing tools".
+ *
+ *
Durations are recorded in seconds. The Prometheus instrumentation guidelines say: "Metrics
+ * must use base units (e.g. seconds, bytes) and leave converting them to something more readable to
+ * graphing tools".
*/
public interface TimerApi {
- /**
- * Start a {@code Timer}. Example:
- *
{@code
- * Histogram histogram = Histogram.builder()
- * .name("http_request_duration_seconds")
- * .help("HTTP request service time in seconds")
- * .unit(SECONDS)
- * .labelNames("method", "path")
- * .register();
- *
- * try (Timer timer = histogram.labelValues("GET", "/").startTimer()) {
- * // duration of this code block will be observed.
- * }
- * }
- * Durations are recorded in seconds. The Prometheus instrumentation guidelines say:
- * "Metrics must use base units (e.g. seconds, bytes) and leave converting them to something more readable to graphing tools".
- */
- Timer startTimer();
+ /**
+ * Start a {@code Timer}. Example:
+ *
+ * {@code
+ * Histogram histogram = Histogram.builder()
+ * .name("http_request_duration_seconds")
+ * .help("HTTP request service time in seconds")
+ * .unit(SECONDS)
+ * .labelNames("method", "path")
+ * .register();
+ *
+ * try (Timer timer = histogram.labelValues("GET", "/").startTimer()) {
+ * // duration of this code block will be observed.
+ * }
+ * }
+ *
+ * Durations are recorded in seconds. The Prometheus instrumentation guidelines say: "Metrics
+ * must use base units (e.g. seconds, bytes) and leave converting them to something more readable
+ * to graphing tools".
+ */
+ Timer startTimer();
- /**
- * Observe the duration of the {@code func} call. Example:
- * {@code
- * Histogram histogram = Histogram.builder()
- * .name("request_duration_seconds")
- * .help("HTTP request service time in seconds")
- * .unit(SECONDS)
- * .labelNames("method", "path")
- * .register();
- *
- * histogram2.labelValues("GET", "/").time(() -> {
- * // duration of this code block will be observed.
- * });
- * }
- *
- * Durations are recorded in seconds. The Prometheus instrumentation guidelines say:
- * "Metrics must use base units (e.g. seconds, bytes) and leave converting them to something more readable to graphing tools".
- */
- default void time(Runnable func) {
- try (Timer timer = startTimer()) {
- func.run();
- }
+ /**
+ * Observe the duration of the {@code func} call. Example:
+ *
+ *
{@code
+ * Histogram histogram = Histogram.builder()
+ * .name("request_duration_seconds")
+ * .help("HTTP request service time in seconds")
+ * .unit(SECONDS)
+ * .labelNames("method", "path")
+ * .register();
+ *
+ * histogram2.labelValues("GET", "/").time(() -> {
+ * // duration of this code block will be observed.
+ * });
+ * }
+ *
+ * Durations are recorded in seconds. The Prometheus instrumentation guidelines say: "Metrics
+ * must use base units (e.g. seconds, bytes) and leave converting them to something more readable
+ * to graphing tools".
+ */
+ default void time(Runnable func) {
+ try (Timer timer = startTimer()) {
+ func.run();
}
+ }
- /**
- * Like {@link #time(Runnable)}, but returns the return value of {@code func}.
- */
- default T time(Supplier func) {
- try (Timer timer = startTimer()) {
- return func.get();
- }
+ /** Like {@link #time(Runnable)}, but returns the return value of {@code func}. */
+ default T time(Supplier func) {
+ try (Timer timer = startTimer()) {
+ return func.get();
}
+ }
- /**
- * Like {@link #time(Supplier)}, but {@code func} may throw a checked {@code Exception}.
- */
- default T timeChecked(Callable func) throws Exception {
- try (Timer timer = startTimer()) {
- return func.call();
- }
+ /** Like {@link #time(Supplier)}, but {@code func} may throw a checked {@code Exception}. */
+ default T timeChecked(Callable func) throws Exception {
+ try (Timer timer = startTimer()) {
+ return func.call();
}
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSampler.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSampler.java
index 7c46c244d..b606d5239 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSampler.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSampler.java
@@ -1,11 +1,10 @@
package io.prometheus.metrics.core.exemplars;
-import io.prometheus.metrics.tracer.common.SpanContext;
+import io.prometheus.metrics.core.util.Scheduler;
import io.prometheus.metrics.model.snapshots.Exemplar;
import io.prometheus.metrics.model.snapshots.Exemplars;
import io.prometheus.metrics.model.snapshots.Labels;
-import io.prometheus.metrics.core.util.Scheduler;
-
+import io.prometheus.metrics.tracer.common.SpanContext;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;
@@ -14,330 +13,346 @@
/**
* The ExemplarSampler selects Spans as exemplars.
- *
- * There are two types of Exemplars: Regular exemplars are sampled implicitly if a supported tracing
- * library is detected. Custom exemplars are provided explicitly in code, for example if a developer
- * wants to make sure an Exemplar is created for a specific code path.
- *
- * Spans will be marked as being an Exemplar by calling {@link SpanContext#markCurrentSpanAsExemplar()}.
- * The tracer implementation should set a Span attribute to mark the current Span as an Exemplar.
- * This attribute can be used by a trace sampling algorithm to make sure traces with Exemplars are sampled.
- *
- * The ExemplarSample is rate-limited, so only a small fraction of Spans will be marked as Exemplars in
- * an application with a large number of requests.
- *
- * See {@link ExemplarSamplerConfig} for configuration options.
+ *
+ *
There are two types of Exemplars: Regular exemplars are sampled implicitly if a supported
+ * tracing library is detected. Custom exemplars are provided explicitly in code, for example if a
+ * developer wants to make sure an Exemplar is created for a specific code path.
+ *
+ *
Spans will be marked as being an Exemplar by calling {@link
+ * SpanContext#markCurrentSpanAsExemplar()}. The tracer implementation should set a Span attribute
+ * to mark the current Span as an Exemplar. This attribute can be used by a trace sampling algorithm
+ * to make sure traces with Exemplars are sampled.
+ *
+ *
The ExemplarSample is rate-limited, so only a small fraction of Spans will be marked as
+ * Exemplars in an application with a large number of requests.
+ *
+ *
See {@link ExemplarSamplerConfig} for configuration options.
*/
public class ExemplarSampler {
- private final ExemplarSamplerConfig config;
- private final Exemplar[] exemplars;
- private final Exemplar[] customExemplars; // Separate from exemplars, because we don't want custom exemplars
- // to be overwritten by automatic exemplar sampling. exemplars.lengt == customExemplars.length
- private final AtomicBoolean acceptingNewExemplars = new AtomicBoolean(true);
- private final AtomicBoolean acceptingNewCustomExemplars = new AtomicBoolean(true);
- private final SpanContext spanContext; // may be null, in that case SpanContextSupplier.getSpanContext() is used.
+ private final ExemplarSamplerConfig config;
+ private final Exemplar[] exemplars;
+ private final Exemplar[]
+ customExemplars; // Separate from exemplars, because we don't want custom exemplars
+ // to be overwritten by automatic exemplar sampling. exemplars.lengt == customExemplars.length
+ private final AtomicBoolean acceptingNewExemplars = new AtomicBoolean(true);
+ private final AtomicBoolean acceptingNewCustomExemplars = new AtomicBoolean(true);
+ private final SpanContext
+ spanContext; // may be null, in that case SpanContextSupplier.getSpanContext() is used.
- public ExemplarSampler(ExemplarSamplerConfig config) {
- this(config, null);
- }
+ public ExemplarSampler(ExemplarSamplerConfig config) {
+ this(config, null);
+ }
- /**
- * Constructor with an additional {code spanContext} argument.
- * This is useful for testing, but may also be useful in some production scenarios.
- * If {@code spanContext != null} that spanContext is used and
- * {@link io.prometheus.metrics.tracer.initializer.SpanContextSupplier SpanContextSupplier} is not used.
- * If {@code spanContext == null}
- * {@link io.prometheus.metrics.tracer.initializer.SpanContextSupplier#getSpanContext() SpanContextSupplier.getSpanContext()}
- * is called to find a span context.
- */
- public ExemplarSampler(ExemplarSamplerConfig config, SpanContext spanContext) {
- this.config = config;
- this.exemplars = new Exemplar[config.getNumberOfExemplars()];
- this.customExemplars = new Exemplar[exemplars.length];
- this.spanContext = spanContext;
- }
+ /**
+ * Constructor with an additional {code spanContext} argument. This is useful for testing, but may
+ * also be useful in some production scenarios. If {@code spanContext != null} that spanContext is
+ * used and {@link io.prometheus.metrics.tracer.initializer.SpanContextSupplier
+ * SpanContextSupplier} is not used. If {@code spanContext == null} {@link
+ * io.prometheus.metrics.tracer.initializer.SpanContextSupplier#getSpanContext()
+ * SpanContextSupplier.getSpanContext()} is called to find a span context.
+ */
+ public ExemplarSampler(ExemplarSamplerConfig config, SpanContext spanContext) {
+ this.config = config;
+ this.exemplars = new Exemplar[config.getNumberOfExemplars()];
+ this.customExemplars = new Exemplar[exemplars.length];
+ this.spanContext = spanContext;
+ }
- public Exemplars collect() {
- // this may run in parallel with observe()
- long now = System.currentTimeMillis();
- List result = new ArrayList<>(exemplars.length);
- for (int i = 0; i < customExemplars.length; i++) {
- Exemplar exemplar = customExemplars[i];
- if (exemplar != null) {
- if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
- customExemplars[i] = null;
- } else {
- result.add(exemplar);
- }
- }
+ public Exemplars collect() {
+ // this may run in parallel with observe()
+ long now = System.currentTimeMillis();
+ List result = new ArrayList<>(exemplars.length);
+ for (int i = 0; i < customExemplars.length; i++) {
+ Exemplar exemplar = customExemplars[i];
+ if (exemplar != null) {
+ if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
+ customExemplars[i] = null;
+ } else {
+ result.add(exemplar);
}
- for (int i = 0; i < exemplars.length && result.size() < exemplars.length; i++) {
- Exemplar exemplar = exemplars[i];
- if (exemplar != null) {
- if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
- exemplars[i] = null;
- } else {
- result.add(exemplar);
- }
- }
+ }
+ }
+ for (int i = 0; i < exemplars.length && result.size() < exemplars.length; i++) {
+ Exemplar exemplar = exemplars[i];
+ if (exemplar != null) {
+ if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
+ exemplars[i] = null;
+ } else {
+ result.add(exemplar);
}
- return Exemplars.of(result);
+ }
}
+ return Exemplars.of(result);
+ }
- public void reset() {
- for (int i = 0; i < exemplars.length; i++) {
- exemplars[i] = null;
- customExemplars[i] = null;
- }
+ public void reset() {
+ for (int i = 0; i < exemplars.length; i++) {
+ exemplars[i] = null;
+ customExemplars[i] = null;
}
+ }
- public void observe(double value) {
- if (!acceptingNewExemplars.get()) {
- return; // This is the hot path in a high-throughput application and should be as efficient as possible.
- }
- rateLimitedObserve(acceptingNewExemplars, value, exemplars, () -> doObserve(value));
+ public void observe(double value) {
+ if (!acceptingNewExemplars.get()) {
+ return; // This is the hot path in a high-throughput application and should be as efficient as
+ // possible.
}
+ rateLimitedObserve(acceptingNewExemplars, value, exemplars, () -> doObserve(value));
+ }
- public void observeWithExemplar(double value, Labels labels) {
- if (!acceptingNewCustomExemplars.get()) {
- return; // This is the hot path in a high-throughput application and should be as efficient as possible.
- }
- rateLimitedObserve(acceptingNewCustomExemplars, value, customExemplars, () -> doObserveWithExemplar(value, labels));
+ public void observeWithExemplar(double value, Labels labels) {
+ if (!acceptingNewCustomExemplars.get()) {
+ return; // This is the hot path in a high-throughput application and should be as efficient as
+ // possible.
}
+ rateLimitedObserve(
+ acceptingNewCustomExemplars,
+ value,
+ customExemplars,
+ () -> doObserveWithExemplar(value, labels));
+ }
- private long doObserve(double value) {
- if (exemplars.length == 1) {
- return doObserveSingleExemplar(value);
- } else if (config.getHistogramClassicUpperBounds() != null) {
- return doObserveWithUpperBounds(value);
- } else {
- return doObserveWithoutUpperBounds(value);
- }
+ private long doObserve(double value) {
+ if (exemplars.length == 1) {
+ return doObserveSingleExemplar(value);
+ } else if (config.getHistogramClassicUpperBounds() != null) {
+ return doObserveWithUpperBounds(value);
+ } else {
+ return doObserveWithoutUpperBounds(value);
}
+ }
- private long doObserveSingleExemplar(double value) {
- long now = System.currentTimeMillis();
- Exemplar current = exemplars[0];
- if (current == null || now - current.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
- return updateExemplar(0, value, now);
- }
- return 0;
+ private long doObserveSingleExemplar(double value) {
+ long now = System.currentTimeMillis();
+ Exemplar current = exemplars[0];
+ if (current == null
+ || now - current.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
+ return updateExemplar(0, value, now);
}
+ return 0;
+ }
- private long doObserveWithUpperBounds(double value) {
- long now = System.currentTimeMillis();
- double[] upperBounds = config.getHistogramClassicUpperBounds();
- for (int i = 0; i < upperBounds.length; i++) {
- if (value <= upperBounds[i]) {
- Exemplar previous = exemplars[i];
- if (previous == null || now - previous.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
- return updateExemplar(i, value, now);
- } else {
- return 0;
- }
- }
+ private long doObserveWithUpperBounds(double value) {
+ long now = System.currentTimeMillis();
+ double[] upperBounds = config.getHistogramClassicUpperBounds();
+ for (int i = 0; i < upperBounds.length; i++) {
+ if (value <= upperBounds[i]) {
+ Exemplar previous = exemplars[i];
+ if (previous == null
+ || now - previous.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
+ return updateExemplar(i, value, now);
+ } else {
+ return 0;
}
- return 0; // will never happen, as upperBounds contains +Inf
+ }
}
+ return 0; // will never happen, as upperBounds contains +Inf
+ }
- private long doObserveWithoutUpperBounds(double value) {
- final long now = System.currentTimeMillis();
- Exemplar smallest = null;
- int smallestIndex = -1;
- Exemplar largest = null;
- int largestIndex = -1;
- int nullIndex = -1;
- for (int i = exemplars.length - 1; i >= 0; i--) {
- Exemplar exemplar = exemplars[i];
- if (exemplar == null) {
- nullIndex = i;
- } else if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
- exemplars[i] = null;
- nullIndex = i;
- } else {
- if (smallest == null || exemplar.getValue() < smallest.getValue()) {
- smallest = exemplar;
- smallestIndex = i;
- }
- if (largest == null || exemplar.getValue() > largest.getValue()) {
- largest = exemplar;
- largestIndex = i;
- }
- }
- }
- if (nullIndex >= 0) {
- return updateExemplar(nullIndex, value, now);
- }
- if (now - smallest.getTimestampMillis() > config.getMinRetentionPeriodMillis() && value < smallest.getValue()) {
- return updateExemplar(smallestIndex, value, now);
- }
- if (now - largest.getTimestampMillis() > config.getMinRetentionPeriodMillis() && value > largest.getValue()) {
- return updateExemplar(largestIndex, value, now);
- }
- long oldestTimestamp = 0;
- int oldestIndex = -1;
- for (int i = 0; i < exemplars.length; i++) {
- Exemplar exemplar = exemplars[i];
- if (exemplar != null && exemplar != smallest && exemplar != largest) {
- if (oldestTimestamp == 0 || exemplar.getTimestampMillis() < oldestTimestamp) {
- oldestTimestamp = exemplar.getTimestampMillis();
- oldestIndex = i;
- }
- }
+ private long doObserveWithoutUpperBounds(double value) {
+ final long now = System.currentTimeMillis();
+ Exemplar smallest = null;
+ int smallestIndex = -1;
+ Exemplar largest = null;
+ int largestIndex = -1;
+ int nullIndex = -1;
+ for (int i = exemplars.length - 1; i >= 0; i--) {
+ Exemplar exemplar = exemplars[i];
+ if (exemplar == null) {
+ nullIndex = i;
+ } else if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
+ exemplars[i] = null;
+ nullIndex = i;
+ } else {
+ if (smallest == null || exemplar.getValue() < smallest.getValue()) {
+ smallest = exemplar;
+ smallestIndex = i;
}
- if (oldestIndex != -1 && now - oldestTimestamp > config.getMinRetentionPeriodMillis()) {
- return updateExemplar(oldestIndex, value, now);
+ if (largest == null || exemplar.getValue() > largest.getValue()) {
+ largest = exemplar;
+ largestIndex = i;
}
- return 0;
+ }
}
-
- // Returns the timestamp of the newly added Exemplar (which is System.currentTimeMillis())
- // or 0 if no Exemplar was added.
- private long doObserveWithExemplar(double amount, Labels labels) {
- if (customExemplars.length == 1) {
- return doObserveSingleExemplar(amount, labels);
- } else if (config.getHistogramClassicUpperBounds() != null) {
- return doObserveWithExemplarWithUpperBounds(amount, labels);
- } else {
- return doObserveWithExemplarWithoutUpperBounds(amount, labels);
+ if (nullIndex >= 0) {
+ return updateExemplar(nullIndex, value, now);
+ }
+ if (now - smallest.getTimestampMillis() > config.getMinRetentionPeriodMillis()
+ && value < smallest.getValue()) {
+ return updateExemplar(smallestIndex, value, now);
+ }
+ if (now - largest.getTimestampMillis() > config.getMinRetentionPeriodMillis()
+ && value > largest.getValue()) {
+ return updateExemplar(largestIndex, value, now);
+ }
+ long oldestTimestamp = 0;
+ int oldestIndex = -1;
+ for (int i = 0; i < exemplars.length; i++) {
+ Exemplar exemplar = exemplars[i];
+ if (exemplar != null && exemplar != smallest && exemplar != largest) {
+ if (oldestTimestamp == 0 || exemplar.getTimestampMillis() < oldestTimestamp) {
+ oldestTimestamp = exemplar.getTimestampMillis();
+ oldestIndex = i;
}
+ }
}
+ if (oldestIndex != -1 && now - oldestTimestamp > config.getMinRetentionPeriodMillis()) {
+ return updateExemplar(oldestIndex, value, now);
+ }
+ return 0;
+ }
- private long doObserveSingleExemplar(double amount, Labels labels) {
- long now = System.currentTimeMillis();
- Exemplar current = customExemplars[0];
- if (current == null || now - current.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
- return updateCustomExemplar(0, amount, labels, now);
- }
- return 0;
+ // Returns the timestamp of the newly added Exemplar (which is System.currentTimeMillis())
+ // or 0 if no Exemplar was added.
+ private long doObserveWithExemplar(double amount, Labels labels) {
+ if (customExemplars.length == 1) {
+ return doObserveSingleExemplar(amount, labels);
+ } else if (config.getHistogramClassicUpperBounds() != null) {
+ return doObserveWithExemplarWithUpperBounds(amount, labels);
+ } else {
+ return doObserveWithExemplarWithoutUpperBounds(amount, labels);
}
+ }
- private long doObserveWithExemplarWithUpperBounds(double value, Labels labels) {
- long now = System.currentTimeMillis();
- double[] upperBounds = config.getHistogramClassicUpperBounds();
- for (int i = 0; i < upperBounds.length; i++) {
- if (value <= upperBounds[i]) {
- Exemplar previous = customExemplars[i];
- if (previous == null || now - previous.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
- return updateCustomExemplar(i, value, labels, now);
- } else {
- return 0;
- }
- }
- }
- return 0; // will never happen, as upperBounds contains +Inf
+ private long doObserveSingleExemplar(double amount, Labels labels) {
+ long now = System.currentTimeMillis();
+ Exemplar current = customExemplars[0];
+ if (current == null
+ || now - current.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
+ return updateCustomExemplar(0, amount, labels, now);
}
+ return 0;
+ }
- private long doObserveWithExemplarWithoutUpperBounds(double amount, Labels labels) {
- final long now = System.currentTimeMillis();
- int nullPos = -1;
- int oldestPos = -1;
- Exemplar oldest = null;
- for (int i = customExemplars.length - 1; i >= 0; i--) {
- Exemplar exemplar = customExemplars[i];
- if (exemplar == null) {
- nullPos = i;
- } else if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
- customExemplars[i] = null;
- nullPos = i;
- } else {
- if (oldest == null || exemplar.getTimestampMillis() < oldest.getTimestampMillis()) {
- oldest = exemplar;
- oldestPos = i;
- }
- }
- }
- if (nullPos != -1) {
- return updateCustomExemplar(nullPos, amount, labels, now);
- } else if (now - oldest.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
- return updateCustomExemplar(oldestPos, amount, labels, now);
+ private long doObserveWithExemplarWithUpperBounds(double value, Labels labels) {
+ long now = System.currentTimeMillis();
+ double[] upperBounds = config.getHistogramClassicUpperBounds();
+ for (int i = 0; i < upperBounds.length; i++) {
+ if (value <= upperBounds[i]) {
+ Exemplar previous = customExemplars[i];
+ if (previous == null
+ || now - previous.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
+ return updateCustomExemplar(i, value, labels, now);
} else {
- return 0;
+ return 0;
}
+ }
}
+ return 0; // will never happen, as upperBounds contains +Inf
+ }
- /**
- * Observing requires a system call to {@link System#currentTimeMillis()},
- * and it requires iterating over the existing exemplars to check if one of the existing
- * exemplars can be replaced.
- *
- * To avoid performance issues, we rate limit observing exemplars to
- * {@link ExemplarSamplerConfig#getSampleIntervalMillis()} milliseconds.
- */
- private void rateLimitedObserve(AtomicBoolean accepting, double value, Exemplar[] exemplars, LongSupplier observeFunc) {
- if (Double.isNaN(value)) {
- return;
- }
- if (!accepting.compareAndSet(true, false)) {
- return;
+ private long doObserveWithExemplarWithoutUpperBounds(double amount, Labels labels) {
+ final long now = System.currentTimeMillis();
+ int nullPos = -1;
+ int oldestPos = -1;
+ Exemplar oldest = null;
+ for (int i = customExemplars.length - 1; i >= 0; i--) {
+ Exemplar exemplar = customExemplars[i];
+ if (exemplar == null) {
+ nullPos = i;
+ } else if (now - exemplar.getTimestampMillis() > config.getMaxRetentionPeriodMillis()) {
+ customExemplars[i] = null;
+ nullPos = i;
+ } else {
+ if (oldest == null || exemplar.getTimestampMillis() < oldest.getTimestampMillis()) {
+ oldest = exemplar;
+ oldestPos = i;
}
- // observeFunc returns the current timestamp or 0 if no Exemplar was added.
- long now = observeFunc.getAsLong();
- long sleepTime = now == 0 ? config.getSampleIntervalMillis() : durationUntilNextExemplarExpires(now);
- Scheduler.schedule(() -> accepting.compareAndSet(false, true), sleepTime, TimeUnit.MILLISECONDS);
+ }
}
+ if (nullPos != -1) {
+ return updateCustomExemplar(nullPos, amount, labels, now);
+ } else if (now - oldest.getTimestampMillis() > config.getMinRetentionPeriodMillis()) {
+ return updateCustomExemplar(oldestPos, amount, labels, now);
+ } else {
+ return 0;
+ }
+ }
- private long durationUntilNextExemplarExpires(long now) {
- long oldestTimestamp = now;
- for (Exemplar exemplar : exemplars) {
- if (exemplar == null) {
- return config.getSampleIntervalMillis();
- } else if (exemplar.getTimestampMillis() < oldestTimestamp) {
- oldestTimestamp = exemplar.getTimestampMillis();
- }
- }
- long oldestAge = now - oldestTimestamp;
- if (oldestAge < config.getMinRetentionPeriodMillis()) {
- return config.getMinRetentionPeriodMillis() - oldestAge;
- }
+ /**
+ * Observing requires a system call to {@link System#currentTimeMillis()}, and it requires
+ * iterating over the existing exemplars to check if one of the existing exemplars can be
+ * replaced.
+ *
+ *
To avoid performance issues, we rate limit observing exemplars to {@link
+ * ExemplarSamplerConfig#getSampleIntervalMillis()} milliseconds.
+ */
+ private void rateLimitedObserve(
+ AtomicBoolean accepting, double value, Exemplar[] exemplars, LongSupplier observeFunc) {
+ if (Double.isNaN(value)) {
+ return;
+ }
+ if (!accepting.compareAndSet(true, false)) {
+ return;
+ }
+ // observeFunc returns the current timestamp or 0 if no Exemplar was added.
+ long now = observeFunc.getAsLong();
+ long sleepTime =
+ now == 0 ? config.getSampleIntervalMillis() : durationUntilNextExemplarExpires(now);
+ Scheduler.schedule(
+ () -> accepting.compareAndSet(false, true), sleepTime, TimeUnit.MILLISECONDS);
+ }
+
+ private long durationUntilNextExemplarExpires(long now) {
+ long oldestTimestamp = now;
+ for (Exemplar exemplar : exemplars) {
+ if (exemplar == null) {
return config.getSampleIntervalMillis();
+ } else if (exemplar.getTimestampMillis() < oldestTimestamp) {
+ oldestTimestamp = exemplar.getTimestampMillis();
+ }
+ }
+ long oldestAge = now - oldestTimestamp;
+ if (oldestAge < config.getMinRetentionPeriodMillis()) {
+ return config.getMinRetentionPeriodMillis() - oldestAge;
}
+ return config.getSampleIntervalMillis();
+ }
- private long updateCustomExemplar(int index, double value, Labels labels, long now) {
- if (!labels.contains(Exemplar.TRACE_ID) && !labels.contains(Exemplar.SPAN_ID)) {
- labels = labels.merge(doSampleExemplar());
- }
- customExemplars[index] = Exemplar.builder()
- .value(value)
- .labels(labels)
- .timestampMillis(now)
- .build();
- return now;
+ private long updateCustomExemplar(int index, double value, Labels labels, long now) {
+ if (!labels.contains(Exemplar.TRACE_ID) && !labels.contains(Exemplar.SPAN_ID)) {
+ labels = labels.merge(doSampleExemplar());
}
+ customExemplars[index] =
+ Exemplar.builder().value(value).labels(labels).timestampMillis(now).build();
+ return now;
+ }
- private long updateExemplar(int index, double value, long now) {
- Labels traceLabels = doSampleExemplar();
- if (!traceLabels.isEmpty()) {
- exemplars[index] = Exemplar.builder()
- .value(value)
- .labels(traceLabels)
- .timestampMillis(now)
- .build();
- return now;
- } else {
- return 0;
- }
+ private long updateExemplar(int index, double value, long now) {
+ Labels traceLabels = doSampleExemplar();
+ if (!traceLabels.isEmpty()) {
+ exemplars[index] =
+ Exemplar.builder().value(value).labels(traceLabels).timestampMillis(now).build();
+ return now;
+ } else {
+ return 0;
}
+ }
- private Labels doSampleExemplar() {
- // Using the qualified name so that Micrometer can exclude the dependency on prometheus-metrics-tracer-initializer
- // as they provide their own implementation of SpanContextSupplier.
- // If we had an import statement for SpanContextSupplier the dependency would be needed in any case.
- SpanContext spanContext = this.spanContext != null ? this.spanContext : io.prometheus.metrics.tracer.initializer.SpanContextSupplier.getSpanContext();
- try {
- if (spanContext != null) {
- if (spanContext.isCurrentSpanSampled()) {
- String spanId = spanContext.getCurrentSpanId();
- String traceId = spanContext.getCurrentTraceId();
- if (spanId != null && traceId != null) {
- spanContext.markCurrentSpanAsExemplar();
- return Labels.of(Exemplar.TRACE_ID, traceId, Exemplar.SPAN_ID, spanId);
- }
- }
- }
- } catch (NoClassDefFoundError ignored) {
+ private Labels doSampleExemplar() {
+ // Using the qualified name so that Micrometer can exclude the dependency on
+ // prometheus-metrics-tracer-initializer
+ // as they provide their own implementation of SpanContextSupplier.
+ // If we had an import statement for SpanContextSupplier the dependency would be needed in any
+ // case.
+ SpanContext spanContext =
+ this.spanContext != null
+ ? this.spanContext
+ : io.prometheus.metrics.tracer.initializer.SpanContextSupplier.getSpanContext();
+ try {
+ if (spanContext != null) {
+ if (spanContext.isCurrentSpanSampled()) {
+ String spanId = spanContext.getCurrentSpanId();
+ String traceId = spanContext.getCurrentTraceId();
+ if (spanId != null && traceId != null) {
+ spanContext.markCurrentSpanAsExemplar();
+ return Labels.of(Exemplar.TRACE_ID, traceId, Exemplar.SPAN_ID, spanId);
+ }
}
- return Labels.EMPTY;
+ }
+ } catch (NoClassDefFoundError ignored) {
}
+ return Labels.EMPTY;
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSamplerConfig.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSamplerConfig.java
index 9712f29df..7acfbec22 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSamplerConfig.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/exemplars/ExemplarSamplerConfig.java
@@ -2,134 +2,143 @@
import io.prometheus.metrics.config.ExemplarsProperties;
import io.prometheus.metrics.config.PrometheusProperties;
-
import java.util.concurrent.TimeUnit;
public class ExemplarSamplerConfig {
- /**
- * See {@link ExemplarsProperties#getMinRetentionPeriodSeconds()}
- */
- public static final int DEFAULT_MIN_RETENTION_PERIOD_SECONDS = 7;
-
- /**
- * See {@link ExemplarsProperties#getMaxRetentionPeriodSeconds()}
- */
- public static final int DEFAULT_MAX_RETENTION_PERIOD_SECONDS = 70;
-
- /**
- * See {@link ExemplarsProperties#getSampleIntervalMilliseconds()}
- */
- private static final int DEFAULT_SAMPLE_INTERVAL_MILLISECONDS = 90;
-
- private final long minRetentionPeriodMillis;
- private final long maxRetentionPeriodMillis;
- private final long sampleIntervalMillis;
- private final double[] histogramClassicUpperBounds; // null unless it's a classic histogram
- private final int numberOfExemplars; // if histogramClassicUpperBounds != null, then numberOfExemplars == histogramClassicUpperBounds.length
-
- /**
- * Constructor for all metric types except classic histograms.
- *
- * @param properties See {@link PrometheusProperties#getExemplarProperties()}.
- * @param numberOfExemplars Counters have 1 Exemplar, native histograms and summaries have 4 Exemplars by default.
- * For classic histogram use {@link #ExemplarSamplerConfig(ExemplarsProperties, double[])}.
- */
- public ExemplarSamplerConfig(ExemplarsProperties properties, int numberOfExemplars) {
- this(properties, numberOfExemplars, null);
- }
-
- /**
- * Constructor for classic histogram metrics.
- *
- * @param properties See {@link PrometheusProperties#getExemplarProperties()}.
- * @param histogramClassicUpperBounds the ExemplarSampler will provide one Exemplar per histogram bucket.
- * Must be sorted, and must include the +Inf bucket.
- */
- public ExemplarSamplerConfig(ExemplarsProperties properties, double[] histogramClassicUpperBounds) {
- this(properties, histogramClassicUpperBounds.length, histogramClassicUpperBounds);
+ /** See {@link ExemplarsProperties#getMinRetentionPeriodSeconds()} */
+ public static final int DEFAULT_MIN_RETENTION_PERIOD_SECONDS = 7;
+
+ /** See {@link ExemplarsProperties#getMaxRetentionPeriodSeconds()} */
+ public static final int DEFAULT_MAX_RETENTION_PERIOD_SECONDS = 70;
+
+ /** See {@link ExemplarsProperties#getSampleIntervalMilliseconds()} */
+ private static final int DEFAULT_SAMPLE_INTERVAL_MILLISECONDS = 90;
+
+ private final long minRetentionPeriodMillis;
+ private final long maxRetentionPeriodMillis;
+ private final long sampleIntervalMillis;
+ private final double[] histogramClassicUpperBounds; // null unless it's a classic histogram
+ private final int
+ numberOfExemplars; // if histogramClassicUpperBounds != null, then numberOfExemplars ==
+
+ // histogramClassicUpperBounds.length
+
+ /**
+ * Constructor for all metric types except classic histograms.
+ *
+ * @param properties See {@link PrometheusProperties#getExemplarProperties()}.
+ * @param numberOfExemplars Counters have 1 Exemplar, native histograms and summaries have 4
+ * Exemplars by default. For classic histogram use {@link
+ * #ExemplarSamplerConfig(ExemplarsProperties, double[])}.
+ */
+ public ExemplarSamplerConfig(ExemplarsProperties properties, int numberOfExemplars) {
+ this(properties, numberOfExemplars, null);
+ }
+
+ /**
+ * Constructor for classic histogram metrics.
+ *
+ * @param properties See {@link PrometheusProperties#getExemplarProperties()}.
+ * @param histogramClassicUpperBounds the ExemplarSampler will provide one Exemplar per histogram
+ * bucket. Must be sorted, and must include the +Inf bucket.
+ */
+ public ExemplarSamplerConfig(
+ ExemplarsProperties properties, double[] histogramClassicUpperBounds) {
+ this(properties, histogramClassicUpperBounds.length, histogramClassicUpperBounds);
+ }
+
+ private ExemplarSamplerConfig(
+ ExemplarsProperties properties, int numberOfExemplars, double[] histogramClassicUpperBounds) {
+ this(
+ TimeUnit.SECONDS.toMillis(
+ getOrDefault(
+ properties.getMinRetentionPeriodSeconds(), DEFAULT_MIN_RETENTION_PERIOD_SECONDS)),
+ TimeUnit.SECONDS.toMillis(
+ getOrDefault(
+ properties.getMaxRetentionPeriodSeconds(), DEFAULT_MAX_RETENTION_PERIOD_SECONDS)),
+ getOrDefault(
+ properties.getSampleIntervalMilliseconds(), DEFAULT_SAMPLE_INTERVAL_MILLISECONDS),
+ numberOfExemplars,
+ histogramClassicUpperBounds);
+ }
+
+ ExemplarSamplerConfig(
+ long minRetentionPeriodMillis,
+ long maxRetentionPeriodMillis,
+ long sampleIntervalMillis,
+ int numberOfExemplars,
+ double[] histogramClassicUpperBounds) {
+ this.minRetentionPeriodMillis = minRetentionPeriodMillis;
+ this.maxRetentionPeriodMillis = maxRetentionPeriodMillis;
+ this.sampleIntervalMillis = sampleIntervalMillis;
+ this.numberOfExemplars = numberOfExemplars;
+ this.histogramClassicUpperBounds = histogramClassicUpperBounds;
+ validate();
+ }
+
+ private void validate() {
+ if (minRetentionPeriodMillis <= 0) {
+ throw new IllegalArgumentException(
+ minRetentionPeriodMillis + ": minRetentionPeriod must be > 0.");
}
-
- private ExemplarSamplerConfig(ExemplarsProperties properties, int numberOfExemplars, double[] histogramClassicUpperBounds) {
- this(
- TimeUnit.SECONDS.toMillis(getOrDefault(properties.getMinRetentionPeriodSeconds(), DEFAULT_MIN_RETENTION_PERIOD_SECONDS)),
- TimeUnit.SECONDS.toMillis(getOrDefault(properties.getMaxRetentionPeriodSeconds(), DEFAULT_MAX_RETENTION_PERIOD_SECONDS)),
- getOrDefault(properties.getSampleIntervalMilliseconds(), DEFAULT_SAMPLE_INTERVAL_MILLISECONDS),
- numberOfExemplars,
- histogramClassicUpperBounds);
- }
-
- ExemplarSamplerConfig(long minRetentionPeriodMillis, long maxRetentionPeriodMillis, long sampleIntervalMillis, int numberOfExemplars, double[] histogramClassicUpperBounds) {
- this.minRetentionPeriodMillis = minRetentionPeriodMillis;
- this.maxRetentionPeriodMillis = maxRetentionPeriodMillis;
- this.sampleIntervalMillis = sampleIntervalMillis;
- this.numberOfExemplars = numberOfExemplars;
- this.histogramClassicUpperBounds = histogramClassicUpperBounds;
- validate();
+ if (maxRetentionPeriodMillis <= 0) {
+ throw new IllegalArgumentException(
+ maxRetentionPeriodMillis + ": maxRetentionPeriod must be > 0.");
}
-
- private void validate() {
- if (minRetentionPeriodMillis <= 0) {
- throw new IllegalArgumentException(minRetentionPeriodMillis + ": minRetentionPeriod must be > 0.");
- }
- if (maxRetentionPeriodMillis <= 0) {
- throw new IllegalArgumentException(maxRetentionPeriodMillis + ": maxRetentionPeriod must be > 0.");
- }
- if (histogramClassicUpperBounds != null) {
- if (histogramClassicUpperBounds.length == 0 || histogramClassicUpperBounds[histogramClassicUpperBounds.length - 1] != Double.POSITIVE_INFINITY) {
- throw new IllegalArgumentException("histogramClassicUpperBounds must contain the +Inf bucket.");
- }
- if (histogramClassicUpperBounds.length != numberOfExemplars) {
- throw new IllegalArgumentException("histogramClassicUpperBounds.length must be equal to numberOfExemplars.");
- }
- double bound = histogramClassicUpperBounds[0];
- for (int i = 1; i < histogramClassicUpperBounds.length; i++) {
- if (bound >= histogramClassicUpperBounds[i]) {
- throw new IllegalArgumentException("histogramClassicUpperBounds must be sorted and must not contain duplicates.");
- }
- }
- }
- if (numberOfExemplars <= 0) {
- throw new IllegalArgumentException(numberOfExemplars + ": numberOfExemplars must be > 0.");
+ if (histogramClassicUpperBounds != null) {
+ if (histogramClassicUpperBounds.length == 0
+ || histogramClassicUpperBounds[histogramClassicUpperBounds.length - 1]
+ != Double.POSITIVE_INFINITY) {
+ throw new IllegalArgumentException(
+ "histogramClassicUpperBounds must contain the +Inf bucket.");
+ }
+ if (histogramClassicUpperBounds.length != numberOfExemplars) {
+ throw new IllegalArgumentException(
+ "histogramClassicUpperBounds.length must be equal to numberOfExemplars.");
+ }
+ double bound = histogramClassicUpperBounds[0];
+ for (int i = 1; i < histogramClassicUpperBounds.length; i++) {
+ if (bound >= histogramClassicUpperBounds[i]) {
+ throw new IllegalArgumentException(
+ "histogramClassicUpperBounds must be sorted and must not contain duplicates.");
}
+ }
}
-
- private static T getOrDefault(T result, T defaultValue) {
- return result != null ? result : defaultValue;
- }
-
- /**
- * May be {@code null}.
- */
- public double[] getHistogramClassicUpperBounds() {
- return histogramClassicUpperBounds;
- }
-
- /**
- * See {@link ExemplarsProperties#getMinRetentionPeriodSeconds()}
- */
- public long getMinRetentionPeriodMillis() {
- return minRetentionPeriodMillis;
- }
-
- /**
- * See {@link ExemplarsProperties#getMaxRetentionPeriodSeconds()}
- */
- public long getMaxRetentionPeriodMillis() {
- return maxRetentionPeriodMillis;
- }
-
- /**
- * See {@link ExemplarsProperties#getSampleIntervalMilliseconds()}
- */
- public long getSampleIntervalMillis() {
- return sampleIntervalMillis;
- }
-
- /**
- * Defaults: Counters have one Exemplar, native histograms and summaries have 4 Exemplars, classic histograms have one Exemplar per bucket.
- */
- public int getNumberOfExemplars() {
- return numberOfExemplars;
+ if (numberOfExemplars <= 0) {
+ throw new IllegalArgumentException(numberOfExemplars + ": numberOfExemplars must be > 0.");
}
+ }
+
+ private static T getOrDefault(T result, T defaultValue) {
+ return result != null ? result : defaultValue;
+ }
+
+ /** May be {@code null}. */
+ public double[] getHistogramClassicUpperBounds() {
+ return histogramClassicUpperBounds;
+ }
+
+ /** See {@link ExemplarsProperties#getMinRetentionPeriodSeconds()} */
+ public long getMinRetentionPeriodMillis() {
+ return minRetentionPeriodMillis;
+ }
+
+ /** See {@link ExemplarsProperties#getMaxRetentionPeriodSeconds()} */
+ public long getMaxRetentionPeriodMillis() {
+ return maxRetentionPeriodMillis;
+ }
+
+ /** See {@link ExemplarsProperties#getSampleIntervalMilliseconds()} */
+ public long getSampleIntervalMillis() {
+ return sampleIntervalMillis;
+ }
+
+ /**
+ * Defaults: Counters have one Exemplar, native histograms and summaries have 4 Exemplars, classic
+ * histograms have one Exemplar per bucket.
+ */
+ public int getNumberOfExemplars() {
+ return numberOfExemplars;
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/Buffer.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/Buffer.java
index 390a2bc2b..113a85d55 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/Buffer.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/Buffer.java
@@ -1,7 +1,6 @@
package io.prometheus.metrics.core.metrics;
import io.prometheus.metrics.model.snapshots.DataPointSnapshot;
-
import java.util.Arrays;
import java.util.concurrent.atomic.AtomicLong;
import java.util.function.Consumer;
@@ -10,75 +9,74 @@
/**
* Metrics support concurrent write and scrape operations.
- *
- * This is implemented by switching to a Buffer when the scrape starts,
- * and applying the values from the buffer after the scrape ends.
+ *
+ *
This is implemented by switching to a Buffer when the scrape starts, and applying the values
+ * from the buffer after the scrape ends.
*/
class Buffer {
- private static final long signBit = 1L << 63;
- private final AtomicLong observationCount = new AtomicLong(0);
- private double[] observationBuffer = new double[0];
- private int bufferPos = 0;
- private boolean reset = false;
- private final Object appendLock = new Object();
- private final Object runLock = new Object();
+ private static final long signBit = 1L << 63;
+ private final AtomicLong observationCount = new AtomicLong(0);
+ private double[] observationBuffer = new double[0];
+ private int bufferPos = 0;
+ private boolean reset = false;
+ private final Object appendLock = new Object();
+ private final Object runLock = new Object();
- boolean append(double value) {
- long count = observationCount.incrementAndGet();
- if ((count & signBit) == 0) {
- return false; // sign bit not set -> buffer not active.
- } else {
- doAppend(value);
- return true;
- }
+ boolean append(double value) {
+ long count = observationCount.incrementAndGet();
+ if ((count & signBit) == 0) {
+ return false; // sign bit not set -> buffer not active.
+ } else {
+ doAppend(value);
+ return true;
}
+ }
- private void doAppend(double amount) {
- synchronized (appendLock) {
- if (bufferPos >= observationBuffer.length) {
- observationBuffer = Arrays.copyOf(observationBuffer, observationBuffer.length + 128);
- }
- observationBuffer[bufferPos] = amount;
- bufferPos++;
- }
+ private void doAppend(double amount) {
+ synchronized (appendLock) {
+ if (bufferPos >= observationBuffer.length) {
+ observationBuffer = Arrays.copyOf(observationBuffer, observationBuffer.length + 128);
+ }
+ observationBuffer[bufferPos] = amount;
+ bufferPos++;
}
+ }
- /**
- * Must be called by the runnable in the run() method.
- */
- void reset() {
- reset = true;
- }
+ /** Must be called by the runnable in the run() method. */
+ void reset() {
+ reset = true;
+ }
- T run(Function complete, Supplier runnable, Consumer observeFunction) {
- double[] buffer;
- int bufferSize;
- T result;
- synchronized (runLock) {
- Long count = observationCount.getAndAdd(signBit);
- while (!complete.apply(count)) {
- Thread.yield();
- }
- result = runnable.get();
- int expectedBufferSize;
- if (reset) {
- expectedBufferSize = (int) ((observationCount.getAndSet(0) & ~signBit) - count);
- reset = false;
- } else {
- expectedBufferSize = (int) (observationCount.addAndGet(signBit) - count);
- }
- while (bufferPos != expectedBufferSize) {
- Thread.yield();
- }
- buffer = observationBuffer;
- bufferSize = bufferPos;
- observationBuffer = new double[0];
- bufferPos = 0;
- }
- for (int i = 0; i < bufferSize; i++) {
- observeFunction.accept(buffer[i]);
- }
- return result;
+ T run(
+ Function complete, Supplier runnable, Consumer observeFunction) {
+ double[] buffer;
+ int bufferSize;
+ T result;
+ synchronized (runLock) {
+ Long count = observationCount.getAndAdd(signBit);
+ while (!complete.apply(count)) {
+ Thread.yield();
+ }
+ result = runnable.get();
+ int expectedBufferSize;
+ if (reset) {
+ expectedBufferSize = (int) ((observationCount.getAndSet(0) & ~signBit) - count);
+ reset = false;
+ } else {
+ expectedBufferSize = (int) (observationCount.addAndGet(signBit) - count);
+ }
+ while (bufferPos != expectedBufferSize) {
+ Thread.yield();
+ }
+ buffer = observationBuffer;
+ bufferSize = bufferPos;
+ observationBuffer = new double[0];
+ bufferPos = 0;
+ }
+ for (int i = 0; i < bufferSize; i++) {
+ observeFunction.accept(buffer[i]);
}
+ return result;
+ }
}
diff --git a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/CKMSQuantiles.java b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/CKMSQuantiles.java
index 22662c62e..c86f17c21 100644
--- a/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/CKMSQuantiles.java
+++ b/prometheus-metrics-core/src/main/java/io/prometheus/metrics/core/metrics/CKMSQuantiles.java
@@ -6,20 +6,20 @@
// However, it has been heavily refactored in the meantime.
/*
- Copyright 2012 Andrew Wang (andrew@umbrant.com)
+Copyright 2012 Andrew Wang (andrew@umbrant.com)
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
+http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
import java.util.Arrays;
import java.util.Iterator;
@@ -27,270 +27,248 @@
import java.util.ListIterator;
/**
- * Algorithm solving the "Targeted Quantile Problem" as described in
- * "Effective Computation of Biased Quantiles over Data Streams"
- * by Cormode, Korn, Muthukrishnan, and Srivastava.
- *
+ * Algorithm solving the "Targeted Quantile Problem" as described in "Effective Computation of
+ * Biased Quantiles over Data Streams" by Cormode, Korn, Muthukrishnan, and Srivastava.
*/
final class CKMSQuantiles {
- final Quantile[] quantiles;
+ final Quantile[] quantiles;
- /**
- * Total number of observations (not including those that are still in the buffer).
- */
- int n = 0;
+ /** Total number of observations (not including those that are still in the buffer). */
+ int n = 0;
- /**
- * List of sampled observations, ordered by Sample.value.
- */
- final LinkedList samples = new LinkedList();
-
- /**
- * Compress is called every compressInterval inserts.
- * Note that the buffer is flushed whenever get() is called, so we
- * cannot just wait until the buffer is full before we call compress.
- */
- private final int compressInterval = 128;
- private int insertsSinceLastCompress = 0;
+ /** List of sampled observations, ordered by Sample.value. */
+ final LinkedList samples = new LinkedList();
- /**
- * Note that the buffer size could as well be less than the compressInterval.
- * However, the buffer size should not be greater than the compressInterval,
- * because the compressInterval is not respected in flush(), so if you want
- * to compress more often than calling flush() that won't work.
- */
- private final double[] buffer = new double[compressInterval];
- private int bufferPos = 0;
+ /**
+ * Compress is called every compressInterval inserts. Note that the buffer is flushed whenever
+ * get() is called, so we cannot just wait until the buffer is full before we call compress.
+ */
+ private final int compressInterval = 128;
- public CKMSQuantiles(Quantile... quantiles) {
- if (quantiles.length == 0) {
- throw new IllegalArgumentException("quantiles cannot be empty");
- }
- this.quantiles = quantiles;
- }
+ private int insertsSinceLastCompress = 0;
- /**
- * Add an observed value
- */
- public void insert(double value) {
- buffer[bufferPos++] = value;
+ /**
+ * Note that the buffer size could as well be less than the compressInterval. However, the buffer
+ * size should not be greater than the compressInterval, because the compressInterval is not
+ * respected in flush(), so if you want to compress more often than calling flush() that won't
+ * work.
+ */
+ private final double[] buffer = new double[compressInterval];
- if (bufferPos == buffer.length) {
- flush();
- }
+ private int bufferPos = 0;
- if (++insertsSinceLastCompress == compressInterval) {
- compress();
- insertsSinceLastCompress = 0;
- }
+ public CKMSQuantiles(Quantile... quantiles) {
+ if (quantiles.length == 0) {
+ throw new IllegalArgumentException("quantiles cannot be empty");
}
+ this.quantiles = quantiles;
+ }
- private void flush() {
- Arrays.sort(buffer, 0, bufferPos);
- insertBatch(buffer, bufferPos);
- bufferPos = 0;
- }
+ /** Add an observed value */
+ public void insert(double value) {
+ buffer[bufferPos++] = value;
- /**
- * Inserts the elements from index 0 to index toIndex from the sortedBuffer.
- */
- void insertBatch(double[] sortedBuffer, int toIndex) {
- if (toIndex == 0) {
- return;
- }
- ListIterator iterator = samples.listIterator();
- int i = 0; // position in buffer
- int r = 0; // sum of g's left of the current sample
- while (iterator.hasNext() && i < toIndex) {
- Sample item = iterator.next();
- while (i < toIndex) {
- if (sortedBuffer[i] > item.value) {
- break;
- }
- insertBefore(iterator, sortedBuffer[i], r);
- r++; // new item with g=1 was inserted before, so increment r
- i++;
- n++;
- }
- r += item.g;
- }
- while (i < toIndex) {
- samples.add(new Sample(sortedBuffer[i], 0));
- i++;
- n++;
- }
+ if (bufferPos == buffer.length) {
+ flush();
}
- private void insertBefore(ListIterator iterator, double value, int r) {
- if (!iterator.hasPrevious()) {
- samples.addFirst(new Sample(value, 0));
- } else {
- iterator.previous();
- iterator.add(new Sample(value, f(r) - 1));
- iterator.next();
+ if (++insertsSinceLastCompress == compressInterval) {
+ compress();
+ insertsSinceLastCompress = 0;
+ }
+ }
+
+ private void flush() {
+ Arrays.sort(buffer, 0, bufferPos);
+ insertBatch(buffer, bufferPos);
+ bufferPos = 0;
+ }
+
+ /** Inserts the elements from index 0 to index toIndex from the sortedBuffer. */
+ void insertBatch(double[] sortedBuffer, int toIndex) {
+ if (toIndex == 0) {
+ return;
+ }
+ ListIterator iterator = samples.listIterator();
+ int i = 0; // position in buffer
+ int r = 0; // sum of g's left of the current sample
+ while (iterator.hasNext() && i < toIndex) {
+ Sample item = iterator.next();
+ while (i < toIndex) {
+ if (sortedBuffer[i] > item.value) {
+ break;
}
+ insertBefore(iterator, sortedBuffer[i], r);
+ r++; // new item with g=1 was inserted before, so increment r
+ i++;
+ n++;
+ }
+ r += item.g;
}
+ while (i < toIndex) {
+ samples.add(new Sample(sortedBuffer[i], 0));
+ i++;
+ n++;
+ }
+ }
+
+ private void insertBefore(ListIterator