Spring Boot与Micrometer结合实现指标采集与Grafana展示

Spring Boot + Micrometer + Grafana：构建可观测性系统

大家好，今天我们来聊聊如何利用 Spring Boot、Micrometer 和 Grafana 构建一个可观测性系统。可观测性是现代应用开发的关键，它让我们能够深入了解应用程序的运行状态，快速定位问题，并优化性能。在这个讲座中，我们将深入探讨这三个组件，并通过实际代码示例演示如何将它们整合在一起。

一、可观测性简介：为什么需要它？

在传统的监控体系中，我们往往关注的是几个关键指标，比如 CPU 利用率、内存使用率、磁盘 I/O 等等。这种监控方式对于简单的应用来说可能够用，但对于复杂的分布式系统来说就显得力不从心了。可观测性则更进一步，它不仅仅关注指标，还关注日志和链路追踪。通过分析这三者之间的关联，我们可以更好地理解系统的行为，更快地诊断问题。

• 指标 (Metrics): 数值型的度量，例如请求响应时间、错误率、CPU 使用率等。指标通常以时间序列的形式存储。
• 日志 (Logs): 应用程序产生的文本记录，包含事件发生的时间、内容、上下文等信息。
• 链路追踪 (Tracing): 记录请求在不同服务之间的调用链，帮助我们了解请求的完整路径，定位性能瓶颈。

可观测性的好处包括：

• 快速定位问题： 通过指标、日志和链路追踪的关联分析，可以快速找到问题的根源。
• 提高系统稳定性： 及时发现潜在问题，避免故障发生。
• 优化性能： 通过分析性能瓶颈，可以有针对性地进行优化。
• 更好地理解系统行为： 可以更深入地了解系统的运行状态，为容量规划和架构优化提供依据。

二、Micrometer：Java 应用的指标收集门面

Micrometer 是一个 Java 应用的指标收集门面 (Metrics Facade)。它提供了一组通用的 API，可以用来收集各种指标，然后将这些指标导出到不同的监控系统，比如 Prometheus、InfluxDB、Datadog 等。

Micrometer 的主要特点包括：

• 与厂商无关： Micrometer 提供了一组通用的 API，应用程序不需要关心底层使用的监控系统。
• 支持多种监控系统： Micrometer 支持多种流行的监控系统，可以灵活地选择合适的监控方案。
• 自动指标收集： Micrometer 可以自动收集 JVM 相关的指标，比如内存使用情况、GC 信息等。
• 自定义指标收集： Micrometer 允许开发者自定义指标，满足特定的监控需求。

三、Spring Boot 集成 Micrometer

Spring Boot 对 Micrometer 提供了良好的支持，只需要添加相应的依赖，就可以轻松地集成 Micrometer。

1. 添加依赖

在 pom.xml 文件中添加 Micrometer 和 Prometheus 的依赖：

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

2. 配置 Prometheus 端点

在 application.properties 或 application.yml 文件中启用 Prometheus 端点：

management.endpoints.web.exposure.include=prometheus
management.metrics.export.prometheus.enabled=true

或者，使用 YAML 格式：

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

3. 验证集成

启动 Spring Boot 应用，访问 /actuator/prometheus 端点，应该可以看到 Prometheus 格式的指标数据。

四、自定义指标收集

除了自动收集的指标，我们还可以自定义指标，以满足特定的监控需求。

1. 使用 MeterRegistry 注入

在 Spring Bean 中注入 MeterRegistry 对象：

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

@Service
public class MyService {

    private final Counter myCounter;

    public MyService(MeterRegistry meterRegistry) {
        this.myCounter = Counter.builder("my_custom_counter")
                .description("A custom counter for my service")
                .register(meterRegistry);
    }

    public void doSomething() {
        myCounter.increment();
        // ... 其他业务逻辑
    }
}

在这个例子中，我们创建了一个名为 my_custom_counter 的计数器，并在 doSomething 方法中增加计数器的值。

2. 使用 @Timed 注解

可以使用 @Timed 注解来测量方法的执行时间：

import io.micrometer.core.annotation.Timed;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Timed(value = "my_method_duration", description = "Duration of my method")
    public void myMethod() {
        // ... 业务逻辑
    }
}

这个注解会自动记录 myMethod 方法的执行时间，并将其暴露为 my_method_duration_seconds 指标。

3. 使用 Timer 对象

可以使用 Timer 对象来更灵活地测量代码块的执行时间：

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
import org.springframework.stereotype.Service;

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

@Service
public class MyService {

    private final Timer myTimer;

    public MyService(MeterRegistry meterRegistry) {
        this.myTimer = Timer.builder("my_process_duration")
                .description("Duration of my process")
                .register(meterRegistry);
    }

    public void myProcess() {
        myTimer.record(() -> {
            // ... 耗时操作
            try {
                TimeUnit.MILLISECONDS.sleep(new Random().nextInt(100));
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
            }
        });
    }
}

这个例子中，我们使用 Timer.record 方法来测量 myProcess 方法中耗时操作的执行时间。

五、Prometheus：时序数据库

Prometheus 是一个开源的时序数据库，专门用于存储和查询指标数据。它采用拉取 (Pull) 模式，定期从目标应用拉取指标数据。

1. 安装 Prometheus

可以从 Prometheus 官网下载安装包，或者使用 Docker 镜像。

2. 配置 Prometheus

Prometheus 的配置文件是 prometheus.yml。需要配置 Prometheus 从 Spring Boot 应用拉取指标数据：

scrape_configs:
  - job_name: 'spring-boot'
    metrics_path: '/actuator/prometheus'
    scrape_interval: 5s
    static_configs:
      - targets: ['localhost:8080'] # 修改为 Spring Boot 应用的地址

在这个配置中，我们定义了一个名为 spring-boot 的 Job，它会每 5 秒从 localhost:8080/actuator/prometheus 拉取指标数据。

3. 启动 Prometheus

启动 Prometheus，访问 Prometheus 的 Web UI (通常是 http://localhost:9090)，就可以查询指标数据了。

六、Grafana：数据可视化

Grafana 是一个开源的数据可视化工具，可以连接到多种数据源，比如 Prometheus、InfluxDB、Elasticsearch 等，然后将数据以图表的形式展示出来。

1. 安装 Grafana

可以从 Grafana 官网下载安装包，或者使用 Docker 镜像。

2. 添加数据源

在 Grafana 中添加 Prometheus 数据源，配置 Prometheus 的地址。

3. 创建 Dashboard

创建 Grafana Dashboard，添加 Panel，选择要展示的指标，配置图表类型、颜色、标题等。

例如，可以创建一个 Panel 来展示 my_custom_counter 指标：

• Panel Title: My Custom Counter
• Query: my_custom_counter_total (Prometheus 中计数器指标通常以 _total 结尾)
• Visualization: Graph

可以创建一个 Panel 来展示 my_method_duration 指标：

• Panel Title: My Method Duration
• Query: my_method_duration_seconds_sum (展示总时长) 或者 rate(my_method_duration_seconds_count[5m]) (展示每分钟调用次数)
• Visualization: Graph

七、示例代码：完整的 Spring Boot 应用

下面是一个完整的 Spring Boot 应用示例，演示了如何集成 Micrometer 和 Prometheus，并自定义指标。

package com.example.demo;

import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

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

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

@RestController
class MyController {

    private final MyService myService;

    public MyController(MyService myService) {
        this.myService = myService;
    }

    @GetMapping("/")
    public String hello() {
        myService.doSomething();
        myService.myMethod();
        myService.myProcess();
        return "Hello, World!";
    }
}

@org.springframework.stereotype.Service
class MyService {

    private final Counter myCounter;
    private final Timer myTimer;

    public MyService(MeterRegistry meterRegistry) {
        this.myCounter = Counter.builder("my_custom_counter")
                .description("A custom counter for my service")
                .register(meterRegistry);
        this.myTimer = Timer.builder("my_process_duration")
                .description("Duration of my process")
                .register(meterRegistry);
    }

    public void doSomething() {
        myCounter.increment();
    }

    @Timed(value = "my_method_duration", description = "Duration of my method")
    public void myMethod() {
        // 模拟耗时操作
        try {
            TimeUnit.MILLISECONDS.sleep(new Random().nextInt(50));
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
        }
    }

    public void myProcess() {
        myTimer.record(() -> {
            // 模拟耗时操作
            try {
                TimeUnit.MILLISECONDS.sleep(new Random().nextInt(100));
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
            }
        });
    }
}

八、最佳实践

• 选择合适的指标： 选择能够反映系统关键性能的指标。
• 使用有意义的指标名称和标签： 方便查询和分析。
• 设置合理的报警阈值： 及时发现问题。
• 定期审查和优化指标： 确保指标的有效性和准确性。
• 将指标、日志和链路追踪结合起来分析： 更全面地了解系统行为。

九、表格：指标类型选择

指标类型	描述	示例
Counter	计数器，只能增加，不能减少。	请求总数、错误总数
Gauge	瞬时值，可以增加和减少。	CPU 使用率、内存使用量、队列长度
Timer	测量事件的持续时间，例如方法的执行时间、请求的响应时间。	方法执行时间、API 响应时间
Summary	测量事件的大小分布情况，例如请求的大小、响应的大小。	请求大小、响应大小
LongTaskTimer	测量持续时间长的任务，比如长时间运行的后台任务。	后台任务执行时间

十、总结：构建可观测性系统，提高应用稳定性

通过 Spring Boot 集成 Micrometer，我们可以轻松地收集各种指标，然后使用 Prometheus 存储指标数据，最后使用 Grafana 将数据可视化。结合日志和链路追踪，我们可以构建一个完善的可观测性系统，从而提高应用程序的稳定性和可靠性。掌握这些技术对于现代应用开发至关重要。