Spring Boot Actuator 监控功能的简介及禁用

Spring Boot Actuator: Production-ready Features

1. 添加依赖

复制代码
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

2. 端点

端点 描述 默认启用
health 应用健康状态
info 应用信息
metrics 应用度量指标
beans 显示所有Spring Beans
mappings 显示所有@RequestMapping路径
env 显示环境变量
shutdown 优雅关闭应用

2.1. 启用端点

默认情况下,除 之外的所有终结点都处于启用状态。若要配置终结点的启用,请使用其属性。以下示例启用终结点:

复制代码
management.endpoint.shutdown.enabled=true

如果您希望启用端点是选择加入而不是选择退出,请将属性设置为 ,并使用单个端点属性重新选择加入。以下示例启用端点并禁用所有其他端点:

复制代码
management.endpoints.enabled-by-default=false
management.endpoint.info.enabled=true

2.2. 公开端点

由于端点可能包含敏感信息,因此应仔细考虑何时公开它们。 下表显示了内置终结点的默认公开:

ID JMX Web
auditevents Yes No
beans Yes No
caches Yes No
conditions Yes No
configprops Yes No
env Yes No
flyway Yes No
health Yes Yes
heapdump N/A No
httptrace Yes No
info Yes Yes
integrationgraph Yes No
jolokia N/A No
logfile N/A No
loggers Yes No
liquibase Yes No
metrics Yes No
mappings Yes No
prometheus N/A No
scheduledtasks Yes No
sessions Yes No
shutdown Yes No
threaddump Yes No

若要更改公开的终结点,请使用以下特定于技术的 和 属性:include ``exclude

Property Default
management.endpoints.jmx.exposure.exclude
management.endpoints.jmx.exposure.include *
management.endpoints.web.exposure.exclude
management.endpoints.web.exposure.include info, health

例如,要通过 HTTP 公开除 env和endpoints 之外的所有内容

复制代码
management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans

*在 YAML 中具有特殊含义,因此如果要包含(或排除)所有端点,请务必添加引号,如以下示例所示:

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

2.3. 保护 HTTP 端点

如果您希望为 HTTP 端点配置自定义安全性,例如,仅允许具有特定角色的用户访问它们,Spring Boot 提供了一些可以与 Spring Security 结合使用的方便对象。

复制代码
@Configuration(proxyBeanMethods = false)
public class ActuatorSecurity extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.requestMatcher(EndpointRequest.toAnyEndpoint()).authorizeRequests((requests) ->
                requests.anyRequest().hasRole("ENDPOINT_ADMIN"));
        http.httpBasic();
    }

}

2.4. 配置端点

端点会自动缓存对不采用任何参数的读取作的响应。 若要配置端点缓存响应的时间量,请使用其属性。 以下示例将端点缓存的生存时间设置为 10 秒:

复制代码
management.endpoint.beans.cache.time-to-live=10s

3. 通过 HTTP 进行监控和管理

3.1. 自定义管理端点路径

复制代码
management.endpoints.web.base-path=/manage

3.2. 自定义管理服务器端口

复制代码
management.server.port=8081

3.4. 自定义管理服务器地址

以下示例不允许远程管理连接

复制代码
management.server.port=8081
management.server.address=127.0.0.1

3.5. 禁用 HTTP 端点

如果您不想通过 HTTP 公开端点,可以将管理端口设置为 ,如以下示例所示:-1

复制代码
management.server.port=-1

这也可以使用该属性来实现,如以下示例所示:management.endpoints.web.exposure.exclude

复制代码
management.endpoints.web.exposure.exclude=*

示例:

http://localhost:8080/actuator

1.默认情况

2.只开启

/actuator/beans 和 /actuator/mappings 这两个 api

复制代码
management:
  endpoints:
    web:
      exposure:
        include: beans,mappings

3.

3.只关闭

复制代码
# 开启所有的 api(但不包含 shutdown)
management.endpoints.web.exposure.include=*
# 关闭/actuator/beans 这个 api
management.endpoints.web.exposure.exclude=beans
复制代码
management:
  endpoints:
    web:
      exposure:
        include: '*'
        exclude: beans

4.禁用

复制代码
management:
  endpoints:
    web:
      exposure:
        exclude: '*'
复制代码
management:
  server:
    port: -1
相关推荐
摇滚侠12 分钟前
Spring Boot 3零基础教程,WEB 开发 国际化 Spring Boot + Thymeleaf 笔记45
spring boot·笔记·后端
你想考研啊19 分钟前
一、redis安装(单机)和使用
前端·数据库·redis
枫叶丹423 分钟前
【Qt开发】多元素类控件(三)-> QTreeWidget
开发语言·数据库·c++·qt
洲覆37 分钟前
Redis 驱动适配 Reactor 模式
开发语言·网络·数据库·redis
搬砖的工人43 分钟前
记录WinFrom 使用 Autoupdater.NET.Official 进行软件升级更新
java·前端·.net
努力进修1 小时前
【JavaEE初阶】 多线程编程核心:解锁线程创建、方法与状态的创新实践密码
android·java·java-ee
IDOlaoluo1 小时前
win64_11gR2_client.zip 怎么安装?Oracle 11g 客户端详细安装步骤
数据库·oracle
呆呆小金人1 小时前
SQL入门:别名使用完全指南
大数据·数据库·数据仓库·sql·数据库开发·etl·etl工程师
xiezhr1 小时前
见过哪些醍醐灌顶的Java代码:从"卧槽"到"原来如此"的顿悟
java·后端·设计模式
当战神遇到编程1 小时前
数组的定义与使用
java·idea