From e1b89bd033f96520c250638bbea495a8e72e913f Mon Sep 17 00:00:00 2001 From: barry3406 Date: Fri, 10 Apr 2026 22:43:32 -0700 Subject: [PATCH] Fix #16109: support Micrometer 1.13+ Prometheus package in MetricsSupportUtil Update isSupportPrometheus() to recognize both the legacy io.micrometer.prometheus.PrometheusConfig and the new io.micrometer.prometheusmetrics.PrometheusConfig introduced in Micrometer 1.13 (Spring Boot 3.3+). Drop the hard requirement on the io.prometheus.client.exporter.* classes: they are only exercised in Pushgateway mode and PrometheusMetricsReporterFactory already guards against their absence via NoClassDefFoundError handling, so requiring them here produced false negatives for scrape-only deployments that ship with dubbo-observability-spring-boot-starter in Dubbo 3.3.x. Add a MetricsSupportUtilTest that exercises each classpath layout (legacy only, new only, both, neither) by stubbing ClassUtils so the detection is verified regardless of which Prometheus registry is on the test runtime classpath. --- .../metrics/utils/MetricsSupportUtil.java | 38 +++++- .../metrics/utils/MetricsSupportUtilTest.java | 122 ++++++++++++++++++ 2 files changed, 156 insertions(+), 4 deletions(-) create mode 100644 dubbo-metrics/dubbo-metrics-api/src/test/java/org/apache/dubbo/metrics/utils/MetricsSupportUtilTest.java diff --git a/dubbo-metrics/dubbo-metrics-api/src/main/java/org/apache/dubbo/metrics/utils/MetricsSupportUtil.java b/dubbo-metrics/dubbo-metrics-api/src/main/java/org/apache/dubbo/metrics/utils/MetricsSupportUtil.java index b304197bb8b2..20f5bc13fcf6 100644 --- a/dubbo-metrics/dubbo-metrics-api/src/main/java/org/apache/dubbo/metrics/utils/MetricsSupportUtil.java +++ b/dubbo-metrics/dubbo-metrics-api/src/main/java/org/apache/dubbo/metrics/utils/MetricsSupportUtil.java @@ -20,15 +20,45 @@ public class MetricsSupportUtil { + /** + * Legacy Micrometer Prometheus config class, present in + * {@code micrometer-registry-prometheus-simpleclient} and in + * {@code micrometer-registry-prometheus} prior to Micrometer 1.13. + */ + private static final String LEGACY_PROMETHEUS_CONFIG_CLASS = "io.micrometer.prometheus.PrometheusConfig"; + + /** + * New Micrometer Prometheus config class, introduced in Micrometer 1.13 + * (Spring Boot 3.3+) when the {@code micrometer-registry-prometheus} + * artifact was re-homed under the {@code io.micrometer.prometheusmetrics} + * package. + */ + private static final String NEW_PROMETHEUS_CONFIG_CLASS = "io.micrometer.prometheusmetrics.PrometheusConfig"; + public static boolean isSupportMetrics() { return isClassPresent("io.micrometer.core.instrument.MeterRegistry"); } + /** + * Detect whether a Micrometer Prometheus registry is available on the + * classpath. Either the legacy {@code io.micrometer.prometheus} package + * (Micrometer < 1.13 and {@code micrometer-registry-prometheus-simpleclient}) + * or the new {@code io.micrometer.prometheusmetrics} package + * (Micrometer 1.13+, Spring Boot 3.3+) is accepted so that users on + * recent Spring Boot releases are not blocked from initializing the + * Prometheus reporter. + * + *

Previously this method also required the legacy PushGateway + * classes under {@code io.prometheus.client.exporter.*}. Those are only + * needed when Pushgateway mode is enabled, and {@code + * PrometheusMetricsReporterFactory} already guards against their + * absence via {@code NoClassDefFoundError} handling, so a hard + * requirement here produced false negatives for scrape-only + * deployments shipped with {@code dubbo-observability-spring-boot-starter} + * in Dubbo 3.3.x. + */ public static boolean isSupportPrometheus() { - return isClassPresent("io.micrometer.prometheus.PrometheusConfig") - && isClassPresent("io.prometheus.client.exporter.BasicAuthHttpConnectionFactory") - && isClassPresent("io.prometheus.client.exporter.HttpConnectionFactory") - && isClassPresent("io.prometheus.client.exporter.PushGateway"); + return isClassPresent(LEGACY_PROMETHEUS_CONFIG_CLASS) || isClassPresent(NEW_PROMETHEUS_CONFIG_CLASS); } private static boolean isClassPresent(String className) { diff --git a/dubbo-metrics/dubbo-metrics-api/src/test/java/org/apache/dubbo/metrics/utils/MetricsSupportUtilTest.java b/dubbo-metrics/dubbo-metrics-api/src/test/java/org/apache/dubbo/metrics/utils/MetricsSupportUtilTest.java new file mode 100644 index 000000000000..e2e2223b3e83 --- /dev/null +++ b/dubbo-metrics/dubbo-metrics-api/src/test/java/org/apache/dubbo/metrics/utils/MetricsSupportUtilTest.java @@ -0,0 +1,122 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 + * + * 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. + */ +package org.apache.dubbo.metrics.utils; + +import org.apache.dubbo.common.utils.ClassUtils; + +import org.junit.jupiter.api.Test; +import org.mockito.MockedStatic; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.mockStatic; + +class MetricsSupportUtilTest { + + private static final String LEGACY_PROMETHEUS_CONFIG = "io.micrometer.prometheus.PrometheusConfig"; + private static final String NEW_PROMETHEUS_CONFIG = "io.micrometer.prometheusmetrics.PrometheusConfig"; + private static final String METER_REGISTRY = "io.micrometer.core.instrument.MeterRegistry"; + + @Test + void isSupportMetricsResolvesOnRealClasspath() { + // micrometer-core is a compile-scope dep of dubbo-metrics-api, so the real + // classpath must report MeterRegistry as present. + assertTrue(MetricsSupportUtil.isSupportMetrics()); + } + + @Test + void isSupportPrometheusAcceptsLegacyMicrometerPackage() { + // Simulate Spring Boot <= 3.2 / Micrometer < 1.13, where only the old + // io.micrometer.prometheus.* package is on the classpath. + try (MockedStatic mocked = mockStatic(ClassUtils.class)) { + mocked.when(() -> ClassUtils.isPresent(eq(LEGACY_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(true); + mocked.when(() -> ClassUtils.isPresent(eq(NEW_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(false); + assertTrue(MetricsSupportUtil.isSupportPrometheus()); + } + } + + @Test + void isSupportPrometheusAcceptsNewMicrometerPackage() { + // Simulate Spring Boot 3.3+ / Micrometer 1.13+, where the package was + // renamed to io.micrometer.prometheusmetrics.*. This was the regression + // reported in apache/dubbo#16109. + try (MockedStatic mocked = mockStatic(ClassUtils.class)) { + mocked.when(() -> ClassUtils.isPresent(eq(LEGACY_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(false); + mocked.when(() -> ClassUtils.isPresent(eq(NEW_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(true); + assertTrue(MetricsSupportUtil.isSupportPrometheus()); + } + } + + @Test + void isSupportPrometheusAcceptsBothMicrometerPackages() { + // Simulate a transitional build where both the legacy and the new + // registries happen to be on the classpath. + try (MockedStatic mocked = mockStatic(ClassUtils.class)) { + mocked.when(() -> ClassUtils.isPresent(eq(LEGACY_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(true); + mocked.when(() -> ClassUtils.isPresent(eq(NEW_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(true); + assertTrue(MetricsSupportUtil.isSupportPrometheus()); + } + } + + @Test + void isSupportPrometheusReturnsFalseWhenNoMicrometerPrometheusOnClasspath() { + // Simulate an application that depends on dubbo-metrics-api without any + // Micrometer Prometheus registry. The check must return false so the + // reporter stays disabled rather than crashing later. + try (MockedStatic mocked = mockStatic(ClassUtils.class)) { + mocked.when(() -> ClassUtils.isPresent(eq(LEGACY_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(false); + mocked.when(() -> ClassUtils.isPresent(eq(NEW_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(false); + assertFalse(MetricsSupportUtil.isSupportPrometheus()); + } + } + + @Test + void isSupportPrometheusDoesNotRequireLegacyPushGatewayClasses() { + // Before apache/dubbo#16109 the check also required + // io.prometheus.client.exporter.* classes. Verify that their absence no + // longer suppresses Prometheus support when Micrometer is available. + try (MockedStatic mocked = mockStatic(ClassUtils.class)) { + mocked.when(() -> ClassUtils.isPresent(eq(NEW_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(true); + mocked.when(() -> ClassUtils.isPresent(eq(LEGACY_PROMETHEUS_CONFIG), any(ClassLoader.class))) + .thenReturn(false); + // Everything else (including io.prometheus.client.*) is still reported + // absent by default because we have not stubbed it. + assertTrue(MetricsSupportUtil.isSupportPrometheus()); + } + } + + @Test + void isSupportMetricsDelegatesToClassUtils() { + // Guard against a future refactor dropping the MeterRegistry probe. + try (MockedStatic mocked = mockStatic(ClassUtils.class)) { + mocked.when(() -> ClassUtils.isPresent(eq(METER_REGISTRY), any(ClassLoader.class))) + .thenReturn(false); + assertFalse(MetricsSupportUtil.isSupportMetrics()); + } + } +}