SpringBoot通过注解监测Controller接口的代码示例_Java

一、前言

在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);
}