Merge branch 'main' into feat/typed-metric-family-descriptor

zeitlinger · web-flow · commit ae338cc332f9 · 2026-05-20T11:53:42.000+02:00
diff --git a/.github/renovate.json5 b/.github/renovate.json5
@@ -1,6 +1,6 @@
 {
   $schema: "https://docs.renovatebot.com/renovate-schema.json",
-  extends: ["config:best-practices", "config:recommended", "github>grafana/flint#v0.21.0"],
+  extends: ["config:best-practices", "config:recommended", "github>grafana/flint#v0.22.2"],
   platformCommit: "enabled",
   automerge: true,
   ignorePaths: [
diff --git a/.github/workflows/acceptance-tests.yml b/.github/workflows/acceptance-tests.yml
@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
       - name: Run acceptance tests
         run: mise run acceptance-test
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -14,8 +14,8 @@ jobs:
           persist-credentials: false
       - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
       - name: Cache local Maven repository
         uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
         with:
diff --git a/.github/workflows/generate-protobuf.yml b/.github/workflows/generate-protobuf.yml
@@ -21,8 +21,8 @@ jobs:
           persist-credentials: true
       - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
       - name: Cache local Maven repository
         uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
         with:
diff --git a/.github/workflows/github-pages.yaml b/.github/workflows/github-pages.yaml
@@ -39,8 +39,8 @@ jobs:
           fetch-depth: 0
       - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
           cache: "false"
       - name: Setup Pages
         id: pages
diff --git a/.github/workflows/java-version-matrix-tests.yml b/.github/workflows/java-version-matrix-tests.yml
@@ -33,8 +33,8 @@ jobs:
       - name: Set up mise
         uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
 
       - name: Cache local Maven repository
         uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -23,8 +23,8 @@ jobs:
       - name: Setup mise
         uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
 
       - name: Lint
         env:
diff --git a/.github/workflows/native-tests.yml b/.github/workflows/native-tests.yml
@@ -15,8 +15,8 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
           working_directory: .mise/envs/native
       - name: Run native tests
         working-directory: .mise/envs/native
diff --git a/.github/workflows/nightly-benchmarks.yml b/.github/workflows/nightly-benchmarks.yml
@@ -36,8 +36,8 @@ jobs:
       - name: Setup mise
         uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
 
       - name: Cache local Maven repository
         uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -29,8 +29,8 @@ jobs:
 
       - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
           cache: false
 
       - name: Build release version
diff --git a/.github/workflows/test-release-build.yml b/.github/workflows/test-release-build.yml
@@ -20,8 +20,8 @@ jobs:
           fetch-depth: 0
       - uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151 # v4.0.1
         with:
-          version: v2026.5.5
-          sha256: 3aaab5c05a8a94a93b42b4f581779bbd5c44ddb251e7f3639fc671ec5c6aab8a
+          version: v2026.5.11
+          sha256: 9bb41ae4dbe2bcdfdbe36cf3c737a8bdb72035c03af3b7218a70780988f62b9b
       - name: Cache local Maven repository
         uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
         with:
diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties
@@ -1,2 +1,2 @@
 distributionType=only-script
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.15/apache-maven-3.9.15-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.16/apache-maven-3.9.16-bin.zip
diff --git a/examples/example-custom-buckets/docker-compose.yaml b/examples/example-custom-buckets/docker-compose.yaml
@@ -1,7 +1,7 @@
 version: "3"
 services:
   example-application:
-    image: eclipse-temurin:25.0.3_9-jre@sha256:9c9e7c4f5f3840e5254be62ea9a7de56b2d0af23864032a8a3654bf63c31cd5b
+    image: eclipse-temurin:25.0.3_9-jre@sha256:04262e8782d6b034ee5d7c1c5d4e8938fcf2063a76b4bfcd84e5d994d09c27bc
     network_mode: host
     volumes:
       - ./target/example-custom-buckets.jar:/example-custom-buckets.jar
diff --git a/examples/example-exemplars-tail-sampling/docker-compose.yaml b/examples/example-exemplars-tail-sampling/docker-compose.yaml
@@ -36,7 +36,7 @@ services:
       - -jar
       - /example-greeting-service.jar
   collector:
-    image: otel/opentelemetry-collector-contrib:0.151.0@sha256:d57bfe8eee2378f31cb1193239fbcac521d54a5a071fca2bfc106916a32b892d
+    image: otel/opentelemetry-collector-contrib:0.152.0@sha256:f41d7995565df3733b7568702073a9c490792f9c6ac60684fe6a4da21a313f8d
     network_mode: host
     volumes:
       - ./config/otelcol-config.yaml:/config.yaml
diff --git a/examples/example-exporter-opentelemetry/docker-compose.yaml b/examples/example-exporter-opentelemetry/docker-compose.yaml
@@ -13,7 +13,7 @@ services:
       #- -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005
       - /example-exporter-opentelemetry.jar
   collector:
-    image: otel/opentelemetry-collector-contrib:0.151.0@sha256:d57bfe8eee2378f31cb1193239fbcac521d54a5a071fca2bfc106916a32b892d
+    image: otel/opentelemetry-collector-contrib:0.152.0@sha256:f41d7995565df3733b7568702073a9c490792f9c6ac60684fe6a4da21a313f8d
     network_mode: host
     volumes:
       - ./config/otelcol-config.yaml:/config.yaml
diff --git a/examples/example-exporter-opentelemetry/oats-tests/agent/Dockerfile b/examples/example-exporter-opentelemetry/oats-tests/agent/Dockerfile
@@ -1,4 +1,4 @@
-FROM eclipse-temurin:25.0.3_9-jre@sha256:9c9e7c4f5f3840e5254be62ea9a7de56b2d0af23864032a8a3654bf63c31cd5b
+FROM eclipse-temurin:25.0.3_9-jre@sha256:04262e8782d6b034ee5d7c1c5d4e8938fcf2063a76b4bfcd84e5d994d09c27bc
 
 COPY target/example-exporter-opentelemetry.jar ./app.jar
 # check that the resource attributes from the agent are used, epsecially the service.instance.id should be the same
diff --git a/examples/example-exporter-opentelemetry/oats-tests/http/Dockerfile b/examples/example-exporter-opentelemetry/oats-tests/http/Dockerfile
@@ -1,4 +1,4 @@
-FROM eclipse-temurin:25.0.3_9-jre@sha256:9c9e7c4f5f3840e5254be62ea9a7de56b2d0af23864032a8a3654bf63c31cd5b
+FROM eclipse-temurin:25.0.3_9-jre@sha256:04262e8782d6b034ee5d7c1c5d4e8938fcf2063a76b4bfcd84e5d994d09c27bc
 
 COPY target/example-exporter-opentelemetry.jar ./app.jar
 
diff --git a/examples/example-native-histogram/docker-compose.yaml b/examples/example-native-histogram/docker-compose.yaml
@@ -1,7 +1,7 @@
 version: "3"
 services:
   example-application:
-    image: eclipse-temurin:25.0.3_9-jre@sha256:9c9e7c4f5f3840e5254be62ea9a7de56b2d0af23864032a8a3654bf63c31cd5b
+    image: eclipse-temurin:25.0.3_9-jre@sha256:04262e8782d6b034ee5d7c1c5d4e8938fcf2063a76b4bfcd84e5d994d09c27bc
     network_mode: host
     volumes:
       - ./target/example-native-histogram.jar:/example-native-histogram.jar
diff --git a/examples/example-otel-jvm-runtime-metrics/pom.xml b/examples/example-otel-jvm-runtime-metrics/pom.xml
@@ -28,7 +28,7 @@
       <dependency>
         <groupId>io.opentelemetry.instrumentation</groupId>
         <artifactId>opentelemetry-instrumentation-bom-alpha</artifactId>
-        <version>2.27.0-alpha</version>
+        <version>2.28.0-alpha</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -51,7 +51,7 @@
     </dependency>
     <dependency>
       <groupId>io.opentelemetry.instrumentation</groupId>
-      <artifactId>opentelemetry-runtime-telemetry-java8</artifactId>
+      <artifactId>opentelemetry-runtime-telemetry</artifactId>
     </dependency>
   </dependencies>
 
diff --git a/examples/example-otel-jvm-runtime-metrics/src/main/java/io/prometheus/metrics/examples/otelruntimemetrics/Main.java b/examples/example-otel-jvm-runtime-metrics/src/main/java/io/prometheus/metrics/examples/otelruntimemetrics/Main.java
@@ -1,7 +1,7 @@
 package io.prometheus.metrics.examples.otelruntimemetrics;
 
 import io.opentelemetry.exporter.prometheus.PrometheusMetricReader;
-import io.opentelemetry.instrumentation.runtimemetrics.java8.RuntimeMetrics;
+import io.opentelemetry.instrumentation.runtimetelemetry.RuntimeTelemetry;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.prometheus.metrics.core.metrics.Counter;
@@ -47,11 +47,7 @@ public static void main(String[] args) throws IOException, InterruptedException
             .build();
 
     // 4. Start OTel JVM runtime metrics collection.
-    //    - captureGcCause() adds a jvm.gc.cause attribute to jvm.gc.duration
-    //    - emitExperimentalTelemetry() enables buffer pools, extended CPU,
-    //      extended memory pools, and file descriptor metrics
-    RuntimeMetrics runtimeMetrics =
-        RuntimeMetrics.builder(openTelemetry).captureGcCause().emitExperimentalTelemetry().build();
+    RuntimeTelemetry runtimeMetrics = RuntimeTelemetry.create(openTelemetry);
 
     // 5. Expose both Prometheus and OTel metrics on a single endpoint.
     HTTPServer server = HTTPServer.builder().port(9400).registry(registry).buildAndStart();
diff --git a/pom.xml b/pom.xml
@@ -23,7 +23,7 @@
     <protobuf-java.version>4.34.1</protobuf-java.version>
     <guava.version>33.6.0-jre</guava.version>
     <junit-jupiter.version>6.0.3</junit-jupiter.version>
-    <otel.instrumentation.version>2.27.0-alpha</otel.instrumentation.version>
+    <otel.instrumentation.version>2.28.0-alpha</otel.instrumentation.version>
     <java.version>8</java.version>
     <test.java.version>25</test.java.version>
     <jacoco.line-coverage>0.70</jacoco.line-coverage>
@@ -101,7 +101,7 @@
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-simple</artifactId>
-      <version>2.0.17</version>
+      <version>2.0.18</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -186,7 +186,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-enforcer-plugin</artifactId>
-          <version>3.6.2</version>
+          <version>3.6.3</version>
         </plugin>
         <plugin>
           <groupId>org.codehaus.mojo</groupId>
diff --git a/prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/PrometheusNaming.java b/prometheus-metrics-model/src/main/java/io/prometheus/metrics/model/snapshots/PrometheusNaming.java
@@ -17,6 +17,17 @@
  */
 public class PrometheusNaming {
 
+  /**
+   * Reserved metric name suffixes. These suffixes are automatically appended by Prometheus
+   * exposition format writers for specific metric types: {@code _total} and {@code _created} for
+   * counters, {@code _info} for info metrics, and {@code _bucket} for histograms. Including these
+   * in a base metric name via {@link #sanitizeMetricName(String)} would cause confusion or
+   * double-suffixing, so they are stripped during sanitization.
+   */
+  static final String[] RESERVED_METRIC_NAME_SUFFIXES = {
+    "_total", "_created", "_bucket", "_info", ".total", ".created", ".bucket", ".info"
+  };
+
   /**
    * Test if a metric name is valid. Any non-empty valid UTF-8 string is accepted.
    *
@@ -35,7 +46,9 @@ public class PrometheusNaming {
    * format, this will be represented as two values: {@code processing_time_seconds_total} for the
    * counter value, and the optional {@code processing_time_seconds_created} timestamp.
    *
-   * <p>Use {@link #sanitizeMetricName(String)} to convert arbitrary Strings to valid metric names.
+   * <p>Use {@link #sanitizeMetricName(String)} for compatibility-preserving sanitization that
+   * strips reserved suffixes, or {@link #normalizeMetricName(String)} for permissive normalization
+   * that keeps the original suffixes intact.
    */
   public static boolean isValidMetricName(String name) {
     return validateMetricName(name) == null;
@@ -153,16 +166,50 @@ public static String prometheusName(String name) {
   }
 
   /**
-   * Convert an arbitrary string to a valid metric name. Since any non-empty valid UTF-8 string is a
-   * valid metric name, this simply returns the input unchanged.
+   * Convert an arbitrary string to a valid metric name.
+   *
+   * <p>Reserved metric name suffixes ({@code _total}, {@code _created}, {@code _bucket}, {@code
+   * _info} and their dot variants) are stripped. These suffixes are appended automatically by
+   * Prometheus exposition format writers, so including them in a base metric name would result in
+   * double-suffixing or unintended type inference. For example, a JMX attribute named {@code
+   * RequestTotal} would be sanitized from {@code kafka_consumer_request_total} to {@code
+   * kafka_consumer_request}, and the counter writer would add {@code _total} back at scrape time.
+   *
+   * <p>This behaviour was present in client_java 1.5.x and is restored here to fix a regression
+   * introduced in 1.6.0 that affected downstream tools (e.g. the JMX Exporter and the simpleclient
+   * bridge) which relied on {@code sanitizeMetricName} to strip these suffixes before passing names
+   * to the snapshot builders.
+   *
+   * <p>If you want permissive normalization that keeps reserved suffixes intact, use {@link
+   * #normalizeMetricName(String)} instead.
    *
    * @throws IllegalArgumentException if the input is empty
    */
   public static String sanitizeMetricName(String metricName) {
     if (metricName.isEmpty()) {
       throw new IllegalArgumentException("Cannot convert an empty string to a valid metric name.");
     }
-    return metricName;
+    String sanitizedName = metricName;
+    boolean stripped = true;
+    while (stripped) {
+      stripped = false;
+      // When the name equals the suffix exactly, drop the leading separator character to avoid
+      // returning an empty string (e.g. "_total" → "total", ".info" → "info").
+      for (String reservedSuffix : RESERVED_METRIC_NAME_SUFFIXES) {
+        if (sanitizedName.equals(reservedSuffix)) {
+          return reservedSuffix.substring(1);
+        }
+      }
+      for (String reservedSuffix : RESERVED_METRIC_NAME_SUFFIXES) {
+        if (sanitizedName.endsWith(reservedSuffix)) {
+          sanitizedName =
+              sanitizedName.substring(0, sanitizedName.length() - reservedSuffix.length());
+          stripped = true;
+          break; // restart the outer loop to re-check all suffixes on the shortened name
+        }
+      }
+    }
+    return sanitizedName;
   }
 
   /**
@@ -179,6 +226,37 @@ public static String sanitizeMetricName(String metricName, Unit unit) {
     return result;
   }
 
+  /**
+   * Convert an arbitrary string to a valid metric name without stripping reserved suffixes.
+   *
+   * <p>Any non-empty valid UTF-8 string is accepted and returned unchanged. This is the permissive
+   * normalization behavior introduced in 1.6.0. Use this method for new integrations that want to
+   * preserve the original metric name and rely on registration-time collision detection instead of
+   * suffix stripping.
+   *
+   * @throws IllegalArgumentException if the input is empty
+   */
+  public static String normalizeMetricName(String metricName) {
+    if (metricName.isEmpty()) {
+      throw new IllegalArgumentException("Cannot convert an empty string to a valid metric name.");
+    }
+    return metricName;
+  }
+
+  /**
+   * Like {@link #normalizeMetricName(String)}, but also makes sure that the unit is appended as a
+   * suffix if the unit is not {@code null}.
+   */
+  public static String normalizeMetricName(String metricName, Unit unit) {
+    String result = normalizeMetricName(metricName);
+    if (unit != null) {
+      if (!result.endsWith("_" + unit) && !result.endsWith("." + unit)) {
+        result += "_" + unit;
+      }
+    }
+    return result;
+  }
+
   /**
    * Convert an arbitrary string to a name where {@link #isValidLabelName(String)
    * isValidLabelName(name)} is true.
diff --git a/prometheus-metrics-model/src/test/java/io/prometheus/metrics/model/snapshots/MetricMetadataTest.java b/prometheus-metrics-model/src/test/java/io/prometheus/metrics/model/snapshots/MetricMetadataTest.java
@@ -35,26 +35,30 @@ void testSanitizationIllegalCharacters() {
 
   @Test
   void testNameWithTotalSuffix() {
+    // sanitizeMetricName strips the reserved _total suffix.
     MetricMetadata metadata = new MetricMetadata(sanitizeMetricName("my_events_total"));
-    assertThat(metadata.getName()).isEqualTo("my_events_total");
+    assertThat(metadata.getName()).isEqualTo("my_events");
   }
 
   @Test
   void testNameWithInfoSuffix() {
+    // sanitizeMetricName strips the reserved _info suffix.
     MetricMetadata metadata = new MetricMetadata(sanitizeMetricName("target_info"));
-    assertThat(metadata.getName()).isEqualTo("target_info");
+    assertThat(metadata.getName()).isEqualTo("target");
   }
 
   @Test
   void testNameWithCreatedSuffix() {
+    // sanitizeMetricName strips the reserved _created suffix.
     MetricMetadata metadata = new MetricMetadata(sanitizeMetricName("my_events_created"));
-    assertThat(metadata.getName()).isEqualTo("my_events_created");
+    assertThat(metadata.getName()).isEqualTo("my_events");
   }
 
   @Test
   void testNameWithBucketSuffix() {
+    // sanitizeMetricName strips the reserved _bucket suffix.
     MetricMetadata metadata = new MetricMetadata(sanitizeMetricName("my_histogram_bucket"));
-    assertThat(metadata.getName()).isEqualTo("my_histogram_bucket");
+    assertThat(metadata.getName()).isEqualTo("my_histogram");
   }
 
   @Test
diff --git a/prometheus-metrics-model/src/test/java/io/prometheus/metrics/model/snapshots/PrometheusNamingTest.java b/prometheus-metrics-model/src/test/java/io/prometheus/metrics/model/snapshots/PrometheusNamingTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`$schema: "https://docs.renovatebot.com/renovate-schema.json",`
`3`		`- extends: ["config:best-practices", "config:recommended", "github>grafana/flint#v0.21.0"],`
	`3`	`+ extends: ["config:best-practices", "config:recommended", "github>grafana/flint#v0.22.2"],`
`4`	`4`	`platformCommit: "enabled",`
`5`	`5`	`automerge: true,`
`6`	`6`	`ignorePaths: [`