Spring Boot Actuator集成,难的是灵活运用!

开发 架构
曾经看到Spring Boot Actuator这个框架时,一直在想,它到底有什么作用呢?虽然知道它提供了很多端点,有助于应用程序的监控和管理,但如果没有直接的实践案例,还是很难有说服力的。

[[410648]]

本文转载自微信公众号「程序新视界」,作者丑胖侠二师兄。转载本文请联系程序新视界公众号。

前言

曾经看到Spring Boot Actuator这个框架时,一直在想,它到底有什么作用呢?虽然知道它提供了很多端点,有助于应用程序的监控和管理,但如果没有直接的实践案例,还是很难有说服力的。

直到上篇文章《微服务架构:Nacos本地缓存 PK 微服务优雅下线》中讲到可以利用其中Actuator定义的端点来达到微服务的优雅下线效果,才发现Actuator是真的很有用。

那么本文便基于Spring Boot系统如何集成Actuator,如何使用,以及如何自定义一个端点(Endpoint)来展开。

Spring Boot Actuator简介

Spring Boot Actuator是Spring Boot提供用于对应用系统进行自省和监控的功能模块,基于此开发人员可以方便地对应用系统某些监控指标进行查看、统计、审计、指标收集等。Actuator提供了基于Http端点或JMX来管理和监视应用程序。

刚接触Actuator朋友通常会有一个疑惑,Actuator可以通过Http端点进行访问,那么它与Spring Web提供的@Controller的对外服务有什么区别呢?它们都可以通过Http的方式让外部来访问应用程序,但功能的定义边界不同。就像上面说的Actuator通常用于应用程序本身运行情况的监控和操作,而@Controller更多的是业务层面运用。通过与@Controller这么一对照,你可能更容易理解Actuator的作用了。

Actuator默认功能

Actuator提供了一些默认的REST接口,基于这些接口我们可以很方便的了解应用程序的运行状况。其中某些端口比较敏感,需要在指定的权限下才能进行访问。

通过Actuator可以监控应用程序的Health健康信息、Info应用信息、HTTP Request跟踪信息、Metrics信息、@RequestMapping的路径信息、应用程序的各种配置信息、程序请求的次数时间等各种信息。

这里暂且不做具体端点的解释,因为不同的版本还是有所出入的。先来看一下将所有的端点打开,然后访问http://localhost:8080/actuator 能够看到的端点信息。

至于你所使用的版本包含哪些端点,也采用同样的方法来进行查看。

Spring Boot的集成

将Spring Boot Actuator集成到Spring Boot项目中是非常方便的,只需在pom文件中添加对应的依赖即可:

  1. <dependency> 
  2.     <groupId>org.springframework.boot</groupId> 
  3.     <artifactId>spring-boot-starter-actuator</artifactId> 
  4. </dependency> 

 

这里采用的是Spring Boot 2.2.2.RELEASE版本。启动项目,访问http://localhost:8080/actuator 就可以看到目前可访问的端口列表信息了:

  1. "_links": { 
  2. "self": { 
  3. "href""http://localhost:8080/actuator"
  4. "templated"false 
  5. }, 
  6. "health-path": { 
  7. "href""http://localhost:8080/actuator/health/{*path}"
  8. "templated"true 
  9. }, 
  10. "health": { 
  11. "href""http://localhost:8080/actuator/health"
  12. "templated"false 
  13. }, 
  14. "info": { 
  15. "href""http://localhost:8080/actuator/info"
  16. "templated"false 

可以看出,当前版本默认支持self、health-path、health和info端点信息的访问,其他信息是未对外开放的。

此时,如果需要查看像前面提到的全部的端点,可在application配置文件中进行如下配置:

  1. management: 
  2.   endpoints: 
  3.     web: 
  4.       exposure: 
  5.         include: '*' 
  6.     jmx: 
  7.       exposure: 
  8.         include: '*' 

这样便可以看到所有的端点了。此种方式是针对Spring Boot 2.0以后的版本才起效。需要注意的是配置中的*是需要添加单引号或双引号的。

另外,这种形式的配置也是不推荐的。这样会将所有的端点对外暴露,而没有进行权限验证。建议的模式是,使用到哪些端点,直接在include中明确指出。同时,敏感操作还需要进行认证。

指定配置的形式如下:

  1. management: 
  2.   endpoints: 
  3.     web: 
  4.       exposure: 
  5.         include: health,info 
  6.     jmx: 
  7.       exposure: 
  8.         include: health,info 

不同的端点通过英文逗号分隔即可。

Endpoint的数据结构

其实最开始我们已经看了/actuator返回的数据结构了,这便是端点self的信息。在/actuator的返回信息中还可以看到其他可访问的端点的地址,比如这里访问http://localhost:8080/actuator/health ,结构如下:

  1. "status""UP" 

端点返回的结果为JSON格式,上面返回了status为UP的状态,也就是说系统处于健康运行当中。当然,针对其他端点的访问,返回结果基本一致,这里就不逐一展示了。

停服操作

在上面的端点中,你会发现并没有关闭服务的端点。是的,默认情况下,即使include设置为“*”,依旧没有开启shutdown这类影响服务的操作。

针对这类操作,我们先要设置其可用:

  1. management: 
  2.   endpoint: 
  3.     shutdown: 
  4.       enabled: true 
  5.   endpoints: 
  6.     web: 
  7.       exposure: 
  8.         include: '*' 
  9.     jmx: 
  10.       exposure: 
  11.         include: '*' 

此时,再访问/actuator就可以看到/shutdown端点对应的路径了http://localhost:8080/actuator/shutdown 。

通过curl命令或postman等发送一个post请求到该端点:

  1. curl -X "POST" "http://localhost:8080/actuator/shutdown" 

执行之后,发现服务被关停了。类似停服的操作还有很多,比如restart、pause、restart等。可根据具体版本进行配置,目前版本只发现有shutdown端点,未restart、pause、restart等端点的配置项。

通过上述方式,SpringBoot应用可以优雅的关闭,但是存在很大的安全隐患,如果知道了ip、端口号后就可以模拟该请求停止服务了,因此需要增加一些安全限制。

  • management.endpoints.web.base-path 自定义shutdown的请求路径;
  • management.server.address 设置为本地ip,防止远程访问该连接进行关闭服务;
  • management.server.port 自定义shutdown请求路径的端口号;

调整后的配置文件如下:

  1. management: 
  2.   endpoint: 
  3.     shutdown: 
  4.       enabled: true 
  5.   endpoints: 
  6.     web: 
  7.       exposure: 
  8.         include: '*' 
  9.     jmx: 
  10.       exposure: 
  11.         include: '*' 
  12.   server: 
  13.     # 自定义端口 
  14.     port: 8080 
  15.     # 不允许远程管理连接,安全性考虑 
  16.     address: 127.0.0.1 

当然,如果此种方式并不适合你,还可以考虑引入spring-boot-starter-security,通过Spring Security来保证Actuator Endpoints的安全,此时再访问时就需要用户名和密码的验证了。关于Spring Security在本篇文章就不再拓展。

自定义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请求。

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

  1. @Component 
  2. @Endpoint(id = "my"
  3. public class EndpointCustom { 
  4.  
  5.    @ReadOperation 
  6.    public String endpointCustomRead(String content) { 
  7.       return "请求的内容: " + content; 
  8.    } 
  9.  
  10.    @WriteOperation 
  11.    public String endpointCustomWrite(String content) { 
  12.       return "写的内容: " + content; 
  13.    } 
  14.  
  15.    @DeleteOperation 
  16.    public String endpointCustomDelete(String content) { 
  17.       return "删除的内容: " + content; 
  18.    } 
  19.  

对应GET请求:

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

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

同样的POST请求为:

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

DELETE请求为:

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

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

小结

通过本篇我们了解了Spring Boot集成 Actuator的基本操作。集成起来非常简单,因为Spring Boot已经帮我们做了大多数的事情,我们只需要有针对性的进行配置即可。对于预定义端点无法满足业务需求的情况,还可以通过自定义的形式来实现特殊化处理。学习Actuator最重要的点在于知道它的运用场景。

本文完整源码地址:https://github.com/secbr/springboot-all/tree/master/springboot-actuator

 

责任编辑:武晓燕 来源: 程序新视界
相关推荐

2009-12-07 17:20:29

PHP stdClas

2009-10-23 15:30:53

无线接入技术

2019-10-21 15:30:54

JS技巧前端

2011-07-25 16:25:47

2010-04-21 14:56:23

Unix 线程

2010-04-27 17:06:16

AIX vmstat

2009-02-20 10:59:21

Vista帮助系统使用技巧

2009-07-01 17:58:20

JSP

2011-07-08 13:56:00

域控制器服务器

2013-04-07 10:15:34

2013-04-10 10:39:57

2024-01-26 16:28:28

C++动态内存开发

2009-12-01 11:33:03

PHP判断字符串的包含

2012-02-04 14:56:52

JP1数据中心

2012-01-10 10:05:47

文件目录访问控制UGO

2010-05-27 13:32:36

IIS服务安全认证

2011-08-23 18:30:59

MySQLTIMESTAMP

2016-10-08 12:46:08

Linux监控限制

2021-10-08 06:50:31

Volatile设计原理

2011-08-17 09:47:55

windows7搜索
点赞
收藏

51CTO技术栈公众号