一起来学SpringBoot | 第十四篇：强大的 actuator 服务监控与管理
SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程
actuator是spring boot项目中非常强大一个功能，有助于对应用程序进行监视和管理，通过restful api请求来监管、审计、收集应用的运行情况，针对微服务而言它是必不可少的一个环节…
Endpoints
actuator的核心部分，它用来监视应用程序及交互，spring-boot-actuator中已经内置了非常多的Endpoints（health、info、beans、httptrace、shutdown等等），同时也允许我们自己扩展自己的端点
Spring Boot 2.0中的端点和之前的版本有较大不同,使用时需注意。另外端点的监控机制也有很大不同，启用了不代表可以直接访问，还需要将其暴露出来，传统的management.security管理已被标记为不推荐。
内置Endpoints
| id | desc | Sensitive |
|---|---|---|
auditevents |
显示当前应用程序的审计事件信息 | Yes |
beans |
显示应用Spring Beans的完整列表 | Yes |
caches |
显示可用缓存信息 | Yes |
conditions |
显示自动装配类的状态及及应用信息 | Yes |
configprops |
显示所有 @ConfigurationProperties 列表 | Yes |
env |
显示 ConfigurableEnvironment 中的属性 | Yes |
flyway |
显示 Flyway 数据库迁移信息 | Yes |
health |
显示应用的健康信息（未认证只显示status，认证显示全部信息详情） |
No |
info |
显示任意的应用信息（在资源文件写info.xxx即可） | No |
liquibase |
展示Liquibase 数据库迁移 | Yes |
metrics |
展示当前应用的 metrics 信息 | Yes |
mappings |
显示所有 @RequestMapping 路径集列表 | Yes |
scheduledtasks |
显示应用程序中的计划任务 | Yes |
sessions |
允许从Spring会话支持的会话存储中检索和删除用户会话。 | Yes |
shutdown |
允许应用以优雅的方式关闭（默认情况下不启用） | Yes |
threaddump |
执行一个线程dump | Yes |
httptrace |
显示HTTP跟踪信息（默认显示最后100个HTTP请求 - 响应交换） | Yes |
导入依赖
在pom.xml中添加spring-boot-starter-actuator的依赖
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-actuatorartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>注意事项
如果要访问info接口想获取maven中的属性内容请记得添加如下内容
<build>
<plugins>
<plugin>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-maven-pluginartifactId>
<executions>
<execution>
<goals>
<goal>build-infogoal>
goals>
execution>
executions>
plugin>
plugins>
build>属性配置
在application.properties文件中配置actuator的相关配置，其中info开头的属性，就是访问info端点中显示的相关内容，值得注意的是Spring Boot2.x中，默认只开放了info、health两个端点，剩余的需要自己通过配置management.endpoints.web.exposure.include属性来加载（有include自然就有exclude，不做详细概述了）。如果想单独操作某个端点可以使用management.endpoint.端点.enabled属性进行启用或禁用
# 描述信息
info.blog-url=http://winterchen.com
info.author=Luis
info.version=@project.version@
# 加载所有的端点/默认只加载了 info / health
management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always
# 可以关闭制定的端点
management.endpoint.shutdown.enabled=false
# 路径映射，将 health 路径映射成 rest_health 那么在访问 health 路径将为404，因为原路径已经变成 rest_health 了，一般情况下不建议使用
# management.endpoints.web.path-mapping.health=rest_health简单测试
启动项目，访问http://localhost:8080/actuator/info看到如下内容代表配置成功
{
"blog-url":"http://winterchen.com",
"author":"Luis",
"version":"0.0.1-SNAPSHOT"
}自定义 - 重点
上面讲了很多都是配置相关，以及自带的一些端点，在实际应用中有时候默认并不能满足我们的要求，比如Spring Boot默认的健康端点就很有可能不能满足
默认装配 HealthIndicators
下列是依赖spring-boot-xxx-starter后相关HealthIndicator的实现（通过management.health.defaults.enabled属性可以禁用它们），但想要获取一些额外的信息时，自定义的作用就体现出来了…
| 名称 | 描述 |
|---|---|
CassandraHealthIndicator |
检查Cassandra数据库是否启动。 |
DiskSpaceHealthIndicator |
检查磁盘空间不足。 |
DataSourceHealthIndicator |
检查是否可以获得连接DataSource。 |
ElasticsearchHealthIndicator |
检查Elasticsearch集群是否启动。 |
InfluxDbHealthIndicator |
检查InfluxDB服务器是否启动。 |
JmsHealthIndicator |
检查JMS代理是否启动。 |
MailHealthIndicator |
检查邮件服务器是否启动。 |
MongoHealthIndicator |
检查Mongo数据库是否启动。 |
Neo4jHealthIndicator |
检查Neo4j服务器是否启动。 |
RabbitHealthIndicator |
检查Rabbit服务器是否启动。 |
RedisHealthIndicator |
检查Redis服务器是否启动。 |
SolrHealthIndicator |
检查Solr服务器是否已启动。 |
健康端点（第一种方式）
实现HealthIndicator接口，根据自己的需要判断返回的状态是UP还是DOWN，功能简单。
package com.winterchen.health;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;
/**
* 自定义健康端点
* Created by Donghua.Chen on 2018/7/12.
*/
@Component("my1")
public class MyHealthIndicator implements HealthIndicator {
private static final String VERSION = "v1.0.0";
@Override
public Health health() {
int code = check();
if (code != 0) {
Health.down().withDetail("code", code).withDetail("version", VERSION).build();
}
return Health.up().withDetail("code", code)
.withDetail("version", VERSION).up().build();
}
private int check() {
return 0;
}
}
简单测试
启动项目，访问http://localhost:8080/actuator/health看到如下内容代表配置成功
{
"status": "UP",
"details": {
"my1": {
"status": "UP",
"details": {
"code": 0,
"version": "v1.0.0"
}
},
"diskSpace": {
"status": "UP",
"details": {
"total": 121123069952,
"free": 35826044928,
"threshold": 10485760
}
}
}
}健康端点（第二种方式）
继承AbstractHealthIndicator抽象类，重写doHealthCheck方法，功能比第一种要强大一点点，默认的DataSourceHealthIndicator 、 RedisHealthIndicator都是这种写法，内容回调中还做了异常的处理。
package com.winterchen.health;
import org.springframework.boot.actuate.health.AbstractHealthIndicator;
import org.springframework.boot.actuate.health.Health;
import org.springframework.stereotype.Component;
/**
* 自定义健康端点
* 功能更加强大一点，DataSourceHealthIndicator / RedisHealthIndicator 都是这种写法
* Created by Donghua.Chen on 2018/7/12.
*/
@Component("my2")
public class MyAbstractHealthIndicator extends AbstractHealthIndicator {
private static final String VERSION = "v1.0.0";
@Override
protected void doHealthCheck(Health.Builder builder) throws Exception {
int code = check();
if (code != 0) {
builder.down().withDetail("code", code).withDetail("version", VERSION).build();
}
builder.withDetail("code", code)
.withDetail("version", VERSION).up().build();
}
private int check() {
return 0;
}
}
简单测试
启动项目，访问http://localhost:8080/actuator/health看到如下内容代表配置成功
{
"status": "UP",
"details": {
"my2": {
"status": "UP",
"details": {
"code": 0,
"version": "v1.0.0"
}
},
"my1": {...},
"diskSpace": {...}
}
}定义自己的端点
上面介绍的info、health都是spring-boot-actuator内置的，真正要实现自己的端点还得通过@Endpoint、 @ReadOperation、@WriteOperation、@DeleteOperation。
注解介绍
不同请求的操作，调用时缺少必需参数，或者使用无法转换为所需类型的参数，则不会调用操作方法，响应状态将为400（错误请求）
@Endpoint构建 rest api 的唯一路径- **
@ReadOperation**GET请求，响应状态为 200 如果没有返回值响应 404（资源未找到） - **
@WriteOperation**POST请求，响应状态为 200 如果没有返回值响应 204（无响应内容） - **
@DeleteOperation**DELETE请求，响应状态为 200 如果没有返回值响应 204（无响应内容）
package com.winterchen.endpoint;
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import java.util.HashMap;
import java.util.Map;
/**
* * @Endpoint 是构建 rest 的唯一路径
* 不同请求的操作，调用时缺少必需参数，或者使用无法转换为所需类型的参数，则不会调用操作方法，响应状态将为400（错误请求）
* @ReadOperation = GET 响应状态为 200 如果没有返回值响应 404（资源未找到）
* @WriteOperation = POST 响应状态为 200 如果没有返回值响应 204（无响应内容）
* @DeleteOperation = DELETE 响应状态为 200 如果没有返回值响应 204（无响应内容）
*
* Created by Donghua.Chen on 2018/7/12.
*/
@Endpoint(id = "luis")
public class MyEndPoint {
@ReadOperation
public Map hello() {
Map result = new HashMap<>();
result.put("author", "Luis");
result.put("age", "25");
result.put("email", "[email protected]");
return result;
}
} 以为这就大功告成了吗，现实告诉我的是spring-boot默认是不认识这玩意的，得申明成一个Bean（请看主函数）
主函数
package com.winterchen;
import com.winterchen.endpoint.MyEndPoint;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@SpringBootApplication
public class SpringBootActuatorApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootActuatorApplication.class, args);
}
@Configuration
static class MyEndpointConfiguration {
@Bean
@ConditionalOnMissingBean
@ConditionalOnEnabledEndpoint
public MyEndPoint myEndPoint() {
return new MyEndPoint();
}
}
}
测试
完成准备事项后，启动Chapter13Application访问http://localhost:8080/actuator/luis看到如下内容代表配置成功…
{
"author": "Luis",
"age": "25",
"email": "[email protected]"
}总结
参考文档：https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#production-ready
目前很多大佬都写过关于SpringBoot的教程了，如有雷同，请多多包涵，本教程基于最新的spring-boot-starter-parent：2.0.2.RELEASE编写，包括新版本的特性都会一起介绍…
说点什么
springboot技术交流群：681513531
个人博客：https://blog.winterchen.com
全文代码：https://github.com/WinterChenS/springboot-learning-experience
- 本文作者：唐亚峰
- 本文链接：http://blog.battcn.com/2018/05/24/springboot/v2-actuator-introduce/
- 版权声明：本博客所有文章除特别声明外，均采用CC BY-NC-SA 3.0许可协议。转载请注明出处！