JAVA Micrometer 指标不全面？自定义 meter registry 的正确方式 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

Micrometer 指标不全面？自定义 Meter Registry 的正确方式

大家好！今天我们来聊聊 Micrometer，一个强大的指标收集和监控工具。在使用 Micrometer 的过程中，你可能会遇到这样的问题：提供的默认指标不够用，或者需要以特定的方式来收集和处理指标。那么，如何解决这些问题，并正确地自定义 Meter Registry 呢？这就是我们今天的主题。

Micrometer 简介与默认指标的局限性

Micrometer 作为一个指标收集的 facade，简化了将应用程序指标导出到各种监控系统（如 Prometheus, Graphite, Datadog 等）的过程。它提供了一套统一的 API，让开发者能够以标准化的方式收集指标，而无需关心底层监控系统的具体实现。

Micrometer 提供了许多默认的指标，涵盖了 JVM 内存使用情况、CPU 使用情况、线程池状态、HTTP 请求响应时间等等。这些指标对于监控应用程序的整体健康状况非常有帮助。

然而，默认指标通常只能提供一个通用的视角，它们可能无法满足所有应用程序的特定需求。例如：

业务逻辑相关的指标： 默认指标无法追踪与特定业务逻辑相关的指标，例如用户注册数量、订单成功率、特定 API 的调用次数等等。
自定义标签： 默认指标的标签可能不够精细，无法根据应用程序的特定属性（例如用户 ID、产品类型、地理位置等）进行筛选和分析。
特定监控系统的需求： 不同的监控系统可能需要不同的指标格式或命名规范，默认指标可能无法直接满足这些需求。
数据聚合和转换： 有时候，原始数据需要经过一定的聚合和转换才能成为有意义的指标。默认指标可能无法提供这种灵活性。

因此，我们需要了解如何自定义 Meter Registry，以便收集更全面、更精细的指标，并满足特定监控系统的需求。

自定义 Meter Registry 的步骤与方法

自定义 Meter Registry 主要涉及到以下几个方面：

选择合适的 Meter Registry 实现： Micrometer 提供了多种 Meter Registry 实现，对应于不同的监控系统。你需要根据你的实际需求选择合适的实现。
配置 Meter Registry： 不同的 Meter Registry 实现有不同的配置选项，你需要根据你的需求进行配置。例如，设置监控系统的连接地址、认证信息、指标导出频率等等。
创建和注册 Meter： 使用 Meter Registry 创建各种类型的 Meter（例如 Counter, Gauge, Timer, DistributionSummary, LongTaskTimer），并将其注册到 Meter Registry 中。
自定义 Meter 的标签： 为 Meter 添加自定义标签，以便更精细地筛选和分析指标。
使用 MeterFilter 修改指标： 使用 MeterFilter 修改指标的名称、标签、值等，以满足特定监控系统的需求。
自定义 MeterBinder： 创建自定义的 MeterBinder，将应用程序的特定指标绑定到 Meter Registry 中。

接下来，我们将详细介绍这些步骤和方法，并提供相应的代码示例。

1. 选择合适的 Meter Registry 实现

Micrometer 支持多种监控系统，每种监控系统都有对应的 Meter Registry 实现。以下是一些常用的 Meter Registry 实现：

监控系统	Meter Registry 实现
Prometheus	`PrometheusMeterRegistry`
Graphite	`GraphiteMeterRegistry`
Datadog	`DatadogMeterRegistry`
StatsD	`StatsDMeterRegistry`
InfluxDB	`InfluxMeterRegistry`
Azure Monitor	`AzureMonitorMeterRegistry`

选择合适的 Meter Registry 实现取决于你使用的监控系统。例如，如果你使用 Prometheus，那么你需要选择 PrometheusMeterRegistry。

2. 配置 Meter Registry

不同的 Meter Registry 实现有不同的配置选项。你可以通过编程方式或配置文件来配置 Meter Registry。以下是一些常用的配置选项：

uri： 监控系统的连接地址。
apiToken： 监控系统的 API 令牌。
step： 指标导出频率。
enabled： 是否启用 Meter Registry。
pushOnShutdown： 在应用程序关闭时是否推送指标。

以下是一个使用编程方式配置 PrometheusMeterRegistry 的示例：

import io.micrometer.core.instrument.Clock;
import io.micrometer.prometheus.PrometheusConfig;
import io.micrometer.prometheus.PrometheusMeterRegistry;
import io.prometheus.client.CollectorRegistry;

public class PrometheusConfigExample {

    public static void main(String[] args) {
        // 创建 PrometheusConfig 对象
        PrometheusConfig prometheusConfig = new PrometheusConfig() {
            @Override
            public String get(String key) {
                // 可以从配置文件或环境变量中读取配置
                if (key.equals("prometheus.scrape.enabled")) {
                    return "true";
                }
                return null;
            }
        };

        // 创建 CollectorRegistry 对象
        CollectorRegistry collectorRegistry = new CollectorRegistry();

        // 创建 PrometheusMeterRegistry 对象
        PrometheusMeterRegistry meterRegistry = new PrometheusMeterRegistry(
                prometheusConfig,
                collectorRegistry,
                Clock.SYSTEM
        );

        // ... 使用 meterRegistry 注册和收集指标
    }
}

以下是一个使用 Spring Boot 配置文件配置 PrometheusMeterRegistry 的示例：

management:
  metrics:
    export:
      prometheus:
        enabled: true
        descriptions: true
        step: 10s

3. 创建和注册 Meter

Micrometer 提供了多种类型的 Meter，用于收集不同类型的指标。以下是一些常用的 Meter 类型：

Counter： 用于记录事件发生的次数。
Gauge： 用于记录瞬时值。
Timer： 用于记录事件的持续时间。
DistributionSummary： 用于记录值的分布情况。
LongTaskTimer： 用于记录长时间运行的任务的持续时间。

以下是一些创建和注册 Meter 的示例：

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
import org.springframework.stereotype.Component;

import java.util.Random;
import java.util.concurrent.TimeUnit;

@Component
public class MyMetrics {

    private final MeterRegistry meterRegistry;

    public MyMetrics(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;

        // 创建和注册 Counter
        Counter userRegisteredCounter = meterRegistry.counter("user.registered");

        // 创建和注册 Gauge
        Gauge.builder("random.value", this::getRandomValue)
                .register(meterRegistry);

        // 创建和注册 Timer
        Timer apiCallTimer = meterRegistry.timer("api.call.duration", "api", "myApi");

        // 使用 Counter
        userRegisteredCounter.increment();

        // 使用 Timer
        apiCallTimer.record(() -> {
            try {
                TimeUnit.MILLISECONDS.sleep(new Random().nextInt(100));
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
            }
        });
    }

    private double getRandomValue() {
        return new Random().nextDouble();
    }
}

4. 自定义 Meter 的标签

标签（也称为维度）是与指标关联的键值对，用于更精细地筛选和分析指标。你可以为 Meter 添加自定义标签，以便根据应用程序的特定属性（例如用户 ID、产品类型、地理位置等）进行筛选和分析。

以下是一些为 Meter 添加自定义标签的示例：

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tags;
import org.springframework.stereotype.Component;

@Component
public class MyMetricsWithTags {

    private final MeterRegistry meterRegistry;

    public MyMetricsWithTags(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;

        // 创建和注册 Counter，并添加自定义标签
        Counter orderCreatedCounter = meterRegistry.counter(
                "order.created",
                Tags.of("productType", "electronics", "region", "US")
        );

        // 使用 Counter
        orderCreatedCounter.increment();

        // 使用更灵活的方式添加标签
        Counter orderCreatedCounter2 = meterRegistry.counter(
                "order.created",
                "productType", "clothing",
                "region", "EU"
        );
        orderCreatedCounter2.increment();
    }
}

5. 使用 MeterFilter 修改指标

MeterFilter 允许你在指标注册到 Meter Registry 之前修改指标的名称、标签、值等。这对于满足特定监控系统的需求非常有用。例如，你可以使用 MeterFilter 将指标名称转换为特定监控系统所需的格式，或者添加或修改指标的标签。

以下是一些使用 MeterFilter 的示例：

import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.config.MeterFilter;
import io.micrometer.core.instrument.config.MeterFilterReply;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MeterFilterConfig {

    @Bean
    public MeterFilter commonTags() {
        return MeterFilter.commonTags("application", "myApp");
    }

    @Bean
    public MeterFilter renameMetrics() {
        return new MeterFilter() {
            @Override
            public Meter.Id map(Meter.Id id) {
                String newName = id.getName().replace(".", "_");
                return id.withName(newName);
            }

            @Override
            public MeterFilterReply accept(Meter.Id id) {
                //只对特定的meter生效
                if (id.getName().startsWith("http.server.requests")) {
                     return MeterFilterReply.ACCEPT;
                }
                return MeterFilterReply.NEUTRAL;
            }
        };
    }
}

6. 自定义 MeterBinder

MeterBinder 允许你将应用程序的特定指标绑定到 Meter Registry 中。这对于收集与特定业务逻辑相关的指标非常有用。你可以创建一个自定义的 MeterBinder，将应用程序的特定数据转换为 Micrometer 的 Meter，并将其注册到 Meter Registry 中。

以下是一个自定义 MeterBinder 的示例：

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.binder.MeterBinder;
import org.springframework.stereotype.Component;

import java.util.Random;

@Component
public class MyCustomMetrics implements MeterBinder {

    private final Random random = new Random();

    @Override
    public void bindTo(MeterRegistry registry) {
        // 模拟一个自定义的指标：随机数
        registry.gauge("my.custom.random.value", random, Random::nextDouble);
    }
}

然后，将这个 MyCustomMetrics 注入到 Spring 容器中，它会自动将指标绑定到 MeterRegistry。

示例：监控数据库连接池

假设我们需要监控数据库连接池的状态，例如活跃连接数、空闲连接数、最大连接数等等。我们可以使用自定义 MeterBinder 来实现这个目标。

首先，创建一个 DataSourceMetrics 类，实现 MeterBinder 接口：

import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.binder.MeterBinder;
import org.springframework.stereotype.Component;

import javax.sql.DataSource;
import java.sql.SQLException;

@Component
public class DataSourceMetrics implements MeterBinder {

    private final DataSource dataSource;

    public DataSourceMetrics(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    @Override
    public void bindTo(MeterRegistry registry) {
        try {
            // 获取连接池信息
            org.apache.tomcat.jdbc.pool.DataSource tomcatDataSource = (org.apache.tomcat.jdbc.pool.DataSource) dataSource;

            // 注册活跃连接数 Gauge
            Gauge.builder("db.connections.active", tomcatDataSource, org.apache.tomcat.jdbc.pool.DataSource::getNumActive)
                    .description("The number of active connections")
                    .register(registry);

            // 注册空闲连接数 Gauge
            Gauge.builder("db.connections.idle", tomcatDataSource, org.apache.tomcat.jdbc.pool.DataSource::getNumIdle)
                    .description("The number of idle connections")
                    .register(registry);

            // 注册最大连接数 Gauge
            Gauge.builder("db.connections.max", tomcatDataSource, org.apache.tomcat.jdbc.pool.DataSource::getMaxActive)
                    .description("The maximum number of active connections")
                    .register(registry);

        } catch (Exception e) {
            // 处理异常
            System.err.println("Failed to bind DataSource metrics: " + e.getMessage());
        }
    }
}

在这个例子中，我们假设使用了 Tomcat JDBC 连接池。如果使用其他的连接池，你需要根据实际情况修改代码。

然后，将 DataSourceMetrics 注入到 Spring 容器中，它会自动将数据库连接池的指标绑定到 MeterRegistry。

最佳实践

选择合适的 Meter 类型： 根据要收集的指标类型选择合适的 Meter 类型。
添加有意义的标签： 为 Meter 添加有意义的标签，以便更精细地筛选和分析指标。
使用 MeterFilter 规范指标： 使用 MeterFilter 规范指标的名称、标签、值等，以满足特定监控系统的需求。
避免过度收集指标： 只收集真正需要的指标，避免过度收集指标导致性能问题。
测试自定义指标： 在生产环境中部署自定义指标之前，务必进行充分的测试，确保指标的准确性和可靠性。
考虑性能影响： 指标收集可能会对应用程序的性能产生影响，需要仔细评估和优化。特别是高频的指标收集，需要特别注意。
使用描述性名称： 为你的指标起一个具有描述性的名称，方便理解和维护。
保持一致性： 在整个应用程序中保持指标命名和标签的一致性。

收集更全面的指标，应对监控需求

今天我们深入探讨了 Micrometer 的自定义 Meter Registry。我们学习了如何选择合适的 Meter Registry 实现、配置 Meter Registry、创建和注册 Meter、自定义 Meter 的标签、使用 MeterFilter 修改指标以及创建自定义 MeterBinder。通过这些方法，我们可以收集更全面、更精细的指标，并满足特定监控系统的需求。请记住，合理地使用 Micrometer，能够帮助你更好地监控应用程序的健康状况，及时发现和解决问题，提升应用程序的可靠性和稳定性。