11 SpringBoot指标监控

淩亂°似流年 2023-09-26 10:22 139阅读 0赞

**目录**

一、SpringBoot指标监控\_添加Actuator功能

二、SpringBoot指标监控\_Spring Boot Admin

1.创建Spring Boot Admin服务端项目

2.客户端连接Spring Boot Admin项目

三、知识点整理

> **前言：**
> 
> SpringBoot指标监控更多的是运维人员在使用，作为开发人员，知道如何使用，看一下数据即可。
> 
> 文章中的spring boot admin工具只是帮助我们更直观的显示数据，并不会生成数据，生成数据是有Actuator功能实现的。

## 一、**SpringBoot****指标监控****\_****添加****Actuator****功能**  ##

![b05d366e37814a0981f8963f1600978e.png][]

Spring Boot Actuator可以帮助程序员监控和管理SpringBoot应用，比如健康检查、内存使用情况统计、线程使用情况统计等。我们在SpringBoot项目中添加Actuator功能，即可使用Actuator监控项目，用法如下：

**1.在被监控的项目中添加Actuator起步依赖**

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

**2.在application.properties中编写配置文件**

> \#开启所有监控端点
> 
> management.endpoints.web.exposuer.include=\*

**3.访问项目：http://localhost:8080/actuator**

**4.结果显示：**

![5d154e8b36b54f7bb2fa431ea5374a8f.png][]

> 注意：这里显示的是json格式，不利于我们直观的查看数据，后面会讲一个可视化工具帮助我们直观的查看数据。

**5.通过URL可以调用actuator的功能：**

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td><strong>URL</strong></td> 
   <td><strong>查看的数据</strong></td> 
  </tr> 
  <tr> 
   <td>/env</td> 
   <td>环境属性</td> 
  </tr> 
  <tr> 
   <td>/health</td> 
   <td>健康检查</td> 
  </tr> 
  <tr> 
   <td>/mappings</td> 
   <td>显示所有的@RequestMapping路径</td> 
  </tr> 
  <tr> 
   <td>/loggers</td> 
   <td>日志</td> 
  </tr> 
  <tr> 
   <td>/info</td> 
   <td>定制信息</td> 
  </tr> 
  <tr> 
   <td>/metrics</td> 
   <td>查看内存、CPU核心等系统参数</td> 
  </tr> 
  <tr> 
   <td>/trace</td> 
   <td> <p>用户请求信息</p> </td> 
  </tr> 
 </tbody> 
</table>

例如：查询健康数据，访问 http://localhost:8080/actuator/health

查询内存，访问http://localhost:8080/actuator/metrics

## 二、**SpringBoot****指标监控****\_Spring Boot Admin** ##

![ca2398ac3500404c9de114420a15f073.png][]

Actuator使用JSON格式展示了大量指标数据，不利于我们查看，我们可以使用可视化工具Spring Boot Admin查看actuator生成指标数据。

> **注意：Spring Boot Admin是一个独立的项目，我们需要创建并运行该项目。**
> 
> Spring Boot Admin作为server服务端，被监控的客户端需要连接服务端，同时启动项目才可以。

### **1.创建****Spring Boot Admin****服务端项目** ###

**1.创建SpringBoot项目，添加SpringMVC和Spring Boot Admin服务端起步依赖**

![e652c894efcd4ad8891ae53b964c62a1.png][]

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>de.codecentric</groupId>
        <artifactId>spring-boot-admin-starter-server</artifactId>
    </dependency>

> 注意：Spring Boot Admin服务端起步依赖为“spring-boot-admin-starter-server”，不是client，server是服务端，被监控的是client客户端，需要连接服务端才能被直观的显示数据。

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

>     # 端口号
>     server.port=9090
>     #日志格式
>     loggin.pattern.console=%d{HH:mm:ss.SSS} %clr(%-5level) --- [%-15thread] %cyan(%-50logger{50}):%msg%n

> 注意：服务端的端口号不能为8080，因为客户端的端口号已经为8080了，已经占用了，所以不能为8080。

**3.修改启动类，在类上方添加@EnableAdminServer注解**

@SpringBootApplication
    @EnableAdminServer//开启springbootAdmin服务端
    public class MyspringbootadminApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(MyspringbootadminApplication.class, args);
        }
    
    }

### 2.**客户端****连接****Spring Boot Admin****项目** ###

在被监控的项目中连接 Spring Boot Admin 项目，才能使用 SpringBoot Admin查看指标数据。

**1.在被监控项目中添加Spring Boot Admin客户端起步依赖**

<dependency>
         <groupId>de.codecentric</groupId>
         <artifactId>spring-boot-admin-starter-client</artifactId>
         <version>2.6.0</version>
    </dependency>

**2.修改配置文件application.properties**

> \#Spring boot admin访问地址
> 
> spring.boot.admin.client.url=http://localhost:9090

**3.此时Spring Boot Admin即可连接被监控的项目**

**Spring Boot Admin项目和被监控项目都启动后，访问http://localhost:9090查看结果：**

![2b7df53850f14778a17f101677da0f2f.png][]

## 三、知识点整理： ##

1.在SpringBoot使用Actuator监控项目，查看系统参数的URL为**“****/metrics”**

2. 在 SpringBoot 使用 Actuator 监控项目，查看所有的 @RequestMapping  路径的 URL为**“** **/mappings** **”**

3.Spring Boot Admin服务端项目需要在启动类添加的注解为**“** **@EnableAdminServer”**

[b05d366e37814a0981f8963f1600978e.png]: https://img-blog.csdnimg.cn/b05d366e37814a0981f8963f1600978e.png
[5d154e8b36b54f7bb2fa431ea5374a8f.png]: https://img-blog.csdnimg.cn/5d154e8b36b54f7bb2fa431ea5374a8f.png
[ca2398ac3500404c9de114420a15f073.png]: https://img-blog.csdnimg.cn/ca2398ac3500404c9de114420a15f073.png
[e652c894efcd4ad8891ae53b964c62a1.png]: https://img-blog.csdnimg.cn/e652c894efcd4ad8891ae53b964c62a1.png
[2b7df53850f14778a17f101677da0f2f.png]: https://img-blog.csdnimg.cn/2b7df53850f14778a17f101677da0f2f.png