SpringBoot--Actuator

1. 初识Actuator

在开发过程中，项目被放置到生产服务器上运行时，有可能需要我们全方位的监控应用服务的运行情况。此时SpringBoot提供了Actuator模块进行监控和管理

2. 使用方法

在gradle中添加依赖

compile("org.springframework.boot:spring-boot-starter-actuator")

然后启动项目后会发现在启动中发现如下的输出信息

这些端点信息是暴露在外面的原生信息，例如此时访问http://localhost:8080/health会发现在网站中输出如下信息

在SpringBoot2.0中映射的地址是/actuator/health

{"status": "UP","diskSpace": {"status": "UP","total": 250685575168,"free": 172327690240,"threshold": 10485760},"db": {"status": "UP","database": "MySQL","hello": 1}
}

3. 端点介绍

Actuator的端点能够进行监控和管理应用。SpringBoot有许多的内嵌的端点，如果还需要其他的也可以自己添加。例如health端点提供了基本的应用健康信息。

每一个独立的端点都可以进行选择暴露或者不暴露，默认情况下有些端点是开启的，如果不想暴露的话，那么可以在配置文件中进行配置endpoints + . + name，举例如下：

endpoints.env.enabled=false

下面给出几个端点的简单介绍

3.1 自定义info端点信息

在添加了Actuator进行访问info端点的时候，我们会发现页面中显示了一个空的json信息。如果想要显示信息的话，那么可以在配置文件中通过设置info.*进行赋值,例如：

info.app.encoding=UTF-8
info.app.java.source=1.8
info.app.java.target=1.8

这是访问localhost:8080/info可以发现如下信息

{"app": {"java": {"target": "1.8","source": "1.8"},"encoding": "UTF-8"},"name": "BuXueWuShu"
}

4. 自定义端点

有时候自带的端点信息不符合我们的需求，需要我们自定义一些端点信息。在自定义端点信息之前我们需要看一下Endpoint这个SpringBoot中的类。

public interface Endpoint<T> {//暴露在外的Id值，例如health、envString getId();//控制Id信息是否暴露boolean isEnabled();//用于权限的控制boolean isSensitive();//访问Id值返回的信息T invoke();
}

发现暴露出来的端点都是实现了Endpoint这个类，例如trace这个端点。

@ConfigurationProperties(prefix = "endpoints.trace")
public class TraceEndpoint extends AbstractEndpoint<List<Trace>> {private final TraceRepository repository;/*** Create a new {@link TraceEndpoint} instance.* @param repository the trace repository*/public TraceEndpoint(TraceRepository repository) {super("trace");Assert.notNull(repository, "Repository must not be null");this.repository = repository;}@Overridepublic List<Trace> invoke() {return this.repository.findAll();}}

然后发现在spring.factories文件中自动配置了

org.springframework.boot.actuate.autoconfigure.EndpointAutoConfiguration,\

点进去以后发现在其中已经自动将默认的端点注入进Spring容器中了

   @Bean@ConditionalOnMissingBean -- 表示在容器中没有此实体Bean时创建public TraceEndpoint traceEndpoint() {return new TraceEndpoint(this.traceRepository == null? new InMemoryTraceRepository() : this.traceRepository);}

因此自定义端点也是类似的原理，我们做个简单的如下：

public class MyEndPoint implements Endpoint {@Overridepublic String getId() {return "buxuewushu";}@Overridepublic boolean isEnabled() {return true;}@Overridepublic boolean isSensitive() {return true;}@Overridepublic Object invoke() {User user=new User();user.setName("不学无数");user.setAddress("HeNan");return user;}
}

将其放入spring.factories自动注入进容器中

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.FirstSpringBoot.EndPoint.MyEndPoint

然后启动项目输入localhost:8080/buxuewushu出现以下的信息

{"name": "不学无数","address": "HeNan"
}

5. 参考文章

• https://www.jianshu.com/p/9fab4e81d7bb
• http://blog.didispace.com/spring-boot-actuator-1/
• https://docs.spring.io/spring-boot/docs/1.5.15.RELEASE/reference/htmlsingle/#production-ready-endpoints