如何通过Micrometer自定义业务指标并集成到Prometheus中？ 指标标签的设计应该遵循什么原则？

Question

如何通过Micrometer自定义业务指标并集成到Prometheus中？ 指标标签的设计应该遵循什么原则？

Answer 1

中午好🌞🌞🌞
本答案参考通义千问

要通过 Micrometer 自定义业务指标并将其集成到 Prometheus 中，你需要遵循一系列步骤，并且在设计指标标签时遵守一定的原则以确保监控系统的可读性和可扩展性。

---

一、如何通过 Micrometer 自定义业务指标并集成到 Prometheus 中？

1. 添加依赖

首先，在你的项目中添加 Micrometer 和 Prometheus 的依赖。例如，在 pom.xml 中添加如下内容：

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-core</artifactId>
    <version>1.10.5</version>
</dependency>

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
    <version>1.10.5</version>
</dependency>

注意： 确保版本与你使用的 Spring Boot 或其他框架兼容。

---

2. 配置 Micrometer 与 Prometheus 集成

在 application.yml 或 application.properties 中配置 Prometheus 的暴露端点：

management:
  endpoints:
    web:
      exposure:
        include: prometheus
  metrics:
    export:
      prometheus:
        enabled: true

或者如果你使用的是 Spring Boot 2.x+，可以使用如下配置：

spring:
  actuator:
    prometheus:
      enabled: true

---

3. 使用 Micrometer 创建自定义指标

你可以通过 MeterRegistry 来创建自定义的指标，比如计数器（Counter）、定时器（Timer）等。

示例：创建一个自定义计数器

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;

public class CustomMetrics {

    private final Counter requestCounter;

    public CustomMetrics(MeterRegistry registry) {
        this.requestCounter = Counter.builder("custom.requests", "Number of custom requests")
                .description("Total number of custom requests processed")
                .register(registry);
    }

    public void incrementRequest() {
        requestCounter.increment();
    }
}

示例：创建一个带有标签的指标

import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;

public class CustomMetricsWithTags {

    private final Gauge userCountGauge;

    public CustomMetricsWithTags(MeterRegistry registry) {
        this.userCountGauge = Gauge.builder("custom.users.active", () -> getUserCount())
                .description("Active users in the system")
                .tags("region", "us-east-1") // 可选标签
                .register(registry);
    }

    private int getUserCount() {
        return 100; // 模拟获取用户数量
    }
}

---

4. 启动应用并访问 Prometheus 端点

启动你的应用后，访问 /actuator/metrics/prometheus（或根据配置的路径）查看自定义指标是否被正确暴露。

例如：

http://localhost:8080/actuator/metrics/prometheus

---

5. 配置 Prometheus 抓取自定义指标

在 Prometheus 的配置文件 prometheus.yml 中添加如下内容：

scrape_configs:
  - job_name: 'your-application'
    static_configs:
      - targets: ['localhost:8080']

然后重启 Prometheus 即可开始抓取你的自定义指标。

---

二、指标标签的设计应该遵循什么原则？

在设计指标标签（Labels）时，应遵循以下原则以确保指标的可读性、可扩展性和高效性：

1. 标签应具有语义意义

• 标签应描述指标的维度信息，如 status, method, region, user_type 等。
• 示例： http_requests_total{status="200", method="GET"}

2. 避免使用高基数标签

• 高基数标签（如用户 ID、UUID）会导致指标数量爆炸，影响性能和存储。
• 建议： 对于唯一值，使用聚合方式（如统计请求总数，而不是记录每个请求）。

3. 标签应保持稳定

• 标签名称和值不应频繁变化，否则会增加 Prometheus 的存储负担。
• 示例： 不要使用 request_id 作为标签，而是用 request_type 或 endpoint。

4. 标签应有明确的命名规范

• 使用下划线分隔的命名方式，如 http_request_duration_seconds。
• 标签名应简洁、清晰，如 status, method, region。

5. 合理控制标签数量

• 每个指标的标签数量不宜过多，一般不超过 3~5 个。
• 过多的标签会降低查询效率并增加复杂度。

6. 标签应支持过滤和聚合

• 设计标签时要考虑其是否能用于过滤和聚合操作，如按地区、状态、方法进行统计。

---

三、总结

✅ 解决方案步骤（有序列表）

1. 添加 Micrometer 和 Prometheus 依赖，确保监控系统可用。
2. 配置 Micrometer 与 Prometheus 集成，使指标能够被 Prometheus 抓取。
3. 使用 MeterRegistry 创建自定义指标，包括计数器、定时器、仪表等。
4. 设计合理的指标标签，遵循命名规范、语义意义和低基数原则。
5. 配置 Prometheus 抓取自定义指标，确保数据被正确收集。
6. 验证并测试，确认指标已成功暴露并在 Prometheus 中可见。

---

🧠 代码示例（修改后的自定义指标类）

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;

public class UserMetrics {

    private final Counter userLoginCounter;

    public UserMetrics(MeterRegistry registry) {
        this.userLoginCounter = Counter.builder("user.login.count", "Number of user logins")
                .description("Total number of successful user logins")
                .tags("environment", "production") // 限定环境
                .register(registry);
    }

    public void incrementLogin() {
        userLoginCounter.increment();
    }
}

---

如需进一步优化或定制化指标，请根据具体业务场景调整标签和指标类型。