Spring Boot Actuator端点大揭秘：轻松监控你的端点大揭应用程序

作者：迷路的架构师 2023-04-11 16:04:19运维 Spring Boot Actuator 是一个用于监控和管理 Spring Boot 应用程序的子项目。它提供了一系列内置的秘轻端点（Endpoints），这些端点可以用于查看应用程序的松监状态、运行情况和运行指标。应用

一、程序Spring Boot Actuator端点简介

1.1 什么是端点大揭Actuator端点

Spring Boot Actuator 是一个用于监控和管理 Spring Boot 应用程序的子项目。它提供了一系列内置的秘轻端点（Endpoints），这些端点可以用于查看应用程序的松监状态、运行情况和运行指标。应用Actuator 端点可以以 HTTP、程序JMX 或其他形式暴露给外部系统，端点大揭便于运维人员对应用程序进行监控、秘轻诊断和管理。松监

1.2 端点的应用作用和功能

Actuator端点主要用于实现以下功能：

• 提供应用程序的健康检查，包括数据库连接、程序缓存、消息队列等
• 收集应用程序的度量数据，例如内存使用情况、GC情况、线程状态等
• 查看应用程序的配置信息，包括环境变量、系统属性、配置文件中的属性等
• 管理应用程序的日志，包括查看和动态修改日志级别
• 获取应用程序的 Spring Bean 信息，以及应用程序的元数据等
• 提供应用程序的关闭功能等

1.3 Actuator端点的默认配置

Spring Boot Actuator 默认提供了一系列内置端点，这些端点在开发环境下可以直接访问，但在生产环境中，可能需要对端点进行权限控制和暴露策略的配置。Actuator的端点可以通过 application.properties 或 application.yml 文件进行配置。例如，可以通过配置
management.endpoints.web.exposure.include 来控制哪些端点暴露给外部访问，或者通过 management.endpoints.web.base-path 来修改端点的URL路径。

二、内置端点详解

Spring Boot Actuator 提供了许多内置端点，用于查看和管理应用程序的不同方面。以下是一些常用端点的详细介绍：

2.1 /actuator/health

这个端点用于查看应用程序的健康状态。它会检查各个组件的状态，如数据库连接、缓存、消息队列等。返回的状态包括 UP（正常）、DOWN（异常）和 OUT_OF_SERVICE（维护中）等。

2.2 /actuator/info

此端点用于展示应用程序的基本信息，如版本号、构建时间等。这些信息通常来源于应用程序的配置文件或构建系统。

2.3 /actuator/metrics

此端点用于查看应用程序的度量数据。它收集了关于内存使用、GC、线程状态等方面的数据。可以通过添加参数来查看特定度量的详细信息，例如：

/actuator/metrics/jvm.memory.used。

2.4 /actuator/beans

此端点用于查看应用程序中的所有 Spring Bean。它显示了 Bean 的名称、类型、作用域和所属的 ApplicationContext 等信息。

2.5 /actuator/env

此端点用于查看应用程序的环境信息，包括环境变量、系统属性、配置文件中的属性等。可以通过添加参数来查看特定属性的值，例如：/actuator/env/server.port。

2.6 /actuator/loggers

此端点用于查看和管理应用程序的日志。它显示了当前应用程序中所有 Logger 的名称和日志级别。通过发送 POST 请求，还可以动态修改某个 Logger 的日志级别。

2.7 /actuator/shutdown

这个端点用于关闭应用程序。它需要配置
management.endpoint.shutdown.enabled 为 true 才能启用。在生产环境中，通常需要对此端点进行权限控制，以防止误操作。

2.8 其他端点

除了以上常用端点外，Spring Boot Actuator 还提供了一些其他端点，例如：

• /actuator/auditevents：查看应用程序的审计事件
• /actuator/threaddump：获取应用程序的线程转储信息
• /actuator/heapdump：获取应用程序的堆转储信息
• /actuator/mappings：查看应用程序的 URL 映射信息

三、端点配置与定制

在实际项目中，我们可能需要对 Spring Boot Actuator 的端点进行一些定制，以满足特定的需求。本节将介绍如何对端点进行配置和定制。

3.1 控制端点访问权限

访问端点可能涉及敏感信息，我们需要对端点进行权限控制。可以通过集成 Spring Security 或自定义拦截器实现访问权限控制。例如，仅允许具有 ADMIN 角色的用户访问 /actuator/shutdown 端点。

3.2 端点暴露策略

可以通过management.endpoints.web.exposure.include 和 management.endpoints.web.exposure.exclude 配置项来控制哪些端点应该被暴露。默认情况下，仅暴露 /actuator/health 和 /actuator/info 端点。例如，暴露所有端点：

management.endpoints.web.exposure.include=*

或者仅暴露某些特定端点：

management.endpoints.web.exposure.include=health,info,metrics,env

3.3 修改端点的 URL 路径

默认情况下，所有端点的路径都是以 /actuator 开头的。我们可以通过
management.endpoints.web.base-path 配置项修改这个前缀。例如，将其更改为 /admin：

management.endpoints.web.base-path=/admin

3.4 端点响应内容定制

默认情况下，某些端点的响应内容可能不包含我们关心的所有信息。可以通过实现自定义的 EndpointFilter 来定制端点的响应内容。例如，可以为 /actuator/health 端点添加自定义的健康指标。或者通过继承并重写原有端点的方法来实现定制。

通过这些定制方法，我们可以使 Spring Boot Actuator 更好地适应实际项目需求。

四、创建自定义端点

在某些情况下，内置的端点无法满足我们的需求，因此我们需要创建自定义端点。本节将介绍自定义端点的实现方式、应用场景举例以及如何注册和配置自定义端点。

4.1 自定义端点的实现方式

要创建自定义端点，需要实现org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint 接口或 org.springframework.boot.actuate.endpoint.annotation.Endpoint 接口。其中，RestControllerEndpoint 接口允许我们创建基于 Web 的端点，而 Endpoint 接口则适用于其他类型的端点。

4.2 注册和配置自定义端点

创建自定义端点后，需要将其注册到 Spring Boot Actuator。我们可以通过将自定义端点作为 Bean 注册到 Spring 上下文来实现。例如：

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

@Component
@Endpoint(id = "cache-status")
public class CacheStatusEndpoint { 

@ReadOperation
public CacheStatus getCacheStatus() { 
// 在这里实现获取缓存状态的逻辑
// 例如，从缓存管理器中获取相关信息
CacheStatus cacheStatus = new CacheStatus();
cacheStatus.setCacheSize(100);
cacheStatus.setHitCount(200);
cacheStatus.setMissCount(50);
return cacheStatus;
}
}

在上面的代码中，我们首先使用@Endpoint注解来指定端点的ID（即cache-status）。然后，我们定义了一个getCacheStatus()方法，使用@ReadOperation注解来表示这是一个读操作。此方法应返回一个表示缓存状态的对象（例如，CacheStatus类）。

接下来，我们需要定义CacheStatus类：

public class CacheStatus { 

private int cacheSize;
private int hitCount;
private int missCount;

// 省略 getter 和 setter 方法
}

接下来，我们需要为自定义端点配置访问权限、暴露策略等。这可以通过在 application.properties 文件中添加相关配置来实现。例如：

management.endpoints.web.exposure.include=health,info,cache-status

这将使得我们的自定义端点 /actuator/cache-status 能够被访问。

五、端点数据监控与可视化

在本节中，我们将介绍如何利用Spring Boot Actuator端点数据进行监控与可视化，从而更好地了解应用程序的运行状况。

5.1 使用JMX监控端点

Java Management Extensions（JMX）是Java平台的一种技术，允许对Java应用程序进行管理和监控。Spring Boot Actuator默认支持将端点数据暴露到JMX。要使用JMX监控端点，请确保在应用程序的application.properties或application.yml文件中启用了JMX：

management.endpoints.jmx.exposure.include=*

然后，您可以使用JMX客户端（如Java Mission Control、VisualVM等）连接到应用程序的JMX端口，查看和操作暴露的端点数据。

5.2 使用Prometheus和Grafana进行可视化监控

Prometheus是一个流行的开源监控系统，与Grafana这个数据可视化工具结合使用，可以为Spring Boot Actuator端点数据提供强大的可视化监控功能。

首先，需要在Spring Boot应用程序中集成Prometheus。添加相应的依赖并配置application.properties或application.yml文件，以启用Prometheus端点：

management.endpoints.web.exposure.include=*
management.metrics.export.prometheus.enabled=true

接下来，需要配置Prometheus来抓取Spring Boot应用程序的数据。在Prometheus的配置文件中（通常是prometheus.yml），添加以下内容：

scrape_configs:
- job_name: 'spring-boot-actuator'
metrics_path: '/actuator/prometheus'
static_configs:
- targets: ['localhost:8080'] # 将此处替换为Spring Boot应用程序的实际地址

最后，在Grafana中添加Prometheus数据源，并创建仪表板来展示和分析Spring Boot Actuator端点的数据。如下图所示：

5.3 集成其他监控工具

Spring Boot Actuator还可以与其他监控工具集成，例如Datadog、InfluxDB、New Relic等。要集成这些工具，通常需要在应用程序中添加相应的依赖并进行一些配置。具体的集成步骤和配置方式请参考官方文档或相关教程。

六、总结

在本文中，我们详细介绍了Spring Boot Actuator端点的相关内容，下面对全文进行概括总结。

6.1 Spring Boot Actuator端点的优势

• 提供丰富的内置端点，可以轻松获取应用程序的运行时信息，如健康状况、度量数据、环境信息等。
• 端点配置灵活，支持定制访问权限、路径和响应内容。
• 可以轻松创建自定义端点，满足特定业务需求。
• 支持与各种监控工具集成，便于进行数据监控与可视化。

6.2 注意事项和最佳实践

• 谨慎配置端点的访问权限，确保敏感信息不被泄露。
• 合理地暴露和定制端点，以满足实际需求，但避免不必要的开销。
• 使用自定义端点时，遵循单一职责原则，确保每个端点专注于一个特定功能。
• 结合实际业务场景选择合适的监控工具，进行可视化分析，以便于快速发现和解决问题。

6.3 对未来发展的展望

随着微服务和容器化技术的发展，对于应用程序的监控和管理需求将越来越复杂。Spring Boot Actuator的端点功能将继续完善，为开发者提供更加强大的监控工具。同时，我们期待更多的第三方监控工具与Actuator集成，帮助开发者更好地管理和优化其应用程序。

责任编辑：华轩 来源： 今日头条 Spring Boo端点运维

(责任编辑：娱乐)