三步为你的Springboot集成Actuator监控功能

心已赠人 2023-01-09 12:42 130阅读 0赞

## 前言 ##

有时候我们想要实时监控我们的应用程序的运行状态，比如实时显示一些指标数据，观察每时每刻访问的流量，或者是我们数据库的访问状态等等。这时候就需要`Actuator`了。

使用Actuator的好处是，我们可以直接使用这个生产级别的工具，而不需要自己去实现这些东西。Actuator可以自动帮我们自动暴露出这些信息，使用HTTP或者是JMX beans的方式实现。最主要的是我们直接在properties文件中配置即可。

下面看看如何实现：

## 代码实现 ##

创建一个springboot项目，我使用的是Springboot2.4的版本。

### 第一步：添加依赖 ###

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

依赖就这么简单。

### 第二步：配置 ###

#改变应用程序的端口
    server.port=8081
    
    #1、actuator默认只开启了info和health两个端点
    #以下配置可以开启所有的端点：
    management.endpoints.web.exposure.include= *
    
    #2、开启健康监控数据
    management.endpoint.health.show-details=always
    
    #3、启用httptrace端点
    management.endpoint.httptrace.enabled=true
    
    #4、每次都要加个actuator前缀太麻烦，改变端点前缀路径
    management.endpoints.web.base-path= /

这么增加了几个配置。

现在我们直接访问就可以了。

### 第三步：直接访问 ###

由于在前面我们配置了自己的base-path。所以不需要增加actuator的前缀。现在访问：

http://localhost:8081/mappings

![06e68621b2214b235492e5684bd84758.png][]

我们访问就会出现这样的画面，看着有点难看，不过有了这些信息，还可以格式化显示，目前也有很多开源的项目可以自动实现。

其他的端口如下：可以把上面的地址的mappings改变一下就可以了。

<table> 
 <thead> 
  <tr> 
   <th>EndPoints</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>auditevents</td> 
   <td>公开当前应用程序的审核事件信息。</td> 
  </tr> 
  <tr> 
   <td>beans</td> 
   <td>显示应用程序中所有Spring bean的完整列表。</td> 
  </tr> 
  <tr> 
   <td>caches</td> 
   <td>暴露可用的缓存。</td> 
  </tr> 
  <tr> 
   <td>conditions</td> 
   <td>显示在配置和自动配置类上评估的条件以及它们匹配或不匹配的原因。</td> 
  </tr> 
  <tr> 
   <td>configprops</td> 
   <td>显示所有的整理列表@ConfigurationProperties,查看配置属性，包括默认配置</td> 
  </tr> 
  <tr> 
   <td>env</td> 
   <td>露出Spring的属性的各种环境变量,后面可跟/{name}查看具体的值</td> 
  </tr> 
  <tr> 
   <td>flyway</td> 
   <td>显示已应用的任何Flyway数据库迁移。</td> 
  </tr> 
  <tr> 
   <td>health</td> 
   <td>显示应用健康信息,2.0以后需要在配置里show-details打开k开关</td> 
  </tr> 
  <tr> 
   <td>httptrace</td> 
   <td>显示HTTP跟踪信息,2.0以后需要手动打开</td> 
  </tr> 
  <tr> 
   <td>info</td> 
   <td>显示任意应用信息,是在配置文件里自己定义的</td> 
  </tr> 
  <tr> 
   <td>integrationgraph</td> 
   <td>显示Spring Integration图。</td> 
  </tr> 
  <tr> 
   <td>loggers</td> 
   <td>显示和修改应用程序中记录器的配置。</td> 
  </tr> 
  <tr> 
   <td>liquibase</td> 
   <td>显示已应用的任何Liquibase数据库迁移。</td> 
  </tr> 
  <tr> 
   <td>metrics</td> 
   <td>显示指标信息,比如内存用量和HTTP请求计数,后可跟/{name}查看具体值</td> 
  </tr> 
  <tr> 
   <td>mappings</td> 
   <td>显示所有@RequestMapping路径的整理列表。</td> 
  </tr> 
  <tr> 
   <td>scheduledtasks</td> 
   <td>显示应用程序中的计划任务。</td> 
  </tr> 
  <tr> 
   <td>sessions</td> 
   <td>允许从Spring Session支持的会话存储中检索和删除用户会话。</td> 
  </tr> 
  <tr> 
   <td>shutdown</td> 
   <td>允许应用程序正常关闭。</td> 
  </tr> 
  <tr> 
   <td>threaddump</td> 
   <td>执行线程转储。</td> 
  </tr> 
 </tbody> 
</table>

OK。基本上是这样。

## 为Actuator添加安全验证 ##

比如我们的Actuator的端口不想被无关人员看到，于是就可以配置Spring security添加登录。方式如下：

### 第一步：添加依赖 ###

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>

### 第二步：在properties文件中添加配置 ###

#5、端口信息被别人看到了咋办，可以添加个security
    spring.security.user.name= fdd
    spring.security.user.password= 123456
    spring.security.user.roles= ADMIN

这里设置的用户面是fdd，密码123456，角色是ADMIN。

### 第三步：重新访问上面的端口地址 ###

![e61075d915e91d99244dd30bfcbe4f97.png][]

重新访问相关端口地址，就会被重定向到登录页面。使用配置好的用户名密码登录即可。

OK，这个比较简单。

[06e68621b2214b235492e5684bd84758.png]: /images/20221119/16949f69679647f4b0839ec62fff6dda.png
[e61075d915e91d99244dd30bfcbe4f97.png]: https://img-blog.csdnimg.cn/img_convert/e61075d915e91d99244dd30bfcbe4f97.png