用Spring Boot Admin搭建监控系统的效果:SBA效果
Spring Boot Admin 提供了本地日志实时采集、动态更新到页面端的接口。本文将利用logback+slf4j框架组合对Spring Boot项目进行日志采集、本地持久化,然后配置本地日志路径实时更新到Spring Boot Admin端,那么就可以在监控的同时也能看到日志数据了(假如崩了就可以知道异常是何)。
为什么要用日志系统呢?
上文SBA效果说到日志系统是为了方便我们运维人员在故障排查时快速定位用的,采集程序运行产生的信息通过特定的输出格式和日志级别写入日志文件中。简而言之,日志系统就是我们平时写程序用的System.out.println()将变量或者状态输出来观察运行情况或者定位错误,日志系统就是其高级版本,可以设置输出样式,避免自己每次都写"ERROR: " + var;可以设置输出级别,禁止某些级别输出,例如,只输出错误日志;可以被重定向到文件,这样可以在程序运行结束后查看日志;可以按包名控制日志级别,只输出某些包打的日志......
logback+slf4j是什么?
logback是一个日志采集系统的实现;slf4j是日志系统的接口,如同jdbc一样定义了一套接口,是一个日志门面可实现多个日志系统间快速切换。
logback基础功能包含三个组成部分:Loggers(日志记录器)、Layouts(日志输出格式)、Appenders(输出目的在)
logback 主要分为三个模块,分别是:
logback-core:提供基础功能,是其他两个模块的基础
logback-classic : log4j的升级,实现了self4j api
logback-access:用于与sevlet容器进行集成、提供网络访问日志的功能
Commons Logging+Log4j不香吗?
Commons Logging+Log4j相较于logback+slf4j也是日志系统的实现组合,其诞生时间较早但其在多个方面能力有限因此被开源社区淘汰。后者优点:
- 运行速度快
- 日志文件定期压缩归档并清理过期文件
- Logback拥有远比log4j更丰富的过滤能力。
- Logback-access模块,提供了通过HTTP访问日志的能力。
Spring Boot Admin 配置上logback+slf4j
- 配置上logback+slf4j的依赖
在pom.xml文件中加上slf4j的依赖:
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
为了方便logback的依赖就和相应的配置放在一起了,需要在和application.properties同级的文件夹(Spring Initializr创建的项目都有一个优先访问的resouces文件夹来存放配置文件,避免不同文件结构下配置文件访问受阻的现象)下创建一个logback-spring.xml文件,填入以下内容(可改):
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="APP_Name" value="adminTest" />
<contextName>${APP_Name}</contextName>
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径,请根据需求配置路径-->
<property name="LOG_HOME" value="E:/data/adminTest/logs" />
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN"
value="adminTest >> ${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(LN:%L){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
<charset>utf8</charset>
</encoder>
</appender>
<!-- 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_HOME}/test.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/test-%d{yyyy-MM-dd}.log</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}:%L - %msg%n</pattern>
</encoder>
</appender>
<!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="WARN" />
<logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="WARN" />
<logger name="org.hibernate.SQL" level="WARN" />
<logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
<logger name="org.hibernate.engine.query.HQLQueryPlan" level="WARN" />
<!--myibatis log configure-->
<logger name="com.apache.ibatis" level="WARN"/>
<logger name="java.sql.Connection" level="WARN"/>
<logger name="java.sql.Statement" level="WARN"/>
<logger name="java.sql.PreparedStatement" level="WARN"/>
<logger name="org.apache.shiro" level="WARN"/>
<logger name="springfox.documentation" level="WARN"/>
<!-- 日志输出级别 ,注意:如果不写<appender-ref ref="FILE" /> ,将导致springbootadmin找不到文件,无法查看日志 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE" />
</root>
</configuration>
在其中需要比较注意的是日志文件所在和日志文件名,后面SBA采集需要用到,这里就设置为test.log。
我们可以对特定的日志内容进行格式化,其中对mybatis的输出日志进行制定格式,如果有特别需要也可以查看文档配置。在日志输出上可以配置一个日志级别,日志级别分为7级INFO是最低级严重性也是最低的(INFO就是正常),logback会将该级别及以上级别的日志采集到日志文件中,具体看实际生产需要调整。
- 配置完logback和slf4j后我们开启服务便会执行日志采集工作,然后依照日志级别的要求记录到日志文件中进行持久化操作,我们想要在SBA端实时看到这些日志信息,我们需要在application.yml(项目配置文件)中注明日志文件的路径及名字:
logging:
file:
name: E:/data/adminTest/logs/test.log
-
启动SBA server端看看结果
日志内容
日志级别
日志级别使用来标识日志记录的严重性,通过指定日志级别可以过滤掉大量的程序运行信息,并且从严重的级别进行排查可以更快找到异常所在,日志级别在不同的日志系统中会有不同的分级。
slf4j的日志级别分为五种(严重性递增分数增加)
trace、debug、info、warn、error
trace: 一般不会使用,在日志里边也不会打印出来,是最低的一个日志级别。
debug: 一般放于程序的某个关键点的地方,用于打印一个变量值或者一个方法返回的信息之类的信息
info 一般处理业务逻辑的时候使用,就跟 system.err打印一样,用于说明此处是干什么的。slf4j使用的时候是可以动态的传参的,使用占位符 {} 。后边一次加参数,会挨个对应进去。
warn:警告,不会影响程序的运行,但是值得注意。
error: 用户程序报错,必须解决的时候使用此级别打印日志。