SpringBoot—Actuator 详解-编程知识

Spring Boot Actuator 模块提供了生产级别的功能，比如健康检查，审计，指标收集，HTTP 跟踪等，帮助我们监控和管理Spring Boot 应用。

这个模块是一个采集应用内部信息暴露给外部的模块，上述的功能都可以通过HTTP 和 JMX(Java Management Extensions)访问。

因为暴露内部信息的特性，Actuator 也可以和一些外部的应用监控系统整合（Prometheus, Graphite, DataDog, Influx, Wavefront, New Relic等）。

这些监控系统提供了出色的仪表板，图形，分析和警报，可帮助你通过一个统一友好的界面，监视和管理你的应用程序。

Actuator使用Micrometer与这些外部应用程序监视系统集成。这样一来，只需很少的配置即可轻松集成外部的监控系统。

Micrometer 为 Java 平台上的性能数据收集提供了一个通用的 API，应用程序只需要使用 Micrometer 的通用 API 来收集性能指标即可。 Micrometer 会负责完成与不同监控系统的适配工作。这就使得切换监控系统变得很容易。

需要注意的是

SpringBoot 1.x和2.x的Actuator监控设定相差很多，提供endpoint路径不一样，连application.properties的配置也不一样

下面主要介绍为 SpringBoot 2.x 版本。

集成Actuator

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

SpringBoot运行时自动开发/actuator/health和/actuator/info两个endpoint

可以访问http://localhost:8099/actuator，查看暴露出来的端点；

Endpoints介绍

Spring Boot 提供了所谓的 endpoints （端点）给外部来与应用程序进行访问和交互。

打比方来说，/health 端点提供了关于应用健康情况的一些基础信息。metrics 端点提供了一些有用的应用程序指标（JVM 内存使用、系统CPU使用等）。

这些 Actuator 模块本来就有的端点我们称之为原生端点。根据端点的作用的话，我们大概可以分为三大类：

应用配置类：获取应用程序中加载的应用配置、环境变量、自动化配置报告等与Spring Boot应用密切相关的配置类信息。
度量指标类：获取应用程序运行过程中用于监控的度量指标，比如：内存信息、线程池信息、HTTP请求统计等。
操作控制类：提供了对应用的关闭等操作类功能。

需要注意的就是：

每一个端点都可以通过配置来单独禁用或者启动
不同于Actuator 1.x，Actuator 2.x 的大多数端点默认被禁掉。 Actuator 2.x 中的默认端点增加了/actuator前缀。默认暴露的两个端点为/actuator/health和 /actuator/info

端点配置

默认暴露

我们可以通过以下配置，来配置通过JMX 和 HTTP 暴露的端点。

因为安全的因素，所以Actuator默认只会开发/actuator/health和/actuator/info这两个endpoint

暴露配置

# 开发所有endpoints(不包含shutdown)
management.endpoints.web.exposure.include=*# 只会开发指定的endpoint，如开发/actuator/beans和/actuator/mappings
management.endpoints.web.exposure.include=beans,mappings# exclude可以用关闭endpoints
# exclude通常跟include一起用，就是先include了全部，再exclude /actuator/beans這個endpoint
management.endpoints.web.exposure.exclude=beans
management.endpoints.web.exposure.include=*# 如果要开发/actuator/shutdown，要额外再加这一行
management.endpoint.shutdown.enabled=true

路径映射

默认情况下所有端点都暴露在“/actuator”路径下，也可以改变/actuator的路径，可以自定义成自己想要的：

#原本/actuator/xxx路径，变成/manage/xxx
management.endpoints.web.base-path=/manage#同时可以将health修改成healthcheck
management.endpoints.web.path-mapping.health=healthcheck

管理端口调整

#指定端口，默认跟server.port一样
management.server.port=10111

端点响应缓存

对于一些不带参数的端点请求会自动进行缓存，我们可以通过如下方式配置缓存时间，下面配置表示 beans 端点的缓存时间为 100s

management.endpoint.beans.cache.time-to-live=100s

端点保护

如果开启了 Actuator 默认不打开的 endpoints，一定要加上 Spring security 之类的做 endpoint 保护。因为端点的信息和产生的交互都是非常敏感的，必须防止未经授权的外部访问。

这里我们使用 Spring Security 保护，首先添加相关依赖：

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

添加之后，我们需要定义安全校验规则，来覆盖Spring Security 的默认配置。

package com.allycoding.ecommerce.conf;

import de.codecentric.boot.admin.server.config.AdminServerProperties;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
import org.springframework.security.web.savedrequest.SavedRequest;

/*** <h1>配置安全认证，以便其他的微服务可以注册</h1>*/
@Configuration
public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {
/** 应用上下文路径*/private final String adminContextPath;
public SecuritySecureConfig (AdminServerProperties adminServerProperties){this.adminContextPath=adminServerProperties.getContextPath();}
@Overrideprotected void configure(HttpSecurity http) throws Exception {
SavedRequestAwareAuthenticationSuccessHandler successHandler=new SavedRequestAwareAuthenticationSuccessHandler();successHandler.setTargetUrlParameter("redirectTo");successHandler.setDefaultTargetUrl(adminContextPath+"/");
http.authorizeRequests()// 1. 配置所有的静态资源和登录也以公开访问.antMatchers(adminContextPath+"/assets/**").permitAll().antMatchers(adminContextPath+"/login").permitAll()// 2. 其他请求，必须要经过认证.anyRequest().authenticated().and()// 3.配置登录和登出路径.formLogin().loginPage(adminContextPath+"/login").successHandler(successHandler).and().logout().logoutUrl(adminContextPath+"/logout").and()// 4. 开启http basic 支持，其他的服务模块注册是需要使用.httpBasic().and()// 5. 开启基于 cookie的csrf 保护.csrf().csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())// 6. 忽略这些路径的 csrf 保护以使其他的模块可以实现注册.ignoringAntMatchers(adminContextPath+"/instances",adminContextPath+"/actuator/**");
//super.configure(http);}
}

application.properties的相关配置如下：

# Spring Security Default user name and password
spring.security.user.name=actuator
spring.security.user.password=actuator
spring.security.user.roles=ADMIN

重要端点解析

/health 端点

当我们开启health的健康端点时，我们能够查到应用健康信息是一个汇总的信息.

要想查看详细的应用健康信息需要配置：

management.endpoint.health.show-details=always

该属性可以使用以下值之一进行配置：

never：不展示详细信息，up或者down的状态，默认配置
when-authorized：详细信息将会展示给通过认证的用户。授权的角色可以通过management.endpoint.health.roles配置
always：对所有用户暴露详细信息

/metrics 端点

查看所有可追踪的度量

/metrics端点用来返回当前应用的各类重要度量指标，比如：内存信息、线程信息、垃圾回收信息、tomcat、数据库连接池等。

/loggers 端点

查看日志等级

/loggers 端点暴露了我们程序内部配置的所有logger的信息。

/info 端点

/info端点可以用来展示应用信息，主要包含三大类：自定义信息、Git 信息、以及项目构建信息

/beans 端点

/beans端点会返回Spring 容器中所有bean的别名、类型、是否单例、依赖等信息。

/threaddump 端点

这个端点我个人觉得特别有用，方便我们在日常定位问题的时候查看线程的情况。主要展示了线程名、线程ID、线程的状态、是否等待锁资源、线程堆栈等信息。

自定义Endpoint

默认的端点虽然可以满足大多数的需求，但一些特殊的需求还是需要能够支持自定义端点的。

自定义 Endpoint 端点，只需要在我们的新建Bean上使用 @Endpoint 注解即可， Bean 中的方法就可以通过 JMX 或者 HTTP 公开。

除此之外，还可以使用 @JmxEndpoint 或 @WebEndpoint 编写 EndPoint。但这些 EndPoint 仅限于各自的公开方式。例如，@WebEndpoint 仅通过HTTP公开，而不通过JMX公开。

那么是不是类中所有的方法都支持对外公开呢？

很明显不是的。Actuator提供了三个用于方法上的注解，只有加三个注解的方法才支持对外公开，并且每个注解都有支持它的HTTP method。

@ReadOperation对应HTTP的GET请求
@WriteOperation对应HTTP的POST请求
@DeleteOperation对应HTTP的DELETE请求

来看一个简单的使用实例：

@Component
@Endpoint(id = "my")
public class EndpointCustom {@ReadOperationpublic String endpointCustomRead(String content) {return "请求的内容: " + content;}@WriteOperationpublic String endpointCustomWrite(String content) {return "写的内容: " + content;}@DeleteOperationpublic String endpointCustomDelete(String content) {return "删除的内容: " + content;}}

对应GET请求：

curl -X GET http://localhost:8080/actuator/my?content=endpointGet

执行之后，会返回信息“请求的内容: endpointGet”。

同样的POST请求为：

curl -X POST http://localhost:8080/actuator/my?content=endpointPost

DELETE请求为：

curl -X DELETE http://localhost:8080/actuator/my?content=endpointDELETE

上面只是简单自定义实例，根据具体的业务场景，可以定义更加丰富的端点实现。