一、Spring boot监控
1 spring boot Actuator
1.1 集成Actuator
-
SpringBoot自带监控功能Actuator,可以帮助实现对程序内部运行情况监控,比如监控状况、Bean加载情况、配置属性、日志信息等。
-
在项目中集成
Actuator
- pom导入依赖
<!--actuator--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
-
配置属性
- 开启全部监控
# 将所有的监控endpoint暴露出来 management: endpoints: jmx: exposure: include: '*'
- 开启部分监控
# 将所有的监控endpoint暴露出来 management: endpoints: jmx: exposure: include: ["health","info","beans"]
- 排查不开启的部分
# 将所有的监控endpoint暴露出来 management: endpoints: jmx: exposure: exclude=["health","info","beans"]
-
启动项目,访问:
访问路径:http://localhost:port/actuator/health 访问结果:{"status":"UP"}
1.2 遇到异常:
- 异常报错:
Caused by: org.yaml.snakeyaml.scanner.ScannerException: while scanning an alias
in 'reader', line 38, column 18:
include: *
^
- 异常分析:
- 根据报错,可以判断出,异常在yml配置文件,根据提示的代码片段,很快遍能够锁定
- 异常代码:
# 将所有的监控endpoint暴露出来
management:
endpoints:
jmx:
exposure:
include: *
- 异常原因:* 应该用’'引起来
1.3 Actuator常用路径
/beans
:描述应用程序上下文里全部的bean,以及他们的关系;/env
:获取全部环境属性/env/{name}
:根据名称获取特定的环境属性值;/health
:报告应用程序的健康指标,这些值由HealthIndicator的实现类提供/info
:获取应用程序的定制信息,这些信息由info打头的属性提供/mappings
:描述全部的URI路径,以及他们和控制器的映射关系/metrics
:报告各种应用程序度量信息,比如内存用量和HTTP请求计数/metrics/{name}
:报告指定名称的应用程序度量值/trace
:提供基本的HTTP请求跟踪信息(时间戳、HTTP头等)
2. Spring Boot Admin
2.1 概述
- Spring Boot Admin是一个开源项目,用于管理和监控Spring Boot应用程序
- Spring Boot有两个角色:客户端和服务端
- 应用程序作为Spring Boot Admin Client向Spring Boot Admin Server注册
- Actuator接口指向服务端的地址,定时读取相关信息达到监控的目的;
- 监控范围:Health、内存信息、JVM信息、垃圾回收信息、各种配置信息(数据源、缓存列表、命中率等)
2.2 集成Spring Boot Admin
-
server端
- pom:导入
spring-boot-admin-starter-server
<dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-server</artifactId> </dependency>
- 配置属性:配置端口号
server: port: 9000
- pom:导入
-
client端
- pom:
spring-boot-admin-starter-client
<dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-client</artifactId> </dependency>
- 配置属性:客户端地址指向服务端,暴露所有接口
spring: boot: admin: client: url: http://localhost:9000 # 将所有的监控endpoint暴露出来 management: endpoints: jmx: exposure: include: '*'
- pom:
-
测试:访问server
二、logback
1. logback介绍
- 概述:Logback是SpringBoot内置的日志处理框架,spring-boot-starter其中包含了spring-boot-starter-logging,该依赖内容就是 Spring Boot 默认的日志框架logback。Logback是由log4j创始人设计的另一个开源日志组件,一共分为三个模块:
logback-core
:基础模块logback-classic
:是log4j的一个改良版本,同时也实现了slf4j API使你可以很方便地更换成其他日志系统,如:log4j、JDK14Logging;logback-access
:访问模块与Servlet容器集成提供HTTP来访问日志的功能;
- 级别排序为:TRACE < DEBUG < INFO < WARN < ERROR
2. logback相比log4j优势
- 实现起来更快:Logback内核重写了;disruptor技术,在多线程环境下,性能高于logback等10倍以上;利用jdk1.5并发的特性,减少了死锁的发生;而且Logback不仅性能提升了,初始化内存加载也更小了;
- 自动加载配置文件:当配置文件修改时,Logback-classic能自动重新加载配置文件。扫描过程快且安全;并不需要另外创建一个扫描线程;
- 堆栈树带有包版本:Logback在打出堆栈树日志时,会带上包的数据;。
3. 浅析Logback
3.1 spring 默认配置
当我们新建一个springboot项目,还未集成日志配置,这时控制台还是会有相关的日志打印;因为SpringBoot为Logback提供了默认的配置文件base.xml,base.xml文件里定义了默认的root输出级别为INFO。
<?xml version="1.0" encoding="UTF-8"?>
<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->
<included>
<include resource="org/springframework/boot/logging/logback/defaults.xml" />
<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</included>
3.2 自定义Logback配置
Spring Boot官方推荐优先使用带有-spring的文件名作为日志配置,如logback-spring.xml
;
-
根节点
<configuration>
:<configuration scan="true" scanPeriod="60 seconds" debug="false"> <!-- 其他配置省略--> </configuration>
scan
:true:配置文件如果发生改变,将会被重新加载,默认为truescanPeriod
:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认是毫秒。- true:属性生效,默认间隔为1分钟
debug
:- true:打印logback内部日志信息,实时查看logback运行状态,默认为false
-
<properpy>
- 作用:用来定义变量值的标签,< property> 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值,通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来获取变量。
- 如下,获取时${PATH}
<!--日志文件存放路径--> <property name="PATH" value="/var/logs"/>
- 注:多环境配置下,通过 application.yml 传递参数过来,< property >取不到环境参数,得用< springProperty >
<springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="springBoot"/>
-
子节点:
<appender>
- 作用:用来格式化日志输出节点,有两个属性,name、class;class用来指定输出策略;常用输出策略是控制台输出策略和文件输出策略
ConsoleAppender
:控制台输出配置FileAppender
:用于配置将日志信息输出到文件中,子标签:append、encoder、fileRollingFileAppender
:继承与FileAppender类,能够动态创建一个文件;即满足一个条件则会创建文件,再将日志写入到新文件中;有两个重要的标签与之交互:RollingPolicy、TriggerPolicy;主要子标签:file、append、rollingPolicy、triggerPolicy
<!-- 彩色日志格式 --> <property name="CONSOLE_LOG_PATTERN" value="${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(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/> <!-- 控制台输出配置--> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <!--日志输出格式--> <layout class="ch.qos.logback.classic.PatternLayout"> <pattern> ${CONSOLE_LOG_PATTERN} </pattern> </layout> </appender>
<File>
:用于指定文件。如果上级目录不存在会自动创建,没有默认值。
<!--当天日志文件名--> <File>${PATH}/info.log</File>
<layout>
和<encoder>
- 作用:输出到控制台,
- layout和encoder都可以输出,都可以将事件转换为格式化后的日志记录,但是控制台输出使用layout,文件输出使用encoder。自从0.9.19版本之后,Fileappender和他的子类是期望使用encoder,不再使用layout。
<!--输出到控制台 ConsoleAppender--> <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender"> <layout> <pattern>${FILE_LOG_PATTERN}</pattern> </layout> </appender> <!--输出到控制台 ConsoleAppender--> <appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d -2 %msg%n</pattern> </encoder> </appender> <!--设置项目日志输出级别为INFO--> <root level="INFO"> <appender-ref ref="consoleLog1"/> <appender-ref ref="consoleLog2"/> </root>
-
filter
- logback具有过滤器支持。logbcak允许给日志记录器appender配置一个或多个Filter(或者给整体配置一个或多个TurboFilter),来控制:当满足过滤器指定的条件时,才记录日志(或不满足条件时,拒绝记录日志)。logback支持自定义过滤器;
- logback提供的过滤器支持主要分两大类:
ch.qos.logback.core.filter.Filter ch.qos.logback.classic.turbo.TurboFilter
- 常用过滤类
LevelFilter
:继承自Filter,对指定level的日志进行记录(或不记录),对不等于指定level的日志不记录(或进行记录);ThresholdFilter
:继承自Filter,对大于或等于指定level的日志进行记录(或不记录),对小于指定level的日志不记录(或进行记录) 提示:info级别是大于debug的;EvaluatorFilter
:继承自Filter对满足指定表达式的日志进行记录(或不记录),对不满足指定表达式的日志不作记录(或进行记录);MDCFilter
:继承自TurboFilter,若MDC域中存在指定的key-value,则进行记录,否者不作记录;DuplicateMessageFilter
:继承自TurboFilter,根据配置不记录多余的重复的日志;MarkerFilter
:继承自TurboFilter,针对带有指定标记的日志,进行记录(或不作记录);
- TurboFilter的性能是优于Filter的,这是因为TurboFilter的作用时机是在创建日志事件ILoggingEvent对象之前,而Filter的作用时机是在创建之后;
levelFilter
,按日志级别记录
<!--按级别过滤日志,只输出 INFO 级别--> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter>
- 有三个值:
DENY
:表示不用看后面的过滤器了,这里就给拒绝了,不作记录。NEUTRAL
:表示需不需要记录,还需要看后面的过滤器。若所有过滤器返回的全部都是NEUTRAL,那么需要记录日志。ACCEPT
:表示不用看后面的过滤器了,这里就给直接同意了,需要记录。
-
rollingPolicy
-
TimeBasedRollingPolicy:它根据时间来制定滚动策略,时间滚动策略可以基于时间滚动按时间生成日志。
<!--按天分割日志文件--> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!--历史日志文件名规则--> <fileNamePattern>${PATH}/info.log.%d{yyyy-MM-dd}.%i</fileNamePattern> <!--按大小分割同一天的日志--> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天数--> <maxHistory>30</maxHistory> </rollingPolicy>
-
- 作用:用来格式化日志输出节点,有两个属性,name、class;class用来指定输出策略;常用输出策略是控制台输出策略和文件输出策略
-
完整的日志配置文件示例:
<configuration>
<!-- 日志文件存放路径-->
<property name="PATH" value="/var/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="${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(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!-- 文件日志格式 -->
<property name="FILE_LOG_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%msg%n"/>
<!-- 控制台输出配置-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--日志输出格式-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>
${CONSOLE_LOG_PATTERN}
</pattern>
</layout>
</appender>
<!-- INFO 级别日志文件输出配置-->
<appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--按级别过滤日志,只输出 INFO 级别-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<!--当天日志文件名-->
<File>${PATH}/info.log</File>
<!--按天分割日志文件-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--历史日志文件名规则-->
<fileNamePattern>${PATH}/info.log.%d{yyyy-MM-dd}.%i</fileNamePattern>
<!--按大小分割同一天的日志-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>30</maxHistory>
</rollingPolicy>
<!--日志输出格式:设置为文件输出格式-->
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>${FILE_LOG_PATTERN}</Pattern>
</layout>
</appender>
<!-- ERROR 级别日志文件输出配置-->
<appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--按级别过滤日志,只输出 ERROR 及以上级别-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<!--当天日志文件名-->
<File>${PATH}/error.log</File>
<!--按天分割日志文件-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--历史日志文件名规则-->
<fileNamePattern>${PATH}/error.log.%d{yyyy-MM-dd}.%i</fileNamePattern>
<!--按大小分割同一天的日志-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>30</maxHistory>
</rollingPolicy>
<!--日志输出格式-->
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>${FILE_LOG_PATTERN}</Pattern>
</layout>
</appender>
<!--日志级别-->
<root level="info">
<appender-ref ref="console"/>
<appender-ref ref="info"/>
<appender-ref ref="error"/>
</root>
- controller测试
@Api
@Slf4j
@RestController
@RequestMapping("/log")
public class LogController {
@GetMapping("/debug")
public void debug() {
log.debug("日志等级:debug");
}
@GetMapping("/info")
public void info() {
Exception e = new Exception();
log.info("日志等级:info");
log.error("错误:{}", e.getMessage());
log.error("错误:{}", e.getMessage(), e);
e.printStackTrace();
}
@GetMapping("/warn")
public void warn() {
log.warn("日志等级:warn");
}
@GetMapping("/error")
public void error() {
log.error("日志等级:error");
}
}