SpringBoot监控神器——Actuator 保姆级教程

配置Actuator

pom.xml

<!– web start–>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!– web end–>
<!– actuator start–>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!– actuator end–>

/actuator
/actuator/health
/actuator/health/{component}
/actuator/health/{component}/{instance}
/actuator/info

• 引入上述的依赖jar

management:
endpoints:
web:
exposure:
include: “*”

• 应用配置类 ：可以查看应用在运行期的静态信息：例如自动配置信息、加载的 springbean 信息、yml 文件配置信息、环境信息、请求映射信息；
• 度量指标类 ：主要是运行期的动态信息，例如堆栈、请求连、一些健康指标、metrics 信息等；
• 操作控制类 ：主要是指 shutdown,用户可以发送一个请求将应用的监控功能关闭。

management:
endpoints:
web:
exposure:
include: “*”

management:
endpoints:
web:
exposure:
exclude: beans,trace

management:
endpoints:
web:
base-path: /manage #记得要加上/

• health

{
“status” : “UP”
}

{
“status”: “UP”,
“components”: {
“diskSpace”: {
“status”: “UP”,
“details”: {
“total”: 236510507008,
“free”: 223361744896,
“threshold”: 10485760
}
},
“ping”: {
“status”: “UP”
}
}
}

1. 设置状态码顺序：setStatusOrder(Status.DOWN, Status.OUT_OF_SERVICE, Status.UP, Status.UNKNOWN);。
2. 过滤掉不能识别的状态码。
3. 如果无任何状态码，整个 Spring Boot 应用的状态是 UNKNOWN。
4. 将所有收集到的状态码按照 1 中的顺序排序。
5. 返回有序状态码序列中的第一个状态码，作为整个 Spring Boot 应用的状态。

management:
health:
redise:
enabled: false

• 自定义 HealthIndicator 健康检查

@Component
public class MyHealthIndicator implements HealthIndicator {

@Override
public Health health() {
int errorCode = check(); // perform some specific health check
if (errorCode != 0) {
return Health.down().withDetail(“Error Code”, errorCode).build();
}
return Health.up().build();
}

}

management:
health:
status:
order: FATAL, DOWN, OUT_OF_SERVICE, UNKNOWN, UP

management:
health:
status:
http-mapping:
FATAL: 503

info

info:
app:
name:
spring-boot-actuator
version: 1.0.0
test: test

{
“app”: {
“name”: “spring-boot-actuator”,
“version”: “1.0.0”,
“test”:”test”
}
}

beans

[
{
“context”: “application:8080:management”,
“parent”: “application:8080”,
“beans”: [
{
“bean”: “embeddedServletContainerFactory”,
“aliases”: [

],
“scope”: “singleton”,
“type”: “org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory”,
“resource”: “null”,
“dependencies”: [

]
},
{
“bean”: “endpointWebMvcChildContextConfiguration”,
“aliases”: [

],
“scope”: “singleton”,
“type”: “org.springframework.boot.actuate.autoconfigure.EndpointWebMvcChildContextConfiguration$$EnhancerBySpringCGLIB$$a4a10f9d”,
“resource”: “null”,
“dependencies”: [

]
}
}
]

conditions

{
“positiveMatches”: {
“DevToolsDataSourceAutoConfiguration”: {
“notMatched”: [
{
“condition”: “DevToolsDataSourceAutoConfiguration.DevToolsDataSourceCondition”,
“message”: “DevTools DataSource Condition did not find a single DataSource bean”
}
],
“matched”: [ ]
},
“RemoteDevToolsAutoConfiguration”: {
“notMatched”: [
{
“condition”: “OnPropertyCondition”,
“message”: “@ConditionalOnProperty (spring.devtools.remote.secret) did not find property ‘secret'”
}
],
“matched”: [
{
“condition”: “OnClassCondition”,
“message”: “@ConditionalOnClass found required classes ‘javax.servlet.Filter’, ‘org.springframework.http.server.ServerHttpRequest’; @ConditionalOnMissingClass did not find unwanted class”
}
]
}
}
}

heapdump

shutdown

management:
endpoint:
shutdown:
enabled: true

curl -X POST “http://localhost:8080/actuator/shutdown”
{
“message”: “Shutting down, bye…”
}

mappings

{
“/**/favicon.ico”: {
“bean”: “faviconHandlerMapping”
},
“{[/hello]}”: {
“bean”: “requestMappingHandlerMapping”,
“method”: “public java.lang.String com.neo.controller.HelloController.index()”
},
“{[/error]}”: {
“bean”: “requestMappingHandlerMapping”,
“method”: “public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)”
}
}

threaddump

[
{
“threadName”: “http-nio-8088-exec-6”,
“threadId”: 49,
“blockedTime”: -1,
“blockedCount”: 0,
“waitedTime”: -1,
“waitedCount”: 2,
“lockName”: “java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject@1630a501”,
“lockOwnerId”: -1,
“lockOwnerName”: null,
“inNative”: false,
“suspended”: false,
“threadState”: “WAITING”,
“stackTrace”: [
{
“methodName”: “park”,
“fileName”: “Unsafe.java”,
“lineNumber”: -2,
“className”: “sun.misc.Unsafe”,
“nativeMethod”: true
},
…
{
“methodName”: “run”,
“fileName”: “TaskThread.java”,
“lineNumber”: 61,
“className”: “org.apache.tomcat.util.threads.TaskThread$WrappingRunnable”,
“nativeMethod”: false
}
…
],
“lockInfo”: {
“className”: “java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject”,
“identityHashCode”: 372286721
}
}
…
]

loggers 端点

metrics 端点

自定义Endpoint

actuator:
filter:
switch: false

自定义监控端点常用注解

• @Endpoint ：定义一个监控端点，同时支持 HTTP 和 JMX 两种方式。
• @WebEndpoint ：定义一个监控端点，只支持 HTTP 方式。
• @JmxEndpoint ：定义一个监控端点，只支持 JMX 方式。

• @ReadOperation ：作用在方法上，可用来返回端点展示的信息（通过 Get 方法请求）。
• @WriteOperation ：作用在方法上，可用来修改端点展示的信息（通过 Post 方法请求）。
• @DeleteOperation ：作用在方法上，可用来删除对应端点信息（通过 Delete 方法请求）。
• @Selector ：作用在参数上，用来定位一个端点的具体指标路由。

• 使用@Endpoint注解相应的类，作为Actuator的一个endpoint。注解要指定id，这个id作为访问路径，比如这里是/actuator/super；
• @ReadOperation来注解查询接口，如果要根据路径做查询，要用@Selector注解方法参数；注意这地方是@Selector String arg0，这个arg0不能改变，改成其他的，开放出去的接口还是/{arg0}，这就导致你的方法无法正常获取参数值。
• @WriteOperation 来注解修改接口，注意请求数据必须是json，而且参数不像controller中那么灵活，不能将实体作为参数，要把实体中相应的属性拿出来做参数。
• 这里在增加用户时，往request里放一个user对象。

package com.cff.springbootwork.actuator.endpoint;

import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

import javax.servlet.http.HttpServletRequest;

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.Selector;
import org.springframework.boot.actuate.endpoint.annotation.WriteOperation;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

@Endpoint(id = “super”)
public class SuperEndPoint {
private Map<String, SuperUser> users = new ConcurrentHashMap<>();

@ReadOperation
public Set<String> users() {
return users.keySet();
}

@ReadOperation
public SuperUser usersIdentify(@Selector String arg0) {
return users.get(arg0);
}

@WriteOperation
public Set<String> set(String userName, String passwd) {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
.getRequest();
if (request != null) {
SuperUser superUser = new SuperUser();
superUser.setUserName(userName);
superUser.setPasswd(passwd);
request.getSession().setAttribute(“superUser”, superUser);

users.put(superUser.getUserName(), superUser);
}

return users.keySet();
}

public static class SuperUser {
private String userName;
private String passwd;

public String getUserName() {
return userName;
}

public void setUserName(String userName) {
this.userName = userName;
}

public String getPasswd() {
return passwd;
}

public void setPasswd(String passwd) {
this.passwd = passwd;
}
}
}

package com.cff.springbootwork.actuator;

import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.cff.springbootwork.actuator.endpoint.SuperEndPoint;

@Configuration
@ServletComponentScan
public class MvcEndPointConfig {

@Bean
@ConditionalOnEnabledEndpoint
public SuperEndPoint superEndPoint() {
return new SuperEndPoint();
}
}

使用Filter对访问actuator做限制

• 对/actuator/*下所有路径做过滤,并用actuator.filter.switch属性对filter做开关；
• 如果时/actuator/super路径的post操作，放行它，它将会往request中放一个对象；
• 其他/actuator/*下路径要判断request中有没有user对象，没有就返回错误提示。

package com.cff.springbootwork.actuator.filter;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;

import com.fasterxml.jackson.databind.ObjectMapper;

@WebFilter(urlPatterns = “/actuator/*”, filterName = “actuatorPermissionFilter”)
@Order(1) // 指定过滤器的执行顺序,值越大越靠后执行
public class ActuatorPermissionFilter implements Filter {
private String excludePath = “actuator/super”;
@Value(“${actuator.filter.switch}”)
Boolean actuatorSwitch;

@Override
public void init(FilterConfig filterConfig) {

}

@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
if (actuatorSwitch && !(request.getRequestURI().endsWith(excludePath)
&& request.getMethod().equals(HttpMethod.POST.toString()))) {
Object user = request.getSession().getAttribute(“superUser”);
if (user == null) {
// 未登录,返回数据
ObjectMapper mapper = new ObjectMapper();
response.setStatus(HttpStatus.OK.value());
response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
mapper.writeValue(response.getWriter(), “您没有权限访问该接口，请使用自定义的登录接口设置superUser后使用！”);
return;
}
}
filterChain.doFilter(servletRequest, servletResponse);

}

@Override
public void destroy() {
}

}

Spring Boot Monitor做监控页面

<dependency>
<groupId>cn.pomit</groupId>
<artifactId>spring-boot-monitor</artifactId>
<version>0.0.1</version>
</dependency>

• Spring Boot Monitor官网：https://www.pomit.cn/SpringBootMonitor

admin普通

打赏 收藏 海报 链接