SpringBoot：SpringBoot通过注解监测Controller接口

news2024/12/28 20:24:32

一、前言

在Spring Boot中，度量指标（Metrics）是监控和诊断应用性能与行为的重要工具。Spring Boot通过集成Micrometer和Spring Boot Actuator，提供了强大的度量指标收集与暴露功能。

二、度量指标

1. Micrometer

Micrometer是一个应用监控门面（Facade），它提供了对多种监控系统的支持，使得开发者可以在不修改代码的情况下切换监控后端，如Prometheus、Graphite、InfluxDB等。

Micrometer的核心功能

丰富的指标收集：

系统指标：如CPU使用率、内存占用、磁盘I/O、网络I/O等，这些基础资源的使用情况对于理解系统性能至关重要。

应用指标：包括请求响应时间、吞吐量、错误率等，这些指标直接反映了应用的行为和性能。

自定义指标：开发者可以根据需要创建自定义指标，以监控特定的业务流程或组件。

请求跟踪：

虽然Micrometer本身主要关注于指标收集，但它可以与Spring Cloud Sleuth等跟踪系统结合使用，实现请求的分布式跟踪。Sleuth通过添加跟踪信息（如Trace ID、Span ID）到日志和指标中，帮助开发者追踪请求在整个微服务架构中的路径，从而更容易地诊断问题。

集成日志记录：

虽然Micrometer不直接处理日志记录，但将Micrometer的监控数据与日志系统集成，可以形成更全面的可观测性体系。例如，可以将Micrometer收集的指标与日志文件中的Trace ID关联起来，从而更容易地将性能问题与具体的请求或事务联系起来。

2. Spring Boot Actuator

Spring Boot Actuator是Spring Boot的一个子项目，它提供了对应用系统的自省和监控的集成功能。通过引入Spring Boot Actuator，应用可以暴露多个端点（Endpoints），这些端点提供了对应用内部信息的访问，包括度量指标、健康检查、环境变量等。

三、使用@Timed, @Counted注解来完成接口的监测功能

@Timed注解
该注解会统计方法调用的执行耗时情况，包括什么类，哪个方法等信息。

@Counted注解
统计方法调用成功与失败情况。

四、代码示例

1. 引入依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

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

2. 开启配置

management.endpoints.web.base-path=/v/ac
management.endpoints.web.exposure.include=*

3. 测试代码

@Timed(value = "test_actuator", description = "test_actuator", histogram = true)
@RequestMapping("/test/actuator")
public void testActuator(String name){
	// 相关业务
	System.out.println("success: " + name);
}

模拟一下，接口失败的情况

@Counted(value = "test_actuator_1")
@RequestMapping("/test/actuator1")
public Long testActuator1(Long id) {
	if (id % 2 == 0) {
		throw new RuntimeException("参数错误") ;
	}
	return id ;
}