Spring Boot 监控和管理生产环境

傷城~ 2022-06-16 07:16 140阅读 0赞

在生产环境中，需要实时或定期监控服务的可用性。[spring][]\-boot 的actuator（监控）功能提供了很多监控所需的接口。简单的配置和使用如下：

1、引入依赖：

**\[html\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

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

如果使用http调用的方式，还需要这个依赖：

**\[html\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

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

2、配置：

application.yml中指定监控的HTTP端口（如果不指定，则使用和server相同的端口）；指定去掉某项的检查（比如不监控health.mail）：

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  server:  
2.    port: 8082  
3.  management:  
4.    port: 54001  
5.    health:  
6.      mail:  
7.        enabled: false

3、使用：

查看health指标：http://localhost:54001/health

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  \{"status":"UP","diskSpace":\{"status":"UP","total":120031539200,"free":33554337792,"threshold":10485760\},"db":\{"status":"UP","dataSource1":\{"status":"UP","database":"MySQL","hello":1\},"dataSource2":\{"status":"UP","database":"MySQL","hello":1\}\}\}

4、自定义指标：  
4.1 /health：在某个类中implements HealthIndicator接口，然后实现其中的health()方法即可：

代码：

**\[java\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  @SpringBootApplication  
2.  @EnableScheduling  
3.  **public** **class** MySpringBootApplication **implements** HealthIndicator\{  
4.      **private** **static** Logger logger = LoggerFactory.getLogger(MySpringBootApplication.**class**);  
5.        
6.      **public** **static** **void** main(String\[\] args) \{  
7.          SpringApplication.run(MySpringBootApplication.**class**, args);  
8.          logger.info("My Spring Boot Application Started");  
9.      \}  
10.   
11.     /\*\* 
12.      \* 在/health接口调用的时候，返回多一个属性："mySpringBootApplication":\{"status":"UP","hello":"world"\} 
13.      \*/  
14.     @Override  
15.     **public** Health health() \{  
16.         **return** Health.up().withDetail("hello", "world").build();  
17.     \}  
18. \}

/health 运行结果（注意第二个指标）：

{"status":"UP","mySpringBootApplication":{"status":"UP","hello":"world"},"diskSpace":{"status":"UP","total":120031539200,"free":33554337792,"threshold":10485760},"db":{"status":"UP","dataSource1":{"status":"UP","database":"MySQL","hello":1},"dataSource2":{"status":"UP","database":"MySQL","hello":1}}}

4.2 /info：配置如下，可以直接给一个字符串，也可以从pom.xml配置中获取

**\[plain\]**  [view plain][]   [copy][view plain]

[![在CODE上查看代码片][CODE]][CODE_CODE] [![派生到我的代码片][ico_fork.svg]][ico_fork.svg 1]

1.  info:  
2.    app:  
3.      name: "@project.name@" \#从pom.xml中获取  
4.      description: "@project.description@"  
5.      version: "@project.version@"  
6.      spring-boot-version: "@project.parent.version@"

/info的结果如下：

{"app":{"name":"my-spring-boot","description":"Test Project for Spring Boot","version":"1.0","spring-boot-version":"1.3.6.RELEASE"}}

官网：http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/\#production-ready

源代码参考：[https://github.com/xujijun/my-spring-boot][https_github.com_xujijun_my-spring-boot]

转载：转自Clement-Xu的csdn博客。http://blog.csdn.net/clementad/article/details/52045495

[spring]: http://lib.csdn.net/base/javaee
[view plain]: http://blog.csdn.net/clementad/article/details/52045495#
[CODE]: https://code.csdn.net/assets/CODE_ico.png
[CODE_CODE]: https://code.csdn.net/snippets/1787311
[ico_fork.svg]: https://code.csdn.net/assets/ico_fork.svg
[ico_fork.svg 1]: https://code.csdn.net/snippets/1787311/fork
[https_github.com_xujijun_my-spring-boot]: https://github.com/xujijun/my-spring-boot