Spring Boot指标监控及日志管理

我就是我 2024-02-27 03:51 35阅读 0赞

**目录**

一、添加Actuator功能

二、SpringBoot指标监控 Spring Boot Admin

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

2. 连接Spring Boot Admin项目

三、SpringBoot日志管理

--------------------

## 一、添加Actuator功能 ##

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

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

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

在配置文件中开启所有监控端点

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

**测试:**

**访问项目：[http://localhost:8080/actuator][http_localhost_8080_actuator]**

![c22bb76b97da43489877a25a355a3d20.png][]

可以看到有很多json格式的字符串，这些都是该路径下的相关资源信息，并且通过URL可以调用actuator的功能：

<table style="width:650px;"> 
 <thead> 
  <tr> 
   <th>URL</th> 
   <th>查看的数据</th> 
  </tr> 
 </thead> 
 <tbody> 
  <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>用户请求信息</td> 
  </tr> 
 </tbody> 
</table>

例如查询日志信息数据，访问[localhost:8080/actuator/loggers][localhost_8080_actuator_loggers]

![805f999a03894602a27bf409c3d64533.png][]

## 二、SpringBoot指标监控 Spring Boot Admin ##

Actuator使用JSON格式展示了大量指标数据，不利于我们查看，我们可以使用可视化工具Spring Boot Admin查看actuator生成指标数据。Spring Boot Admin是一个独立的项目，我们需要创建并运  
行该项目。

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

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

> <dependencies>  
> <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>
> 
> <dependency>  
> <groupId>org.springframework.boot</groupId>  
> <artifactId>spring-boot-starter-test</artifactId>  
> <scope>test</scope>  
> </dependency>

**修改配置文件**

因为这里是服务端项目，要监控其他项目，因此要单独设置一个端口，就为9090吧，然后再自定义一下日志格式

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

**修改启动类**

这里我们需要在启动类上方添加注解，证明这是一个指标监控服务端

package com.example.springbootadmin;
    
    import de.codecentric.boot.admin.server.config.EnableAdminServer;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    // 开启SpringBoot Admin Server端
    @EnableAdminServer
    public class SpringbootadminApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SpringbootadminApplication.class, args);
        }
    
    }

**运行项目**

![f239d6e4fe794fa7a824bee7faddecbd.png][]

这里是还没有连接项目进行指标监控的

### 2. 连接Spring Boot Admin项目 ###

同样地，被监控项目添加Spring Boot Admin客户端起步依赖

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

**修改配置文件**

> \# 应用服务 WEB 访问端口  
> server.port=8080  
> \#Spring boot admin访问地址  
> spring.boot.admin.client.url=http://localhost:9090  
> \#日志格式  
> logging.pattern.console=%d\{YYYY-MM-dd HH:mm:ss.SSS\} %clr(%-5level) --- \[%-15thread\] %cyan(%-50logger\{50\}):%msg%n

**运行项目**

此时Spring Boot Admin即可连接被监控的项目，再刷新就可以看到有实例连接成功。

![783d7b1271514d799b92404041569f8b.png][]

## 三、SpringBoot日志管理 ##

SpringBoot默认使用Logback组件作为日志管理。Logback是log4j创始人设计的一个开源日志组件。在SpringBoot项目中我们不需要额外的添加Logback的依赖，因为在 spring-boot-parent 中已经包含了Logback的依赖。

**在 /resources 下添加Logback配置文件logback.xml**

<?xml version="1.0" encoding="UTF-8" ?>
    <configuration>
        
        <property name="LOG_HOME" value="${catalina.base}/logs/"/>
    
        
        <appender name="Stdout" class="ch.qos.logback.core.ConsoleAppender">
            
            <layout class="ch.qos.logback.classic.PatternLayout">
                
                <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
                </pattern>
            </layout>
        </appender>
    
        
        <appender name="RollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>${LOG_HOME}/server.%d{yy99-MM-dd}.log</FileNamePattern>
                <MaxHistory>30</MaxHistory>
            </rollingPolicy>
            <layout class="ch.qos.logback.classic.PatternLayout">
                
                <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
                </pattern>
            </layout>
            
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                <MaxFileSize>10MB</MaxFileSize>
            </triggeringPolicy>
        </appender>
    
        
        <root level="info">
            <appender-ref ref="Stdout"/>
            <appender-ref ref="RollingFile"/>
        </root>
    </configuration>

**注：Logback配置文件名为logback-test.xml或logback.xml，如果classpath下没有这两个文件，LogBack会自动进行最小化配置。**

运行结果如下图：

![390a222ac7594e66a6f193ef118a0277.png][]

**在代码中打印日志**

package com.example.springbootdlogback.controller;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    public class PrintLogController {
    
        private final static Logger looger = LoggerFactory.getLogger(PrintLogController.class);
    
        @RequestMapping("/printlog")
        @ResponseBody
        public String showInfo(){
            looger.info("记录日志");
            return "Hello Back!";
        }
    }

如果日志过多，可以屏蔽一些包的日志，在配置文件中配置

> \#屏蔽org包中的日志输出  
> logging.level.org=off

**测试结果**

![80c7f940864b4eeeaff18678018ebf65.png][]

![8ac09adb3c0c4292bd90640f412df42c.png][]

[http_localhost_8080_actuator]: http://localhost:8080/actuator
[c22bb76b97da43489877a25a355a3d20.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/27/488b008415ff467185f766fe30d14741.png
[localhost_8080_actuator_loggers]: http://localhost:8080/actuator/loggers
[805f999a03894602a27bf409c3d64533.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/27/e0f831cf0e51464da525f5b7398bc6cf.png
[f239d6e4fe794fa7a824bee7faddecbd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/27/26d6c83812c64bb9b57e9d97d54db662.png
[783d7b1271514d799b92404041569f8b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/27/a61ca8dd1f0d4123b612a12d0f4f17f5.png
[390a222ac7594e66a6f193ef118a0277.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/27/9f36f3306df9464fbc0e143926d9d362.png
[80c7f940864b4eeeaff18678018ebf65.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/27/5b0a85e706624de6bc33968d0068d807.png
[8ac09adb3c0c4292bd90640f412df42c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/27/5b1189c165824b90a77b0b2bcd7b4847.png