Actuator 使用手册

Spring Actuator 是 Spring Boot 提供的一个强大的监控和管理工具，它通过一系列内置的 HTTP 端点，帮助开发者实时监控应用程序的运行状态、性能指标以及环境配置。Actuator 提供了丰富的功能，包括查看 Bean 信息、管理缓存、检查健康状态、动态调整日志级别等，简化了应用程序的运维工作。

Actuator 可以满足一些简单问题的快速定位，以此文作为命令备查表，便于需要时对照使用。

Beans

Spring Actuator 提供了 /actuator/beans 端点，用于查看应用程序中所有的 Spring Beans。通过该端点，您可以获取每个 Bean 的详细信息，包括其类型、依赖关系以及作用域。

列出全部 bean

$ curl -X GET http://127.0.0.1:8081/actuator/beans

beans 端点不支持检索，可以通过以下方式代替检索

$ apk update && apk add jq

$ curl -X GET http://127.0.0.1:8081/actuator/beans | jq | grep {bean.name}

Caches

/actuator/caches 端点允许您查看和管理应用程序中的缓存。您可以列出所有缓存，并清除特定的缓存。

列出所有缓存

$ curl -X GET http://127.0.0.1:8081/actuator/caches

按名称查找缓存,{name} 对应 @Cacheable(value="name"), 当缓存未触发时返回空。

$ curl -X GET http://127.0.0.1:8081/actuator/caches/{name}

{"cacheManager":"cacheManager","target":"org.springframework.data.redis.cache.DefaultRedisCacheWriter","name":"{name}"}

删除全部缓存

$ curl -i -X DELETE 'http://127.0.0.1:8081/actuator/caches'

按名称删除缓存

$ curl -i -X DELETE 'http://127.0.0.1:8081/actuator/caches/{name}'

Env

/actuator/env 端点提供了应用程序的环境属性信息，包括系统属性、环境变量以及配置文件中的属性。

列出全部环境信息

$ curl -X GET http://127.0.0.1:8081/actuator/env

按精确属性名称，查找属性值

$ curl -X GET http://127.0.0.1:8081/actuator/env/{property.name}

Info

/actuator/info 端点提供了应用程序的通用信息，通常包括版本号、构建时间等。您可以通过配置文件或代码自定义这些信息。

$ curl -X GET http://127.0.0.1:8081/actuator/info

Loggers

/actuator/loggers 端点允许您动态调整应用程序的日志级别。可以查看当前日志配置，并修改特定 Logger 的日志级别。

列出全部日志配置

$ curl -i -X GET 'http://127.0.0.1:8081/actuator/loggers'

查找指定日志配置，{logger.name}任意层级的包路径结构，例如：team.aikero

$ curl -i -X GET 'http://127.0.0.1:8081/actuator/{logger.name}'

更改指定{logger.name}日志级别

$ curl -X POST http://127.0.0.1:8081/actuator/loggers/{logger.name} -H "Content-Type: application/json" -d '{"configuredLevel": "DEBUG"}'

清理指定{logger.name}日志级别

$ curl -X POST http://127.0.0.1:8081/actuator/loggers/{logger.name} -H "Content-Type: application/json" -d '{}'

结语

本篇主要介绍 actuator 的常用端点，能够简单快速查看程序运行信息，路由映射、测量等信息，可以通过以下方式进行了解：

• 官方文档
• 联系 @李子凡 共同探讨