logback是有log4j 创始人设计的又一个开源日志框架
logback 当前分为三个模块:logbakc-core,logback-classic 和 logback-access
- logback-core:是其他两个模块的基础模块
- logback-classic:是log4j的一个改良版本。此外logback-classic 完整实现SLF4J API,所以可以很方便的更换成其他日志系统,如 log4j 或 JDK14 Logging
- logback-access:访问模块与Servlet容器基础,提供通过http访问日志的功能。
maven:
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.7</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.1.7</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-access</artifactId>
<version>1.1.7</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.7</version>
</dependency>
logback, 一个“通用,可靠,快速又灵活的Java日志框架”
在src目录下建立logback.xml
logback查找顺序:
- 首先会试着查找logback.groovy文件
- 当没有找到时,继续试着查找 logback-test.xml 文件
- 当没有找到时,继续试着查找 logback.xml 文件
- 如果仍然没有找到,则使用默认配置(打印到控制台)
自定义日志配置
根据不同的日志系统,可以按照如下规则组织配置文件名,就可以被正确加载:
Logback:logback-spring.xml,logback-spring.groovy,logback.xml,logback.groovy
Log4j: log4J-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2: log4j2-spring.xml, log4j2.xml
JDK(Java Util Logging): logging.properties
Spring Boot 官方推荐优先使用带有-spring的文件名作为你的日志配置(如使用logback-spring.xml,而不是logback.xml), 命名为logback-spring.xml 的日志配置文件,spring boot 可以为它添加一些spring boot特有的配置项。
默认的命名规则,并且放在 src/main/resources 下面即可
如果你不想用 logback.xml 作为 logback 配置的名字,application.yml 可以通过 logging.config 属性指定自定义的名字:
logging.config=classpath:logging-config.xml
虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行是profile使用不同的配置,这个功能会很有用。
一般不需要这个属性,而是直接在 logback-spring.xml 中使用 springProfile配置,不需要logging.config 指定不同环境使用不同配置文件。
上代码:
package logback;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogbackDemo {
private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);
public static void main(String[] args) {
log.trace("======trace");
log.debug("======debug");
log.info("======info");
log.warn("======warn");
log.error("======error");
String name = "Aub";
String message = "3Q";
String[] fruits = { "apple", "banana" };
// logback提供的可以使用变量的打印方式,结果为"Hello,Aub!"
log.info("Hello,{}!", name);
// 可以有多个参数,结果为“Hello,Aub! 3Q!”
log.info("Hello,{}! {}!", name, message);
// 可以传入一个数组,结果为"Fruit: apple,banana"
log.info("Fruit: {},{}", fruits);
}
}
configuration
- 根节点 configuration 包含的属性:
- scan:
此属性设置为true,配置文件如果发生改变,将会被重新加载,默认为true - scanPeriod:
设置监测配置文件是否有修改的时间间隔,如果没有给出事件单位,默认单位是毫秒。当scan为true时,此属性默认生效。默认的时间将为1分钟。 - debug:
此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认为false。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 其他配置省略-->
</configuration>
- 根节点 configuration 的子节点:
- contextName
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。可以通过%contextName来打印日志上下文名称,一般来说我们不用这个属性,可有可无.
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
<!-- 其他配置省略-->
</configuration>
- property
用来定义变量值的标签,property 有两个属性,name和value;通过property定义的值会被插入到 logger上下文中。定义变量后,可以使用 ${} l来使用变量。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<property name="APP_Name" value="myAppName" />
<contextName>${APP_Name}</contextName>
<!-- 其他配置省略-->
<!-- 系统日志输出 -->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${APP_Name}/boss.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 按天回滚 daily -->
<fileNamePattern>${APP_Name}/boss.%d{yyyy-MM-dd}.log</fileNamePattern>
<!-- 日志最大的历史 30天 -->
<maxHistory>60</maxHistory>
<!--用来指定日志文件的上限大小,那么到了这个值,就会删除旧的日志-->
<!--<totalSizeCap>1GB</totalSizeCap>-->
</rollingPolicy>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{80} - %msg%n</pattern>
</encoder>
</appender>
</configuration>
- timestamp
两个属性:- key:标识此 timestamp 的名字
- datePattern: 设置将当前时间转换为字符串的模式,遵循 java.txt.SimpleDateFormat 的格式。
例如:
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
<contextName>${bySecond}</contextName>
<!-- 其他配置省略-->
</configuration>
- logger
用来设置某一个包或者具体的某一个类的日志打印级别,以及指定 appender.
包含的属性:- name:
用来指定受此logger约束的某一个包或者具体的某一个类。 - level:
用来设置打印级别,大小写无关:TRACE,DEBUG,INFO,WARN,ERROR,ALL和OFF,还有一个特殊值 INHERITED 或者同义词NULL,代码强制执行上级的级别。
如果未设置此属性,那么当前logger将会继承上级的打印级别。 - additivity:
是否向上级logger传递打印信息。默认是true。
logger可以包含零个或多个 appender-ref 元素,标识这个 appender 将会添加到这个 lgger
- name:
- root
也是logger元素,但是它是根logger。只有一个level属性,因为已经被命名为“root”- level
用来设置打印级别,大小写无关,默认是debug
root 可以包含多个 appender-ref 元素,标识这个appender将会添加到这个 logger
例如:
- level
package logback;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LogbackDemo {
private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);
public static void main(String[] args) {
log.trace("======trace");
log.debug("======debug");
log.info("======info");
log.warn("======warn");
log.error("======error");
}
}
logback.xml 配置文件:
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- encoder 默认配置为PatternLayoutEncoder -->
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<!-- logback为java中的包 -->
<logger name="logback"/>
<!--logback.LogbackDemo:类的全路径 -->
<logger name="logback.LogbackDemo" level="INFO" additivity="false">
<appender-ref ref="STDOUT"/>
</logger>
<root level="ERROR">
<appender-ref ref="STDOUT" />
</root>
</configuration>
appender
是 configuration的子节点,是负责写日志的组件
有两个必要属性:
* name: 指定appender的名称
* calss:指定appender的全限定名
- ConsoleAppender:
把日志添加到控制台,子节点:- encoder: 对日照进行格式化
- target:字符串 System.out 或者 System.err, 默认System.out
例如:
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="STDOUT" />
</root>
</configuration>
- FileAppender
把日志添加到文件,子节点:- file: 被写入的文件名,可以是相对目录,也可以说是绝对目录,如果上级目录不存在会自动创建,没有默认值
- append:如果是true,日志被追加到文件结尾,如果是false,清空现存文件,默认是true。
- encoder:对记录时间进行格式化
- prudent:如果是true,日志会被安全的写入文件,即使其他的FileAppender也在此文件做写入操作,效率低,默认是false。
例如:
<configuration>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>testFile.log</file>
<append>true</append>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>
-
RollingFileAppender:
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他问题。
子节点:- file:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
- append:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
- encoder:对记录事件进行格式化。
- rollingPolicy: 当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。
- triggeringPolicy:告知 RollingFileAppender 何时激活滚动
- prudent: 当为true时,不支持FixedWindowRollingPolicy. 支持 TimeBasedRollingPolicy,但是有两个限制:1. 不支持也不允许文件压缩;2:不能设置file属性,必须留空。
rollingPolicy:
- TimeBasedRollingPolicy
最常用的滚动策略,它根据实际来制定滚动策略,既负责滚动,也负责触发滚动。子节点:- fileNamePattern
必要节点,包含文件名及%d 转换符。%d 可以包含一个 java.text.SimpleDateFormat制定的时间格式,如" %d{yyyy-MM} 。如果直接使用%d,默认格式是 yyyy-MM-dd。RollingFileAppender 的file子节点可有可无,通过设置file,可以为活动文件和归档文件制定不同位置,当前日志总是极力到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据 fileNamePattern 的值,每隔一段时间改变一次。"/" 或 ""会被当做目录分隔符。 - maxHistory
可选节点,控制保留的归档文件的最大数量,超出数量就删除文件。假设设置每个月滚动,且 maxHistory是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件,那些为了归档而创建的目录也会被删除。关于保存的时间的单位,是根据时间格式的单位。
- fileNamePattern
- FixedWindowRollingPolicy
根据固定窗口算法重命名文件的滚动策略。子节点:- minIndex: 窗口索引最小值
- maxIndex:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12
- fileNamePattern:必须包含 %i。例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log 和 mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 mylog%i.log.zip。
triggeringPolicy:
* SizeBasedTriggeringPolicy
查看当前活动文件的大小,如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
* maxFileSize:活动文件的大小,默认值是10MB
例如:
每天生产一个日志文件,保存30天的日志
<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>
例如:
按照固定窗口模式生产日志文件,当文件大于20MB时,生产新的日志文件。窗口大小1到3,当保存了3个归档文件后,将覆盖最早的日志。
<configuration>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>test.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>tests.%i.log.gz</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>3</maxIndex>
</rollingPolicy>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>20MB</maxFileSize>
</triggeringPolicy>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="FILE" />
</root>
</configuration>
另外,还是SocketAppender,SMTPAppender,DBAppender,SyslogAppender,SiftingAppender,并不常用。
- encoder
负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流
目前 PatterLayoutEncoder 是唯一且有用的默认的 encoder,有一个节点pattern,用来设置日志的输入格式。
使用%加转换符的方式,如果要输出%,则必须用 \ 对 % 进行转义。
例如:
<encoder>
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
</encoder
-
pattern 里转换符说明:
-
c {length } /lo {length } /logger {length }
输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。 Conversion specifier Logger name Result
%logger mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar
%logger{0} mainPackage.sub.sample.Bar Bar
%logger{5} mainPackage.sub.sample.Bar m.s.s.Bar
%logger{10} mainPackage.sub.sample.Bar m.s.s.Bar
%logger{15} mainPackage.sub.sample.Bar m.s.sample.Bar
%logger{16} mainPackage.sub.sample.Bar m.sub.sample.Bar
%logger{26} mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar -
C {length } /class {length }
输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。 -
contextName /cn
输出上下文名称。 -
d {pattern } /date {pattern }
输出日志的打印日志,模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result
%d 2006-10-20 14:06:49,812
%date 2006-10-20 14:06:49,812
%date{ISO8601} 2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS} 14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS} 20 oct. 2006;14:06:49.812 -
F / file
输出执行记录请求的java源文件名。尽量避免使用,除非执行速度不造成任何问题。 -
caller{depth}caller{depth, evaluator-1, … evaluator-n}
输出生成日志的调用者的位置信息,整数选项表示输出信息深度。
例如, %caller{2} 输出为:0 [main] DEBUG - logging statement
Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
例如, %caller{3} 输出为:16 [main] DEBUG - logging statement
Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38) -
L / line
输出执行日志请求的行号。尽量避免使用,除非执行速度不造成任何问题。 -
m / msg / message
输出应用程序提供的信息。 -
M / method
输出执行日志请求的方法名。尽量避免使用,除非执行速度不造成任何问题。 -
n
输出平台先关的分行符“\n”或者“\r\n”。 -
p / le / level
输出日志级别。 -
r / relative
输出从程序启动到创建日志记录的时间,单位是毫秒 -
t / thread
输出产生日志的线程名。 -
replace(p ){r, t}
p 为日志内容,r 是正则表达式,将p 中符合r 的内容替换为t 。
例如, “%replace(%msg){’\s’, ‘’}”
-
-
格式修饰符,与转换符共同使用
可选的格式修饰符位于 % 和 转换符之间,
第一个可选修饰符是左对齐的标志,符号是减号“-”;接着是可选的最小宽度修饰符,用十进制数表示。如果字符小于最小宽度,则左填充或右填充,默认是左填充(即右对齐),填充符是空格。如果字符大于最小宽度,字符永远不会被截断。最大宽度修饰符,符号是点号".“后面加十进制。如果字符大于最大宽度,则从前面截断。点符号”."后面加减号“-”再加数字,表示从尾部截断。
例如:%-4relative 表示将输出从程序启动到创建日志记录的时间,进行左对齐,最小宽度为4.
filter
过滤器,执行一个过滤器会返回枚举值DENY,NEUTRAL,ACCEPT其中之一。
- 返回DENY,日志将立即被抛弃而不再经过其他过滤器
- 返回NEUTRAL,有序列表中的下个过滤器会接着处理日志
- 返回ACCEPT,日志会被立即处理,不再经过剩余过滤器
过滤器被添加到 Appender中,为Appender添加一个或夺欧冠过滤器后,可以用任意条件对日志进行过滤。Appender有多个过滤器时,安卓配置顺序执行。
- 常用过滤器:
- LevelFilter:级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据 onMatch 和 onMismatch 接收或拒绝日志。子节点:
- level:设置过滤级别
- onMatch: 用于配置符合过滤条件的操作
- onMismatch:用于配置不符合过滤条件的操作
例如:将过滤器的日志级别配置为INFO,所以INFO级别的日志交给appender处理,非INFO级别的日志,被过滤掉。
- LevelFilter:级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据 onMatch 和 onMismatch 接收或拒绝日志。子节点:
<configuration>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<encoder>
<pattern>
%-4relative [%thread] %-5level %logger{30} - %msg%n
</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="CONSOLE" />
</root>
</configuration>
- ThresholdFilter
临界值过滤器,过滤掉低于指定临界值的日志。当日志级别高于或等于临界值时,过滤器返回NEUTRAL;当日志界别低于临界值时,日志会被拒绝。
例如:过滤掉所有低于INFO级别的日志。
<configuration>
<appender name="CONSOLE"
class="ch.qos.logback.core.ConsoleAppender">
<!-- 过滤掉 TRACE 和 DEBUG 级别的日志-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<pattern>
%-4relative [%thread] %-5level %logger{30} - %msg%n
</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="CONSOLE" />
</root>
</configuration>
多环节日志输出
通过springProfile 标签
<configuration>
...
<!-- 测试环境+开发环境. 多个使用逗号隔开. -->
<springProfile name="test,dev">
<logger name="com.example.demo.controller" level="DEBUG" additivity="false">
<appender-ref ref="consoleLog"/>
</logger>
</springProfile>
<!-- 生产环境. -->
<springProfile name="prod">
<logger name="com.example.demo.controller" level="INFO" additivity="false">
<appender-ref ref="consoleLog"/>
</logger>
</springProfile>
</configuration>
application.yml增加环境选择的配置active: dev
server:
port: 9010
spring:
profiles:
active: dev
datasource:
url: jdbc:mysql://localhost:3306/test?characterEncoding=utf8
username: root
password: root
mybatis:
type-aliases-package: org.larry.springboot.entity
mapper-locations: classpath:mapper/**/*.xml
check-config-location: true
active: 【test、dev、prod】,根据 active 的环境,自动采用上面配置的springProfile的 logger 日志
自定义日志路径(application.xml)
application.xml 增加日志相关自定义配置
logback:
logdir: /Users/inke/dev/log/tomcat/sell
appname: sell
在logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!--application.yml 传递参数,不能使用logback 自带的<property>标签 -->
<springProperty scope="context" name="appname" source="logback.appname"/>
<springProperty scope="context" name="logdir" source="logback.logdir"/>
<contextName>${appname}</contextName>
<!--输出到控制台 ConsoleAppender-->
<appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
<!--展示格式 layout-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>
<pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
</pattern>
</layout>
</appender>