Merge pull request #47978 from brunobat/micrometer-prometheus-client-v1

[Breaking change] Use prometheus client v1 on Micrometer

Author: brunobat

.github/native-tests.json

@@ -123,7 +123,7 @@
         {
             "category": "Observability",
             "timeout": 130,
-            "test-modules": "smallrye-metrics, micrometer-mp-metrics, micrometer-prometheus, logging-json, observability-lgtm, opentelemetry, opentelemetry-jdbc-instrumentation, opentelemetry-mongodb-client-instrumentation, opentelemetry-redis-instrumentation, micrometer-opentelemetry",
+            "test-modules": "smallrye-metrics, micrometer-mp-metrics, micrometer-prometheus, micrometer-prometheus-opentelemetry, logging-json, observability-lgtm, opentelemetry, opentelemetry-jdbc-instrumentation, opentelemetry-mongodb-client-instrumentation, opentelemetry-redis-instrumentation, micrometer-opentelemetry",
             "os-name": "ubuntu-latest"
         },
         {

bom/application/pom.xml

@@ -32,7 +32,7 @@
         <opentelemetry-instrumentation.version>2.10.0-alpha</opentelemetry-instrumentation.version>
         <opentelemetry-semconv.version>1.29.0-alpha</opentelemetry-semconv.version>
         <quarkus-http.version>5.3.5</quarkus-http.version>
-        <micrometer.version>1.14.7</micrometer.version><!-- keep in sync with hdrhistogram: https://central.sonatype.com/artifact/io.micrometer/micrometer-core -->
+        <micrometer.version>1.15.0</micrometer.version><!-- keep in sync with prometheus-client and hdrhistogram: https://central.sonatype.com/artifact/io.micrometer/micrometer-core -->
         <hdrhistogram.version>2.2.2</hdrhistogram.version><!-- keep in sync with micrometer -->
         <google-auth.version>0.22.0</google-auth.version>
         <graphql-java.version>22.2</graphql-java.version> <!-- keep in sync with smallrye-graphql -->
@@ -215,8 +215,6 @@
         <mutiny-zero.version>1.1.1</mutiny-zero.version>
         <pulsar-client.version>3.3.0</pulsar-client.version>
         <async-http-client.version>2.12.4</async-http-client.version>
-        <!-- keep in-sync, if possible, with Micrometer registry Prometheus -->
-        <prometheus.version>0.16.0</prometheus.version>
         <!-- Dev UI -->
         <importmap.version>1.0.11</importmap.version>
         <webauthn4j.version>0.28.0.RELEASE</webauthn4j.version>
@@ -537,18 +535,6 @@
                 <scope>import</scope>
             </dependency>
 
-            <!-- Prometheus -->
-            <dependency>
-                <groupId>io.prometheus</groupId>
-                <artifactId>simpleclient</artifactId>
-                <version>${prometheus.version}</version>
-            </dependency>
-            <dependency>
-                <groupId>io.prometheus</groupId>
-                <artifactId>simpleclient_common</artifactId>
-                <version>${prometheus.version}</version>
-            </dependency>
-
             <!-- Quarkus core -->
 
             <dependency>

docs/src/main/asciidoc/telemetry-micrometer-to-opentelemetry.adoc

@@ -137,7 +137,7 @@ The JVM and HTTP server metrics are collected by Micrometer.
 Next, are examples of the metrics collected by Micrometer and a comparison of what would be the `quarkus-micrometer-registry-prometheus` output vs the one on this bridge. A link to the equivalent OpenTelemetry Semantic Convention is also provided for reference and is not currently used in the bridge.
 
 |===
-|Micrometer Meter |Quarkus Micrometer Prometheus output | This bridge OpenTelemetry output name | Related OpenTelemetry Semantic Convention (not applied)
+|Micrometer Meter |Quarkus Micrometer Prometheus client v0.x output | This bridge OpenTelemetry output name | Related OpenTelemetry Semantic Convention (not applied)
 
 |Using the @Timed interceptor.
 |

docs/src/main/asciidoc/telemetry-micrometer-tutorial.adoc

@@ -88,7 +88,7 @@ You should find something like this:
 ----
 # HELP http_server_requests_seconds
 # TYPE http_server_requests_seconds summary
-http_server_requests_seconds_count{method="GET",outcome="SUCCESS",status="200",uri="/example/prime/{number}"} 2.0
+http_server_requests_seconds_count{method="GET",outcome="SUCCESS",status="200",uri="/example/prime/{number}"} 2
 http_server_requests_seconds_sum{method="GET",outcome="SUCCESS",status="200",uri="/example/prime/{number}"} 0.017385896
 # HELP http_server_requests_seconds_max
 # TYPE http_server_requests_seconds_max gauge

docs/src/main/asciidoc/telemetry-micrometer.adoc

@@ -24,6 +24,8 @@ IMPORTANT: Micrometer is the recommended approach to metrics for Quarkus.
 NOTE: By default, the metrics are exposed on the main HTTP server.
 If you would like to surface metrics from a separate management port, see the <<management-interface,Managed interface>> section.
 
+NOTE: `quarkus-micrometer` now uses the Prometheus client v1.x. For help migrating from the old client, please check the https://github.com/micrometer-metrics/micrometer/wiki/1.13-Migration-Guide[Prometheus Java client 0.x to 1.x upgrade]  from Micrometer.
+
 == Micrometer and monitoring system extensions
 
 Quarkus Micrometer extensions are structured in the same way as the Micrometer project.
@@ -33,7 +35,7 @@ Other Quarkus and Quarkiverse extensions use the Quarkus Micrometer extension to
 Quarkus extensions:
 
 - micrometer
-- micrometer-registry-prometheus
+- micrometer-registry-prometheus (Prometheus client v1.x)
 
 link:https://github.com/quarkiverse/quarkus-micrometer-registry[Quarkiverse extensions] (may be incomplete):
 
@@ -172,7 +174,7 @@ Micrometer applies naming conventions to convert registered meter names to match
 
 Given the following declaration of a timer: `registry.timer("http.server.requests")`, applied naming conventions will emit the following metrics for different monitoring systems:
 
-- Prometheus: `http_server_requests_duration_seconds`
+- Prometheus: `http_server_requests_seconds`
 - Atlas: `httpServerRequests`
 - Graphite: `http.server.requests`
 - InfluxDB: `http_server_requests`
@@ -569,7 +571,6 @@ public class CustomConfiguration {
                 if(id.getName().startsWith("myservice")) {
                     return DistributionStatisticConfig.builder()
                         .percentiles(0.5, 0.95)     // median and 95th percentile, not aggregable
-                        .percentilesHistogram(true) // histogram buckets (e.g. prometheus histogram_quantile)
                         .build()
                         .merge(config);
                 }

extensions/micrometer-registry-prometheus/deployment/pom.xml

@@ -27,7 +27,7 @@
 
         <dependency>
             <groupId>io.micrometer</groupId>
-            <artifactId>micrometer-registry-prometheus-simpleclient</artifactId>
+            <artifactId>micrometer-registry-prometheus</artifactId>
         </dependency>
 
     </dependencies>

extensions/micrometer-registry-prometheus/runtime/pom.xml

@@ -32,7 +32,7 @@
 
         <dependency>
             <groupId>io.micrometer</groupId>
-            <artifactId>micrometer-registry-prometheus-simpleclient</artifactId>
+            <artifactId>micrometer-registry-prometheus</artifactId>
         </dependency>
 
     </dependencies>

extensions/micrometer/deployment/pom.xml

@@ -63,7 +63,7 @@
 
         <dependency>
             <groupId>io.micrometer</groupId>
-            <artifactId>micrometer-registry-prometheus-simpleclient</artifactId>
+            <artifactId>micrometer-registry-prometheus</artifactId>
             <scope>test</scope>
         </dependency>
 

extensions/micrometer/deployment/src/main/java/io/quarkus/micrometer/deployment/export/PrometheusRegistryProcessor.java

@@ -34,7 +34,7 @@
 public class PrometheusRegistryProcessor {
     private static final Logger log = Logger.getLogger(PrometheusRegistryProcessor.class);
 
-    static final String REGISTRY_CLASS_NAME = "io.micrometer.prometheus.PrometheusMeterRegistry";
+    static final String REGISTRY_CLASS_NAME = "io.micrometer.prometheusmetrics.PrometheusMeterRegistry";
     static final Class<?> REGISTRY_CLASS = MicrometerRecorder.getClassForName(REGISTRY_CLASS_NAME);
 
     public static class PrometheusEnabled implements BooleanSupplier {

extensions/micrometer/deployment/src/test/java/io/quarkus/micrometer/deployment/export/JsonAndPrometheusRegistryEnabledTest.java

@@ -53,6 +53,6 @@ public void metricsEndpoint() {
                 .get("/relative/metrics")
                 .then()
                 .statusCode(200)
-                .body(containsString("jvm_info_total{runtime=\""));
+                .body(containsString("jvm_total{runtime=\""));
     }
 }