《Spring Boot Actuator详解与深入应用》预计包括三篇,第一篇重点讲Spring Boot Actuator 1.x的应用与定制端点;第二篇将会对比Spring Boot Actuator 2.x 与1.x的区别,以及应用和定制2.x的端点;第三篇将会介绍Actuator metric指标与Prometheus和Grafana的使用结合。这部分内容很常用,且较为入门,欢迎大家的关注。
Spring Boot Actuator提供了生产上经常用到的功能(如健康检查,审计,指标收集,HTTP跟踪等),帮助我们监控和管理Spring Boot应用程序。这些功能都可以通过JMX或HTTP端点访问。
通过引入相关的依赖,即可监控我们的应用程序,收集指标、了解流量或数据库的状态变得很简单。该库的主要好处是我们可以获得生产级工具,而无需自己实际实现这些功能。与大多数Spring模块一样,我们可以通过多种方式轻松配置或扩展它。
Actuator还可以与外部应用监控系统集成,如Prometheus,Graphite,DataDog,Influx,Wavefront,New Relic等等。 这些系统为您提供出色的仪表板,图形,分析和警报,以帮助我们在一个统一界面监控和管理应用服务。
本文将会介绍Spring Boot Actuator 1.x 包括其中的端点(HTTP端点)、配置管理以及扩展和自定义端点。
引入如下的依赖:
1 <dependency>
2 <groupId>org.springframework.boot</groupId>
3 <artifactId>spring-boot-starter-actuator</artifactId>
4 </dependency>
在1.x中,Actuator遵循读写模型,这意味着我们可以从中读取信息或写入信息。我们可以检索指标或我们的应用程序的健康状况,当然我们也可以优雅地终止我们的应用程序或更改我们的日志配置。Actuator通过Spring MVC暴露其HTTP端点。
当引入的Actuator的版本为1.x时,启动应用服务,可以控制台输出如下的端点信息:
我们介绍一下常用的endpoints:
有些端点默认并不会被开启,如/shutdown。
我们可以自定义每个端点的属性,按照如下的格式:
1endpoints.[endpoint name].[property to customize]
可以自定义的属性有如下三个:
我们在配置文件中增加如下的配置,将会定制/beans端点。
1endpoints.beans.id=springbeans
2endpoints.beans.sensitive=false
3endpoints.beans.enabled=true
/health端点用于监控运行的服务实例状态,当服务实例下线或者因为其他的原因变得异常(如DB连接不上,磁盘缺少空间)时,将会及时通知运维人员。
在默认未授权的情况下,通过HTTP的方式仅会返回如下的简单信息:
1{
2 "status": "UP"
3}
我们进行如下的配置:
1endpoints:
2 health:
3 id: chealth
4 sensitive: false
5
6management.security.enabled: false
如上一小节所述,我们更改了/health端点的访问路径为/chealth,并将安全授权关闭。访问http://localhost:8005/chealth
将会得到如下的结果。
1{
2 "status": "UP",
3 "healthCheck": {
4 "status": "UP"
5 },
6 "diskSpace": {
7 "status": "UP",
8 "total": 999995129856,
9 "free": 762513104896,
10 "threshold": 10485760
11 }
12}
我们还可以定制实现health指示器。它可以收集特定于应用程序的任何类型的自定义运行状况数据,并通过/health端点访问到定义的信息。
1@Component
2public class HealthCheck implements HealthIndicator {
3
4 @Override
5 public Health health() {
6 int errorCode = check(); // perform some specific health check
7 if (errorCode != 0) {
8 return Health.down()
9 .withDetail("Error Code", errorCode).build();
10 }
11 return Health.up().build();
12 }
13
14 public int check() {
15 // Our logic to check health
16 return 0;
17 }
18}
实现HealthIndicator
接口,并覆写其中的health()
方法即可自定义我们的/health端点。
通过/info端点,我们可以为应用服务定义一些基本信息:
1info.app.name=Spring Sample Application
2info.app.description=This is my first spring boot application
3info.app.version=1.0.0
我们在如上的配置中定义了服务名、描述和服务的版本号。
/metrics端点展示了OS、JVM和应用级别的指标信息。当开启之后,我们可以获取内存、堆、线程、线程池、类加载和HTTP等信息。
1{
2 "mem": 417304,
3 "mem.free": 231678,
4 "processors": 4,
5 "instance.uptime": 248325,
6 "uptime": 250921,
7 "systemload.average": 1.9541015625,
8 "heap.committed": 375296,
9 "heap.init": 393216,
10 "heap.used": 143617,
11 "heap": 5592576,
12 "nonheap.committed": 43104,
13 "nonheap.init": 2496,
14 "nonheap.used": 42010,
15 "nonheap": 0,
16 "threads.peak": 30,
17 "threads.daemon": 18,
18 "threads.totalStarted": 46,
19 "threads": 20,
20 "classes": 6020,
21 "classes.loaded": 6020,
22 "classes.unloaded": 0,
23 "gc.ps_scavenge.count": 3,
24 "gc.ps_scavenge.time": 35,
25 "gc.ps_marksweep.count": 1,
26 "gc.ps_marksweep.time": 29,
27 "httpsessions.max": -1,
28 "httpsessions.active": 0,
29 "gauge.response.info": 38.0,
30 "counter.status.200.info": 1
31}
为了收集自定义的metrics,Actuator支持单数值记录的功能,简单的增加/减少计数功能。如下的实现,我们将登录成功和失败的次数作为自定义指标记录下来。
1@Service
2public class LoginServiceImpl implements LoginService {
3 private final CounterService counterService;
4
5 @Autowired
6 public LoginServiceImpl(CounterService counterService) {
7 this.counterService = counterService;
8 }
9
10 @Override
11 public Boolean login(String userName, char[] password) {
12 boolean success;
13 if (userName.equals("admin") && "secret".toCharArray().equals(password)) {
14 counterService.increment("counter.login.success");
15 success = true;
16 } else {
17 counterService.increment("counter.login.failure");
18 success = false;
19 }
20 return success;
21 }
22}
再次访问/metrics,发现多了如下的指标信息。登录尝试和其他安全相关事件在Actuator中可用作审计事件。
1{
2 "gauge.response.metrics": 2.0,
3 "gauge.response.test": 3.0,
4 "gauge.response.star-star.favicon.ico": 1.0,
5 "counter.status.200.star-star.favicon.ico": 10,
6 "counter.status.200.test": 6,
7 "counter.login.failure": 6,
8 "counter.status.200.metrics": 4
9}
除了使用Spring Boot Actuator提供的端点,我们也可以定义一个全新的端点。
首先,我们需要实现Endpoint
接口:
1@Component
2public class CustomEndpoint implements Endpoint<List<String>> {
3 @Override
4 public String getId() {
5 return "custom";
6 }
7
8 @Override
9 public boolean isEnabled() {
10 return true;
11 }
12
13 @Override
14 public boolean isSensitive() {
15 return false;
16 }
17
18 @Override
19 public List<String> invoke() {
20 // Custom logic to build the output
21 List<String> messages = new ArrayList<String>();
22 messages.add("This is message 1");
23 messages.add("This is message 2");
24 return messages;
25 }
26}
getId()
方法用于匹配访问这个端点,当我们访问/custom时,将会调用invoke()
我们自定义的逻辑。
另外两个方法,用于设置是否开启和是否为敏感的端点。
1[ "This is message 1", "This is message 2" ]
出于安全考虑,我们可能选择通过非标准端口暴露Actuator端点。通过management.port属性来配置它。
另外,正如我们已经提到的那样,在1.x. Actuator基于Spring Security配置自己的安全模型,但独立于应用程序的其余部分。
因此,我们可以更改management.address属性以限制可以通过网络访问端点的位置:
1#port used to expose actuator
2management.port=8081
3
4#CIDR allowed to hit actuator
5management.address=127.0.0.1
此外,除了/info端点,其他所有的端点默认都是敏感的,如果引入了Spring Security,我们通过在配置文件中定义这些安全的属性(username, password, role)来确保内置端点的安全。
Spring Boot Actuator为我们的应用服务在生产环境提供了很多开箱即用的功能。本文主要讲解了Spring Boot Actuator 1.x的深入使用。我们既可以使用内置的端点(如/health,/info等),可以在这些端点的基础进行扩展和定制,还可以自定义全新的端点,在使用方式上显得非常灵活。