Prometheus与Micrometer：解决度量指标标签键冲突问题-java教程-PHP中文网

Prometheus与Micrometer：解决度量指标标签键冲突问题

本文旨在深入解析micrometer与prometheus集成时常见的“所有同名度量指标必须拥有相同的标签键集合”错误。我们将探讨该错误产生的根本原因，即多个组件或自定义切面为同一指标名注册了不同标签键集合的计时器。文章将提供多种解决方案，包括确保标签键一致性、使用不同指标名或精细控制切面应用范围，并强调高基数标签（如uri）的潜在危害及规避方法。

理解Prometheus度量模型与标签键一致性

在使用Micrometer结合Prometheus进行应用监控时，一个核心原则是：Prometheus要求所有具有相同名称的度量指标必须拥有相同的标签键集合。 这意味着，对于任何给定的度量指标名称（例如 http_requests_total），无论其标签值如何变化，其关联的标签键（例如 method, path, status）必须是固定不变的。

为什么会有这个限制？ Prometheus将一个度量指标的名称与它的一组标签键视为一个唯一的“时间序列”定义。当Prometheus抓取数据时，它期望这些时间序列的结构是稳定的。如果同一个指标名在不同的注册点拥有不同的标签键集合，Prometheus将无法正确地将其识别为同一个逻辑度量，从而导致数据模型混乱，并可能引发 IllegalArgumentException。

例如，如果您注册了一个名为 my_timer 的计时器，带有标签 [tagA, tagB]，然后又尝试注册一个名为 my_timer 的计时器，带有标签 [tagA, tagC]，Prometheus就会抛出上述异常，因为它认为这两个 my_timer 具有不同的结构。

案例分析：自定义AOP切面中的标签键冲突

在提供的案例中，用户遇到了以下错误信息： 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]。
现在有另一个代码路径尝试注册同名计时器，但带有的标签键是 [exception, method, outcome, status, uri]。

根本原因分析： 在Spring Boot应用中，当您自定义一个AOP切面来处理 @Timed 注解时，很可能与Spring Boot默认提供的 TimedAspect 产生冲突。

用户自定义的 TargetedTimedAspect： 根据提供的代码，该切面在构建 Timer.Builder 时，默认会添加 tagsBasedOnJoinPoint.apply(pjp)，这通常会包含 class 和 method 标签。此外，它还会添加 EXCEPTION_TAG (exception)。因此，它注册的计时器通常包含 [class, exception, method] 等标签。对于 StreamListener 和 Scheduled 方法，还会额外添加 BINDING_TAG 或 SCHEDULED_CRON_TAG。
Spring Boot默认的 TimedAspect (或其它框架/自定义切面)： 对于HTTP请求等场景，Spring Boot默认的 TimedAspect 会自动为 @Timed 注解的方法生成度量指标，并添加与HTTP请求相关的标签，例如 outcome (成功/失败), status (HTTP状态码), uri (请求URI) 等。这些标签与用户自定义切面中的标签集合不同。

当一个方法（例如 webPhotosGottenList()）同时满足两个切面的条件（例如，它是一个带有 @Timed 注解的Web控制器方法），并且两个切面都尝试为它注册一个名为 web_photos_gotten_list_seconds 的计时器时，就会发生标签键集合不一致的冲突。

Pointcut的作用： 用户在问题中提到，通过修改 Pointcut，问题得到了解决。这并非偶然。最初的 @Around("timedAnnotatedPointcut()") 会使得自定义切面应用于所有带有 @Timed 注解的方法。如果其中一些方法也是Web请求处理器，那么它们就会被Spring Boot的默认切面和用户自定义切面同时处理。

修改后的 Pointcut： @Around("timedAnnotatedPointcut() && (asyncAnnotatedPointcut() || allowedMethodPointcut())") 这个修改限制了自定义切面的应用范围，使其仅作用于那些带有 @Timed 且同时是 @StreamListener、@Scheduled 或特定服务方法的方法。如果 webPhotosGottenList() 方法不属于这些类别，那么用户自定义的切面将不再对其生效，从而避免了与Spring Boot默认切面为该方法注册的计时器发生标签键冲突。

解决方案

解决此类标签键冲突问题有以下几种策略：

1. 确保所有注册点的标签键集合一致

这是最根本的解决方案。对于同一个度量指标名称，必须确保所有尝试注册它的代码路径都使用完全相同的标签键集合。

统一标签定义： 审查所有可能注册 web_photos_gotten_list_seconds 的代码。如果某些标签并非总是适用，可以为它们设置一个默认值（例如 "none" 或 "N/A"），而不是完全省略这些标签。

示例： 如果一个计时器有时需要 outcome 和 status 标签，而有时不需要，那么在不需要的场景下，也必须添加这些标签，并赋予一个默认值。

// 确保所有注册点都有相同的标签键
Timer.Builder timerBuilder = Timer.builder(metricName)
    .tags(EXCEPTION_TAG, exceptionClass)
    .tags(tagsBasedOnJoinPoint.apply(pjp)); // 包含 class, method

// 假设 outcome, status, uri 也是需要统一的标签
// 如果当前上下文没有这些值，也要添加默认值
timerBuilder.tag("outcome", "unknown");
timerBuilder.tag("status", "unknown");
timerBuilder.tag("uri", "unknown"); // 注意：URI标签应谨慎使用，见下方最佳实践

if (streamListener != null) {
    timerBuilder.tags(BINDING_TAG, streamListener.value().isEmpty() ? streamListener.target() : streamListener.value());
    timerBuilder.tag(SCHEDULED_CRON_TAG, "none"); // 确保cron标签也存在
} else if (scheduled != null) {
    timerBuilder.tags(SCHEDULED_CRON_TAG, scheduled.cron());
    timerBuilder.tag(BINDING_TAG, "none"); // 确保binding标签也存在
} else {
    timerBuilder.tag(BINDING_TAG, "none");
    timerBuilder.tag(SCHEDULED_CRON_TAG, "none");
}

sample.stop(timerBuilder.register(registry));

登录后复制

这种方法可能导致度量指标的标签数量增多，但能保证一致性。

神卷标书

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

查看详情

2. 为不同的逻辑度量使用不同的指标名称

如果两个具有相同名称但不同标签集合的度量指标实际上代表了不同的业务或技术含义，那么它们就不应该共享同一个名称。

区分命名： 例如，如果 web_photos_gotten_list_seconds 既用于Web请求又用于内部异步任务，可以将其命名为 web_photos_gotten_list_http_seconds 和 web_photos_gotten_list_async_seconds。这样，即使它们有不同的标签集合，也不会冲突。

3. 精细控制AOP切面的应用范围或禁用冲突的注册

如果冲突是由多个AOP切面（例如自定义切面与Spring Boot默认切面）同时作用于同一方法引起的，可以通过调整切面配置来解决。

限制自定义切面范围： 如案例所示，通过更精确的 Pointcut 表达式，确保自定义切面只应用于您希望它处理的方法，避免与Spring Boot或其他框架的默认切面重叠。

// 示例：仅对特定服务层方法或特定注解方法应用自定义切面
@Around("timedAnnotatedPointcut() && (asyncAnnotatedPointcut() || allowedMethodPointcut())")
public Object timedMethod(ProceedingJoinPoint pjp) throws Throwable {
    // ... 自定义计时逻辑
}

登录后复制

禁用默认切面： 如果您的自定义切面已经提供了所有必要的度量功能，并且与Spring Boot的默认 TimedAspect 冲突，您可以考虑禁用默认的自动配置。例如，对于Web请求计时，可以通过配置属性禁用。

4. 调试查找冲突源

当不确定是哪个代码路径注册了冲突的度量指标时，可以使用调试工具：

设置条件断点： 在 io.micrometer.core.instrument.MeterRegistry 的 register() 方法上设置一个条件断点，条件是 meter.getId().getName().equals("web_photos_gotten_list_seconds")。当程序执行到这里时，您可以检查调用栈，找出是哪个组件或代码行尝试注册该度量指标。

最佳实践与注意事项

高基数标签的危害： 错误信息中出现的 uri 标签是一个需要特别注意的问题。URI通常具有非常高的基数（即可能的值非常多）。将高基数标签添加到Prometheus度量指标会导致：
- 内存消耗： Prometheus服务器需要为每个唯一的标签组合存储一个时间序列，高基数标签会迅速耗尽服务器内存。
- 查询性能： 大量时间序列会严重影响查询性能。
- 数据膨胀： 导致存储数据量剧增。
- 解决方案： 避免直接使用完整的URI作为标签。可以考虑：
  - URI模板化： 将动态部分替换为占位符（例如 /users/{id} 变为 /users/{id}）。
  - 固定路径段： 只使用URI的第一个或前几个路径段。
  - 使用 MeterFilter： 在Micrometer层面过滤或修改高基数标签。
默认行为与自定义： 在Spring Boot环境中，理解框架的默认度量行为至关重要。当您引入自定义度量逻辑时，要清楚它是否会与默认行为重叠或冲突。
清晰的命名约定： 为您的度量指标制定清晰的命名约定，使其能够区分不同类型或来源的度量。

总结

Prometheus对标签键一致性的要求是其数据模型的基础。当遇到“同名度量指标必须拥有相同的标签键集合”错误时，核心任务是识别并解决不同代码路径为同一指标名注册了不同标签键集合的问题。通过确保标签键一致性、使用不同的指标名称、精细化AOP切面范围或禁用冲突的度量注册，可以有效地解决这类问题。同时，务必警惕高基数标签带来的性能隐患，并采取适当的策略进行规避。

以上就是Prometheus与Micrometer：解决度量指标标签键冲突问题的详细内容，更多请关注php中文网其它相关文章！