12. Spring Boot中的`Actuator`是什么？如何使用`actuator`进行应用监控？

PangHu大约 4 分钟

Spring Boot Actuator 是一个用于监控和管理 Spring Boot 应用程序的强大工具集。它提供了一组内置的端点（endpoints），可以用来监控应用的健康状况、审计、收集度量数据、查看应用的配置信息等。Actuator 通过这些端点可以帮助开发人员和运维人员更好地管理和维护 Spring Boot 应用程序。

`Actuator` 的主要功能

健康检查（Health Checks）：
- 提供应用程序的健康状况信息，可以集成到外部监控系统中。
度量（Metrics）：
- 收集应用程序运行时的各种度量数据，如内存使用、垃圾回收次数、HTTP 请求次数和响应时间等。
环境信息（Environment）：
- 提供当前应用的环境配置信息，包括系统属性、环境变量、配置文件属性等。
应用信息（Info）：
- 显示应用程序的基本信息，如版本、描述、构建信息等。
日志级别管理（Loggers）：
- 动态查看和修改应用程序中各个包或类的日志级别。
请求追踪（HTTP Trace）：
- 记录应用程序处理的最近的HTTP请求信息，帮助诊断和调试问题。
线程 Dump：
- 查看应用程序的当前线程状态，用于诊断性能问题。

如何使用 `Actuator` 进行应用监控？

1. 引入 `Actuator` 依赖

要使用 Spring Boot Actuator，需要在项目中引入 spring-boot-starter-actuator 依赖。

Maven：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

Gradle：

implementation 'org.springframework.boot:spring-boot-starter-actuator'

2. 配置 `Actuator`

默认情况下，Actuator 提供了一组基础的端点，可以通过 HTTP 访问。可以在 application.properties 或 application.yml 中配置 Actuator。

示例：application.properties 配置：

management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always
management.endpoint.metrics.enabled=true
management.endpoint.httptrace.enabled=true

management.endpoints.web.exposure.include=*：暴露所有的 Actuator 端点（默认只暴露部分端点）。
management.endpoint.health.show-details=always：显示健康检查的详细信息。
management.endpoint.metrics.enabled=true：启用 metrics 端点。
management.endpoint.httptrace.enabled=true：启用 httptrace 端点，用于追踪最近的 HTTP 请求。

示例：application.yml 配置：

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always
    metrics:
      enabled: true
    httptrace:
      enabled: true

3. 使用 Actuator 端点

Actuator 提供的端点可以通过 HTTP 请求访问，默认路径为 /actuator。一些常用的端点包括：

/actuator/health：显示应用程序的健康状况。
```
curl http://localhost:8080/actuator/health
```
返回类似以下的响应：
```
{
  "status": "UP"
}
```
/actuator/info：显示应用程序的基本信息，如版本号等。
```
curl http://localhost:8080/actuator/info
```
/actuator/metrics：显示应用的度量信息，如内存、CPU使用等。
```
curl http://localhost:8080/actuator/metrics
```
/actuator/metrics/{name}：显示特定度量的详细信息。
```
curl http://localhost:8080/actuator/metrics/jvm.memory.used
```

/actuator/loggers：显示和配置应用程序中日志记录器的当前日志级别。

curl http://localhost:8080/actuator/loggers

修改日志级别：

curl -X POST -H "Content-Type: application/json" -d '{"configuredLevel":"DEBUG"}' http://localhost:8080/actuator/loggers/com.example

/actuator/env：显示应用的环境属性信息。
```
curl http://localhost:8080/actuator/env
```
/actuator/httptrace：显示最近的 HTTP 请求信息。
```
curl http://localhost:8080/actuator/httptrace
```
/actuator/threaddump：显示当前的线程 Dump。
```
curl http://localhost:8080/actuator/threaddump
```

4. 安全性配置

在生产环境中，Actuator 端点可能会暴露敏感信息，因此需要确保这些端点的安全性。可以使用 Spring Security 对这些端点进行保护。

示例：配置端点安全性：

management.endpoints.web.exposure.include=health,info
management.endpoint.health.show-details=never

这将仅暴露 /actuator/health 和 /actuator/info 端点，并且不显示健康检查的详细信息。

5. 集成到外部监控系统

Actuator 提供的度量和健康检查信息可以集成到外部监控系统中，如 Prometheus、Grafana、New Relic 等，进一步增强应用的可观察性和可维护性。

示例：集成 Prometheus：

Spring Boot 提供了 micrometer 库来支持与 Prometheus 集成。只需引入相关依赖，并在 application.properties 中配置 Prometheus，即可将度量数据导出到 Prometheus。

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>
properties

management.metrics.export.prometheus.enabled=true

访问 /actuator/prometheus 来获取 Prometheus 格式的度量数据。

总结

Spring Boot Actuator 是一个功能强大的监控和管理工具，能够帮助开发者和运维人员实时监控应用的健康状况、性能指标和其他关键信息。通过简单的配置，Actuator 可以在开发和生产环境中为 Spring Boot 应用提供全面的可观测性。