Prometheus指标标签键一致性要求与解决方案-java教程-PHP中文网

Prometheus指标标签键一致性要求与解决方案

prometheus通过micrometer收集指标时，严格要求同名指标必须拥有完全一致的标签键集合。本文将深入探讨这一规则背后的原理，分析因自定义aop切面与框架默认指标注册冲突导致此问题的原因，并提供包括统一标签、使用不同指标名称及禁用冲突注册在内的多种解决方案，同时强调高基数标签的潜在风险。

Prometheus与Micrometer的标签键一致性规则

在使用Micrometer集成Prometheus进行应用监控时，一个核心且严格的规则是：任何具有相同名称的指标（Meter）在注册时，必须包含完全一致的标签键集合。这意味着，如果一个名为 my_metric 的计时器（Timer）首先被注册时使用了 [tagA, tagB] 两个标签键，那么后续任何尝试注册同名 my_metric 的计时器，都必须且只能使用 [tagA, tagB] 这两个标签键。如果尝试注册 my_metric 时使用了 [tagA, tagC] 或 [tagA, tagB, tagD]，Micrometer将抛出 IllegalArgumentException，指出标签键集合不匹配。

这一规则的设立是为了确保监控数据的完整性、可预测性和查询效率。Prometheus在存储和查询指标时，将指标名称和标签键值对的组合视为一个唯一的时序数据序列。如果同名指标的标签键集合不一致，将导致数据模型混乱，查询结果不可靠，甚至可能引发性能问题。

问题根源分析：自定义AOP与框架默认指标的冲突

在Spring Boot等框架中，Micrometer通常会被自动配置，对常见的组件（如Web请求、数据库访问）进行默认的指标收集。同时，开发者也可能通过自定义AOP切面（如 TargetedTimedAspect）来为特定业务逻辑或方法添加自定义的计时器指标。当这两种机制不经意间为同一个操作生成了同名但标签键集合不同的指标时，就会触发上述的 IllegalArgumentException。

以提供的 TargetedTimedAspect 代码为例：

@Aspect
@NonNullApi
public class TargetedTimedAspect {

    public static final String DEFAULT_METRIC_NAME = "method.timed";
    public static final String EXCEPTION_TAG = "exception";

    private final MeterRegistry registry;
    private final Function<ProceedingJoinPoint, Iterable<Tag>> tagsBasedOnJoinPoint;

    public TargetedTimedAspect(MeterRegistry registry, Function<ProceedingJoinPoint, Iterable<Tag>> tagsBasedOnJoinPoint) {
        this.registry = registry;
        this.tagsBasedOnJoinPoint = tagsBasedOnJoinPoint;
    }

    @Around("timedAnnotatedPointcut() && (asyncAnnotatedPointcut() || allowedMethodPointcut())")
    public Object timedMethod(ProceedingJoinPoint pjp) throws Throwable {
        Method method = ((MethodSignature) pjp.getSignature()).getMethod();
        Timed timed = method.getAnnotation(Timed.class);
        // ... (获取或处理Timed注解)

        final String metricName = timed.value().isEmpty() ? DEFAULT_METRIC_NAME : timed.value();
        Timer.Sample sample = Timer.start(registry);
        String exceptionClass = "none";

        try {
            return pjp.proceed();
        } catch (Exception ex) {
            exceptionClass = ex.getClass().getSimpleName();
            throw ex;
        } finally {
            try {
                Timer.Builder timerBuilder = Timer.builder(metricName)
                    .description(timed.description().isEmpty() ? null : timed.description())
                    .tags(timed.extraTags())
                    .tags(EXCEPTION_TAG, exceptionClass)
                    .tags(tagsBasedOnJoinPoint.apply(pjp)) // 默认添加 class 和 method 标签
                    // ... (根据StreamListener或Scheduled注解添加额外标签)

                sample.stop(timerBuilder.register(registry));
            } catch (Exception e) {
                // ignoring on purpose
            }
        }
    }
    // ... (Pointcut定义)
}

登录后复制

在这个自定义切面中：

tagsBasedOnJoinPoint 函数默认会为每个计时器添加 class 和 method 标签。
EXCEPTION_TAG (exception) 标签也会被添加。
如果方法被 @StreamListener 或 @Scheduled 注解，还会额外添加 BINDING_TAG 或 SCHEDULED_CRON_TAG。因此，由这个切面注册的指标，其标签键集合可能包括 [class, exception, method]，或者在特定情况下包含更多标签。

然而，错误信息 java.lang.IllegalArgumentException: Prometheus requires that all meters with the same name have the same set of tag keys. There is already an existing meter named 'web_photos_gotten_list_seconds' containing tag keys [class, exception, method]. The meter you are attempting to register has keys [exception, method, outcome, status, uri]. 清晰地表明：

自定义切面注册了一个名为 web_photos_gotten_list_seconds 的指标，带有标签键 [class, exception, method]。
同时，另一个（很可能是Spring Boot Web模块的默认）指标注册源也尝试注册同名指标 web_photos_gotten_list_seconds，但它使用的标签键是 [exception, method, outcome, status, uri]。

由于这两个标签键集合不一致，Micrometer在注册第二个指标时抛出了异常。这与AOP的 Pointcut 定义本身无关，而是关于指标注册时标签键的匹配问题。

解决方案

解决此问题的核心在于确保对于任何给定的指标名称，其所有注册都使用相同的标签键集合。

1. 统一标签键集合

这是最直接的解决方案。您需要识别所有注册同名指标的来源，并确保它们在注册时都添加了完全相同的标签键。

修改自定义切面：如果框架默认注册的标签键是您希望保留的，那么修改您的 TargetedTimedAspect，使其在所有情况下都添加与框架默认注册一致的标签键。例如，如果 web_photos_gotten_list_seconds 应该包含 [exception, method, outcome, status, uri]，那么您的切面也需要添加 outcome, status, uri 等标签，并确保 class 标签不再出现（如果它不是通用标签）。这通常意味着您需要深入了解框架默认指标的标签生成逻辑。

神卷标书
神卷标书，专注于AI智能标书制作、管理与咨询服务，提供高效、专业的招投标解决方案。支持一站式标书生成、模板下载，助力企业轻松投标，提升中标率。

39

查看详情

示例调整 (假设目标标签为 [exception, method, outcome, status, uri])：

// 假设您想让自定义切面也生成 outcome, status, uri 标签
// 这可能需要您从 ProceedingJoinPoint 或其他上下文获取这些信息
// 例如，对于Web请求，outcome和status可能来自HTTP响应，uri来自请求
// 这意味着AOP切面需要更复杂的逻辑来模拟或获取这些标签

// 示例：如果无法直接获取，可能需要重新设计标签策略
// 例如，不再使用 class 标签，而是统一使用 outcome, status, uri
// private final Function<ProceedingJoinPoint, Iterable<Tag>> tagsBasedOnJoinPoint;
// 可以修改为：
// new TargetedTimedAspect(registry, pjp ->
//     Tags.of("method", pjp.getStaticPart().getSignature().getName()) // 移除 class
// );
// 然后在 timedMethod 中根据业务逻辑添加 outcome, status, uri
// 但这通常意味着您的自定义切面需要与Web请求的上下文紧密耦合。

登录后复制

2. 使用不同的指标名称

如果两个指标虽然监控的是相似的操作，但其标签集合确实代表了不同的维度或上下文，那么最简单的做法是为它们分配不同的名称。

修改自定义切面中的指标名称：在 Timed 注解中或 DEFAULT_METRIC_NAME 中使用一个更具描述性的名称，以区分它与框架默认的指标。
```
// 在 @Timed 注解中指定不同的名称
@Timed("custom.web.photos.gotten.list.seconds")
public List<Photo> getPhotosList() {
    // ...
}

// 或者修改切面中的默认名称
public static final String DEFAULT_METRIC_NAME = "custom.method.timed";
```
登录后复制
这样，您的自定义指标将与框架的默认指标并行存在，而不会发生标签冲突。

3. 识别并禁用冲突的注册

如果框架默认注册的指标与您的自定义指标存在功能重叠，并且您更倾向于使用自己的自定义指标，您可以尝试禁用框架的默认指标注册。

调试定位冲突源：
- 在 io.micrometer.core.instrument.MeterRegistry.register() 方法上设置条件断点。
- 条件设置为 meter.getId().getName().equals("web_photos_gotten_list_seconds")。
- 当断点触发时，检查调用栈，可以追溯到是哪个代码路径（是您的切面还是框架的某个自动配置）首次注册了该名称的指标。
- 然后，您可以根据定位到的来源，决定如何禁用它。
Spring Boot Web指标禁用示例：对于Spring Boot Web应用程序，通常可以通过配置属性来禁用默认的HTTP请求指标。例如：
```
management.metrics.web.server.auto-time-requests=false
```
登录后复制
这将禁用Spring Boot对所有Web请求的默认计时器指标注册。如果您希望对特定URI路径进行更细粒度的控制，可以配置 management.metrics.web.server.request.autotime.enabled 和 management.metrics.web.server.request.autotime.exclude 等属性。

注意事项：高基数标签的风险

在设计指标标签时，需要特别注意避免使用高基数（High Cardinality）标签，即那些可能包含大量唯一值的标签。例如，将完整的 URI 作为标签是一个常见的错误。

URI作为标签的危害：如果您的服务有许多不同的URI路径，或者URI中包含动态参数（如ID），那么每个独特的URI都将创建一个新的时序数据序列。这会导致Prometheus存储大量稀疏数据，显著增加内存和磁盘消耗，并降低查询性能。在极端情况下，高基数标签甚至可能导致Prometheus服务器崩溃。
推荐做法：
- URI模板化：将URI路径进行模板化处理，例如将 /users/123 和 /users/456 都映射为 /users/{id}，然后将模板化的URI作为标签。
- 分组：将相关的URI路径分组，使用一个更通用的标签值。
- 避免不必要的细节：只添加对分析和故障排除有实际帮助的标签。

总结

Prometheus与Micrometer的标签键一致性规则是确保监控系统健康运行的关键。当遇到 IllegalArgumentException: Prometheus requires that all meters with the same name have the same set of tag keys 错误时，应首先检查应用中所有注册同名指标的来源，分析其标签键集合。解决策略包括统一所有注册源的标签键、为不同维度的指标分配不同的名称，或禁用冲突的默认指标注册。同时，务必遵循标签设计的最佳实践，避免引入高基数标签，以维护监控系统的稳定性和性能。

以上就是Prometheus指标标签键一致性要求与解决方案的详细内容，更多请关注php中文网其它相关文章！