Spring Boot Actuator使用

说明:本文介绍Spring Boot Actuator的使用,关于Spring Boot Actuator介绍,下面这篇博客写得很好,珠玉在前,我就不多介绍了。

简单使用

项目里引入下面这个依赖

xml 复制代码
<!--Spring Boot Actuator依赖-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

增加以下配置,开放所有默认接口

yml 复制代码
management:
  endpoints:
    web:
      exposure:
        include: "*"

启动项目,浏览器输入:http://127.0.0.1:8081/actuator,可见以下接口信息

输入某个详细的接口名称,如:http://127.0.0.1:8081/actuator/health,查询详细的内容,如下:

配置文件中,添加配置,查看更详细的内容

yml 复制代码
management:
  # 开放所有接口
  endpoints:
    web:
      exposure:
        include: "*"
  # 单个接口设置
  endpoint:
    health:
      show-details: ALWAYS

如下:

手动自定义一个接口,如下:

java 复制代码
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;

@Component
@Endpoint(id = "my-actuator")
public class MyActuator {

    @ReadOperation
    public String hello() {
        return "Good Luck";
    }
}

其中@Endpoint(id = "my-actuator"),可以等同于@RequestMapping("/my-actuator"),浏览器敲:http://127.0.0.1:8081/actuator/,可见自定义的接口,如下:

浏览器输:http://127.0.0.1:8081/actuator/my-actuator,可见接口返回

使用场景

通过上面的简单使用,可以看到 Spring Boot Actuator与我们常写的接口是分别开的,有点像swagger。他可以有以下的使用场景:

  • 健康检查:默认的health就是用来扩展健康检查的,我们可以在代码里去扩展这个接口,来实现自己的健康检查操作;

  • 监控:可以写一些接口,接口内返回运行时系统内的一些指标,收集起来,观测运行时的情况;

  • 统计:如上,有些数据是"活"的,不存数据库或者日志里,服务停止,数据就消失了,这些数据就可以在接口里返回,用于统计;

  • 排查问题:有些数据可能是存在本地缓存,如某个Map中的,就可以写一个接口,返回该Map中的数据,用于排查问题;

  • ......

可以把Spring Boot Actuator当做玻璃窗,能观察到运行时系统的内部情况。当然,用常规的接口也能实现,但不方便,因为要考虑如何在鉴权框架中排出掉这些接口,以及如何对此类接口进行管理,这就不能像Spring Boot Actuator这样得心应手------Spring Boot Actuator可以通过配置文件来控制。

总结

本文介绍了Spring Boot Actuator的简单使用

相关推荐
Victor35612 小时前
Redis(50) Redis哨兵如何与客户端进行交互?
后端
程序员爱钓鱼12 小时前
Go语言实战案例-开发一个JSON格式校验工具
后端·google·go
零千叶12 小时前
【面试】AI大模型应用原理面试题
java·设计模式·面试
坐吃山猪17 小时前
SpringBoot01-配置文件
java·开发语言
我叫汪枫17 小时前
《Java餐厅的待客之道:BIO, NIO, AIO三种服务模式的进化》
java·开发语言·nio
yaoxtao17 小时前
java.nio.file.InvalidPathException异常
java·linux·ubuntu
M1A118 小时前
小红书重磅升级!公众号文章一键导入,深度内容轻松入驻
后端
Swift社区19 小时前
从 JDK 1.8 切换到 JDK 21 时遇到 NoProviderFoundException 该如何解决?
java·开发语言
0wioiw019 小时前
Go基础(④指针)
开发语言·后端·golang