SpringCloud监控

桃扇骨 2024-04-18 20:19 30阅读 0赞

> ![640?wx\_fmt=gif][640_wx_fmt_gif]
> 
> 学习更多Java干货，戳上面的
> 
> 蓝色字题
> 
> 关注我！
> 
> 今天我们来学习一下actuator这个组件，它不是SpringCloud之后才有的，而是SpringBoot的一个starter，Spring Boot Actuator。我们使用SpringCloud的时候需要使用这个组件对应用程序进行监控与管理  
>

在SpringBoot2.0版本中，actuator可以为我们提供以下端点：

<table> 
 <thead> 
 <tr> 
 <th>访问路径</th> 
 <th>描述</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>/actuator/auditevents</td> 
 <td>显示当前应用程序的审计事件信息</td> 
 </tr> 
 <tr> 
 <td>/actuator/beans</td> 
 <td>显示一个应用中所有Spring Beans的完整列表</td> 
 </tr> 
 <tr> 
 <td>/actuator/conditions</td> 
 <td>显示配置类和自动配置类的状态及它们被应用或未被应用的原因</td> 
 </tr> 
 <tr> 
 <td>/actuator/configprops</td> 
 <td>显示一个所有@ConfigurationProperties的集合列表</td> 
 </tr> 
 <tr> 
 <td>/actuator/env</td> 
 <td>显示来自Spring的 ConfigurableEnvironment的属性</td> 
 </tr> 
 <tr> 
 <td>/actuator/features</td> 
 <td>显示系统启动的一些features</td> 
 </tr> 
 <tr> 
 <td>/actuator/health</td> 
 <td>显示应用的健康信息</td> 
 </tr> 
 <tr> 
 <td>/actuator/httptrace</td> 
 <td>最后100个HTTP请求</td> 
 </tr> 
 <tr> 
 <td>/actuator/info</td> 
 <td>显示任意的应用信息</td> 
 </tr> 
 <tr> 
 <td>/actuator/metrics</td> 
 <td>展示当前应用的metrics信息</td> 
 </tr> 
 <tr> 
 <td>/actuator/mappings</td> 
 <td>显示一个所有@RequestMapping路径的集合列表</td> 
 </tr> 
 <tr> 
 <td>/actuator/refresh</td> 
 <td>更新配置</td> 
 </tr> 
 <tr> 
 <td>/actuator/scheduledtasks</td> 
 <td>显示应用程序中的定时任务</td> 
 </tr> 
 <tr> 
 <td>/actuator/service-registry</td> 
 <td>当前应用在注册中心的状态</td> 
 </tr> 
 <tr> 
 <td>/actuator/shutdown</td> 
 <td>允许应用以优雅的方式关闭</td> 
 </tr> 
 <tr> 
 <td>/actuator/threaddump</td> 
 <td>执行一个线程dump</td> 
 </tr> 
 <tr> 
 <td>/actuator/heapdump</td> 
 <td>返回一个GZip压缩的hprof堆dump文件</td> 
 </tr> 
 <tr> 
 <td>/actuator/loggers</td> 
 <td>返回系统的一些日志</td> 
 </tr> 
 </tbody> 
</table>

虽然actuator默认给我们提供了这么多的端点供我们使用，但是为了安全起见，在SpringBoot2.0中它仅仅开放了health和info两个端口，如果想要使用其他的端口就需要我们增加一些配置了，一起来看一下如何使用actuator吧。

#### 1. 引入依赖 ####

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 </pre></td> 
 <td><pre>&lt;dependency&gt; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;artifactId&gt;spring-boot-starter-actuator&lt;/artifactId&gt; &nbsp; &nbsp; &nbsp; &lt;/dependency&gt; </pre></td> 
 </tr> 
 </tbody> 
</table>

#### 2. 修改配置文件 ####

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 </pre></td> 
 <td><pre>management: &nbsp;endpoints: &nbsp; &nbsp;web: &nbsp; &nbsp; &nbsp;exposure: &nbsp; &nbsp; &nbsp; &nbsp;#exclude: shutdown,threaddump &nbsp; #此处控制的是不开放哪些端点 &nbsp; &nbsp; &nbsp; &nbsp;include: "*" #此处控制的是开放哪些端点，如果需要开启少数端点可以这样配置：health,info。如果开启多个则使用*号开启除了exclude的端点 </pre></td> 
 </tr> 
 </tbody> 
</table>

这个时候我们使用postman等接口调用工具访问 ip:端口/actuator 这个路径时就会得到下图所示的这么一个json串，这个json串中就是对应的各个端点的地址信息。  
![640?wx\_fmt=png][640_wx_fmt_png]

#### 3. 健康检查 ####

默认我们访问/actuator/health得到的只是一个状态值，其实它的详细信息里包含了很多有用的东西，比如说检查磁盘空间、DataSource的连接、Elasticsearch、Mongo、Rabbit、Redis等信息，我们可以通过如下配置来开启详细的健康检查：

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 </pre></td> 
 <td><pre>management: &nbsp;endpoint: &nbsp; &nbsp;health: &nbsp; &nbsp; &nbsp;show-details: always </pre></td> 
 </tr> 
 </tbody> 
</table>

不仅如此，健康检查的指标我们还可以自定义，创建如下的一个bean提供健康检查的功能。

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 8 9 10 11 12 </pre></td> 
 <td><pre>@Component public class ConnectTimeHealthIndicator implements HealthIndicator {
 &nbsp; &nbsp;@Override &nbsp; &nbsp;public Health health() {
 &nbsp; &nbsp; &nbsp; &nbsp;long connectTime=(long)Math.random()*10;//模拟一个连接操作 &nbsp; &nbsp; &nbsp; &nbsp;if(connectTime&gt;3){
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;//如果连接时间大于3则认为连接失败，返回状态为down &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;return Health.down().withDetail("code", "504").withDetail("msg","xx应用连接超时").build(); &nbsp; &nbsp; &nbsp; &nbsp;} &nbsp; &nbsp; &nbsp; &nbsp;return Health.up().build(); &nbsp; &nbsp;} } </pre></td> 
 </tr> 
 </tbody> 
</table>

此时我们访问 ip:端口/actuator/health 访问时可能就会根据连接时间呈现下方的两种状态  
![640?wx\_fmt=png][640_wx_fmt_png 1]  
![640?wx\_fmt=png][640_wx_fmt_png 2]

点击下方“阅读原文”查看源码！！！

![640?wx\_fmt=gif][640_wx_fmt_gif 1]

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg]

点赞收藏转发好看再走呗!

![640?wx\_fmt=gif][640_wx_fmt_gif 2]

[640_wx_fmt_gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/342d924d55274e28a5803895181f3760.gif
[640_wx_fmt_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/326ac55c3bb940f3b7bbe5d3021c1349.png
[640_wx_fmt_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/c7cc36308988458a955764a4f6f37954.png
[640_wx_fmt_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/6d2f778519ba4f9c965991ff51d67922.png
[640_wx_fmt_gif 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/2fbaf74671e84f74bb28dc0d433deecd.gif
[640_wx_fmt_jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/d0637e9d0e8645419c529d982902dea4.png
[640_wx_fmt_gif 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/fe7df5acdbea4ec1835a6524d6855347.gif