【Springboot知识】Springboot进阶-Actuator深入理解

原创已于 2024-12-30 09:31:28 修改 · 4.1k 阅读

32 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #后端 #java #actuator

于 2024-12-26 11:30:00 首次发布

微服务相关技术同时被 2 个专栏收录

60 篇文章

订阅专栏

后端开发实践

15 篇文章

订阅专栏

spring boot actuator详细介绍

概述

Spring Boot Actuator是Spring Boot提供的一个模块，为开发人员提供了生产级的功能，无需编写额外的代码。以下是对Spring Boot Actuator模块的详细介绍：

一、主要功能

健康检查：
- Actuator提供了一个端点来检查应用程序的健康状态，有助于了解应用程序是否正常运行。
- 应用程序可以通过实现HealthIndicator接口来自定义健康检查逻辑。
度量和指标：
- Actuator可以收集和暴露应用程序的度量信息，如响应时间、错误率、内存使用、CPU使用率、垃圾回收等。
- 这些信息可以帮助监控应用程序的性能和稳定性。
- 应用程序可以通过实现MeterBinder接口来向/metrics端点添加自定义度量指标。
环境信息：
- Actuator可以暴露应用程序的环境信息，如应用程序名称、版本、Java版本、环境变量和配置属性等。
审计：
- Actuator可以记录应用程序的操作日志，如登录、注销等事件，以便在出现问题时进行排查。
- 支持收集和报告审计事件。
管理端点：
- Actuator提供了一系列预定义的HTTP端点，允许通过HTTP请求访问Actuator的功能。
- 常用的端点包括/health、/info、/metrics等。
- 还支持自定义端点来扩展Actuator的功能。
其他功能：
- 支持分布式跟踪，可以追踪请求在整个微服务架构中的流转过程。
- 提供应用程序配置属性的元数据，包括描述、默认值等信息。
- 集成了Flyway数据库迁移工具，可以自动管理数据库模式的变更。
- 内置H2控制台，可以直接在浏览器中访问数据库。
- 允许动态修改日志级别。
- 提供应用程序的当前堆栈跟踪信息。
- 显示构建信息，如版本号、构建时间等。
- 提供一个HTTP端点来触发应用程序的优雅关机。
- 提供JMX接口来访问Actuator的功能。

二、启用与配置

启用Actuator：
- 要在Spring Boot应用程序中启用Actuator，需要添加spring-boot-starter-actuator依赖。
配置端点：
- 默认情况下，Actuator端点是无法直接访问的。需要通过配置来暴露这些端点。
- 可以在application.yml或application.properties文件中配置management.endpoints.web.exposure.include属性来暴露端点。例如，设置为*表示暴露所有端点。
访问端点：
- 启动应用程序后，可以通过HTTP请求访问Actuator端点。例如，访问http://localhost:8080/actuator/health来获取应用程序的健康状态。

三、安全性

为了保证Actuator暴露的监控接口的安全性，需要添加安全控制的依赖，如spring-boot-starter-security。
访问应用监控端点时，需要输入验证信息。

四、应用场景

Spring Boot Actuator适用于需要对Spring Boot应用程序进行监控和管理的场景。
通过Actuator提供的端点，开发人员可以轻松地获取应用程序的健康状态、性能指标、环境信息等，从而实现对应用程序的实时监控和运维管理。

总之，Spring Boot Actuator为开发人员提供了一个强大的工具集，可以轻松地管理和监控Spring Boot应用程序。通过合理配置和使用Actuator模块，可以提高应用程序的可靠性和稳定性。

主要功能有哪些？

Spring Boot Actuator模块为Spring Boot应用程序提供了丰富的生产级功能，无需编写额外的代码。以下是一些Spring Boot Actuator模块的主要功能：

健康检查（Health）：
- 提供应用程序的健康状态信息，通常用于监控应用程序是否正常运行。
- 可以通过实现HealthIndicator接口来自定义健康检查逻辑。
信息展示（Info）：
- 展示应用程序的自定义信息，如应用程序名称、版本、描述等。
- 这些信息通常通过application.properties或application.yml配置文件进行配置。
度量指标（Metrics）：
- 收集并展示应用程序的各种度量指标，如CPU使用率、内存占用、垃圾回收次数等。
- 可以通过实现MeterBinder接口来添加自定义度量指标。
日志查看（Loggers）：
- 动态查看和修改应用程序的日志级别。
- 有助于在运行时调整日志输出，以便更好地进行故障排查。
线程信息（Threads）：
- 提供应用程序当前线程的信息，如线程数、线程状态等。
- 有助于了解应用程序的并发情况和线程使用情况。
垃圾回收（Garbage Collection）：
- 展示应用程序的垃圾回收信息，如垃圾回收次数、回收时间等。
- 有助于了解应用程序的内存管理情况。
环境信息（Environment）：
- 展示应用程序的环境信息，如系统属性、环境变量、配置属性等。
- 有助于了解应用程序的运行环境。
应用程序映射（Mappings）：
- 展示应用程序的所有URL映射信息。
- 有助于了解应用程序的路由和端点配置。
数据源信息（DataSources）：
- 展示应用程序的数据源信息，如数据库连接池状态、SQL查询统计等。
- 有助于了解应用程序的数据库连接和性能情况。
应用配置（ConfigurationProperties）：
- 展示应用程序的@ConfigurationProperties绑定信息。
- 有助于了解应用程序的配置属性及其绑定情况。
审计事件（Audit Events）：
- 展示应用程序的审计事件信息，如登录、注销等安全事件。
- 有助于了解应用程序的安全事件记录。
HTTP跟踪（HttpTrace）：
- 展示应用程序的HTTP请求和响应信息，如请求头、响应状态码等。
- 有助于了解应用程序的HTTP通信情况。
会话信息（Sessions）：
- 展示应用程序的会话信息，如会话ID、会话属性等（在Spring Session支持的场景下）。
- 有助于了解应用程序的会话管理情况。
文件上传（File Upload）：
- 支持文件上传功能（在Spring MVC支持的场景下）。
优雅停机（Shutdown）：
- 提供一个端点来优雅地关闭应用程序。
- 需要在配置中显式启用此功能，并确保应用程序能够安全地关闭。

这些功能通常通过HTTP端点暴露给外部系统或工具进行访问和监控。为了确保安全性，建议在使用这些端点时添加适当的安全控制措施，如身份验证和授权。

请注意，Spring Boot Actuator的功能可能会随着版本的更新而发生变化。因此，在使用特定版本的Spring Boot时，建议查阅官方文档以获取最新的功能和配置信息。

启用actuator

Spring Boot Actuator是Spring Boot提供的一个强大工具，它可以帮助监控和管理Spring Boot应用。以下是Spring Boot Actuator的配置指南：

一、引入依赖

首先，需要在Spring Boot项目的构建配置文件中添加Spring Boot Actuator的依赖。对于Maven项目，可以在pom.xml中添加以下依赖：

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

对于Gradle项目，可以在build.gradle中添加以下依赖：

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

二、配置Actuator端点

Actuator提供了一系列的端点，可以通过这些端点来查看应用的运行状态。在application.properties或application.yml文件中，可以配置哪些端点应该被暴露出来。

暴露端点
- management.endpoints.web.exposure.include：用于指定哪些端点应该被暴露出来。默认值是*，表示所有的端点都会被暴露出来。如果只想暴露特定的端点，可以将这个属性的值改为想要暴露的端点的名称，用逗号分隔。
- management.endpoints.web.exposure.exclude：用于指定哪些端点不应该被暴露出来。默认值是空字符串，表示没有端点被排除。如果想关闭某个端点，可以将这个属性的值改为想要关闭的端点的名称，用逗号分隔。
基础路径和路径映射
- management.endpoints.web.base-path：用于指定所有端点的基础路径。默认值是/actuator，表示所有的端点的路径都会以/actuator开始。
- management.endpoints.web.path-mapping：用于指定端点的路径映射。默认值是空字符串，表示没有端点的路径被映射。如果想改变某个端点的路径，可以将这个属性的值改为端点的名称和新的路径，用冒号分隔。
跨域资源共享（CORS）
- management.endpoints.web.cors.allowed-origins：用于指定哪些源站点可以访问端点。默认值是空字符串，表示没有源站点被允许。如果想允许某个源站点访问端点，可以将这个属性的值改为源站点的URL，用逗号分隔。

三、安全配置

为了安全起见，通常需要对Actuator端点进行安全认证。可以结合Spring Security来实现这一点。

引入Spring Security依赖

在pom.xml中添加Spring Security依赖：

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

配置Spring Security

创建一个配置类，并配置Spring Security的相关设置。例如，可以要求对Actuator端点的所有请求必须经过认证。
配置用户凭证

在application.properties或application.yml中配置用户凭证，如用户名和密码。

四、其他配置

健康检查端点
- management.endpoint.health.show-details：用于配置健康检查端点的详细信息显示权限。默认值是never，表示不显示详细信息。可以将其设置为when-authorized，表示只有授权的用户才能看到详细的健康信息，或者设置为always，表示总是显示详细信息。
度量数据导出

Actuator还提供了度量数据导出的功能，可以将应用的度量数据导出到外部系统（如Prometheus、InfluxDB等）。在application.properties或application.yml中可以配置相关属性来启用和配置度量数据导出。

五、启动和访问

配置完成后，启动Spring Boot应用。Actuator端点将自动启用，并可以通过特定的URL进行访问。例如，可以通过http://localhost:8080/actuator/health来访问健康检查端点。

注意事项

在生产环境中，应谨慎配置Actuator端点的暴露和安全认证，以防止敏感信息泄露。
根据实际需求选择合适的Actuator端点进行监控和管理。
定期检查和更新Actuator的配置和依赖，以确保其安全性和可用性。

通过以上步骤，就可以成功配置Spring Boot Actuator，并实现对Spring Boot应用的监控和管理。

自定义Actuator

在Spring Boot中，自定义Actuator端点是一种扩展Actuator功能的方式，可以满足特定的监控和管理需求。以下是如何自定义Spring Boot Actuator端点的步骤和要点：

一、创建自定义端点类

使用@Endpoint注解：
- 在自定义端点类上使用@Endpoint注解进行标记，并指定端点的ID。这个ID将用于构建访问该端点的URL路径。
使用@ReadOperation和@WriteOperation注解：
- 使用@ReadOperation注解标记读取操作的方法。当访问该端点时，将调用此方法并返回结果。
- 使用@WriteOperation注解标记写入操作的方法。此方法通常用于处理POST请求，并可以修改某些状态或配置。
返回类型：
- 自定义端点的方法可以返回任何类型的数据，但通常返回的是一个Map<String, Object>，其中包含了要暴露的信息。

二、配置自定义端点

在application.yml或application.properties中配置：
- 需要配置自定义端点的暴露路径和敏感性。通常，将自定义端点标记为非敏感，以便能够公开访问。
- 例如，在application.yml中，可以这样配置：
```
management:
  endpoints:
    web:
      exposure:
        include: customEndpoint # 暴露自定义端点
  endpoint:
    customEndpoint:
      sensitive: false # 标记为非敏感
```
确保Spring Boot Actuator依赖已添加：
- 在项目的pom.xml或build.gradle文件中，确保已添加spring-boot-starter-actuator依赖。

三、测试自定义端点

启动Spring Boot应用程序：
- 启动应用程序后，Actuator将自动注册并暴露配置的端点。
访问自定义端点：
- 使用浏览器或API工具（如Postman）访问自定义端点的URL。URL的格式通常为：http://<hostname>:<port>/actuator/<endpoint-id>。
- 例如，如果自定义端点的ID为customEndpoint，则访问URL为：http://localhost:8080/actuator/customEndpoint。

四、示例代码

以下是一个简单的自定义Actuator端点示例：

package com.example.demo.actuator;

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;

import java.util.HashMap;
import java.util.Map;

@Component
@Endpoint(id = "customEndpoint")
public class CustomEndpoint {

    @ReadOperation
    public Map<String, Object> customEndpoint() {
        Map<String, Object> response = new HashMap<>();
        response.put("message", "This is a custom Actuator endpoint!");
        // 可以添加其他要暴露的信息
        return response;
    }
}