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的简单使用

相关推荐
rzl025 分钟前
SpringBoot总结
spring boot·后端·firefox
月亮不月亮18 分钟前
月亮商场购物打折Java
java·eclipse
moxiaoran575321 分钟前
Springboot+MongoDB简单使用示例
spring boot·mongodb·spring
guozhetao28 分钟前
【ST表、倍增】P7167 [eJOI 2020] Fountain (Day1)
java·c++·python·算法·leetcode·深度优先·图论
技术思考者28 分钟前
基础很薄弱如何规划考研
java·经验分享·考研
●VON1 小时前
重生之我在暑假学习微服务第二天《MybatisPlus-下篇》
java·学习·微服务·架构·mybatis-plus
老华带你飞1 小时前
口腔助手|口腔挂号预约小程序|基于微信小程序的口腔门诊预约系统的设计与实现(源码+数据库+文档)
java·数据库·微信小程序·小程序·论文·毕设·口腔小程序
小鱼人爱编程1 小时前
Java基石--反射让你直捣黄龙
前端·spring boot·后端
hqxstudying1 小时前
J2EE模式---服务层模式
java·数据库·后端·spring·oracle·java-ee
GM_8281 小时前
【最新最完整】SpringAI-1.0.0开发MCP Server,搭建MCP Client 实战笔记(进阶+详细+完整代码)
java·后端·ai编程·springai·mcp