logback配置文件详解

<?xml version="1.0" encoding="UTF-8"?>

<!-- 根节点 , logback的全局配置 , 包含3个属性

scan : 当文件发生变更时是否重载 , 默认值ture

scanPeriod : 监测文件的间隔时间 , 即每隔多少时间扫描一次配置文件仅当scan=true时生效. 默认间隔时间1min , 如果不写单位默认是毫秒;

debug : 是否为debug模式 , 为true时会打印出logack内部日志 , 便于查看logback实时信息 . 默认值false

-->

<contextName>logback</contextName>

<!-- 日志输出组件有两个必须的属性

name : 当前appender的名称 , 在logger组件中相关联

class : 日志的输出控制类 , 通过class将日志输出到控制台/文件/远程socket服务器/数据库等

不同的class有着不同的配置

-->

<pattern>%d{HH:mm:ss} [%thread][%X{traceId}] %-5level %logger{36} - %msg%n</pattern>

</encoder>

</appender>

<file>xdemo.log</file>

<pattern>%d{HH:mm:ss} [%thread][%X{traceId}] %-5level %logger{36} - %msg%n</pattern>

</encoder>

</appender>

<!-- logger 日志返回/级别及输出目标配置有必填属性name和选填属性level/additivity , 一个appender-ref 子节点(可配置1个或多个)

name : 指定遵守该logger约束的一个包或具体的某个类

level : 日志级别 ,有以下值TRACE, DEBUG, INFO, WARN, ERROR, ALL, OFF , 不区分大小写

additivity : 是否向上级logger传递日志信息 , 默认为ture . (如果上级logger也输出日志 , 则会输出两份 . 所以通常情况下配置为false)

-->

<appender-ref ref="console"/>

<appender-ref ref="file"/>

</logger>

<appender-ref ref="console"/>

<appender-ref ref="file" />

</root>

</configuration>

RollingFileAppender详细配置

<!-- RollingFileAppender详细配置

其中有file/append/pruduent几个通用节点 , 不再详述 .

具体讲一下rollingPolicy节点相关 , 该节点通过class属性指定不同的配置指定RoolingFileAppender的动态行为 , 涉及日志文件的移动/重命名等

-->

<!-- 子节点fileNamePattern : 文件目录表达式 , 包含文件名及%d转换表达式 , %d可以包含一个SimpleDateFormat格式的日期字符串 , 如"yyyyMMdd" , 如省略直接写%d则默认为"yyy-MM-dd", 则按照日期自动分割每天产生的日志

配置该节点后 , RollingFileAppender的file节点可有可无 , 如果同时配置了两个节点的话 , 日志文件会归档为两套(一套按日期分割 , 一套整个写入file指定的文件) -->

<fileNamePattern>/data/logs/%d/xdemo_%d{yyMMdd}.log</fileNamePattern>

</rollingPolicy>

<file>/data/logs/xdemo.log</file>

</rollingPolicy>

常用的三方框架logger配置

filter详细配置

<!-- filter: 日志过滤器 , 可以过滤不符合规则的内容 , 使之不输出到控制台或文件 , 为appender的子节点

logback过滤器是基于Ternary Logic, 允许多个过滤器搭配使用 , 配置多个过滤器时按照书写顺序依次执行

执行一个过滤器会返回以下几个枚举值

ACCEPT: 该日志符合规则 , 接受处理 . 同时不会再经过其他过滤器

NEUTRAL: 当前过滤器不处理 , 下个过滤器继续处理

DENY: 该日志将被过滤抛弃 , 且不再经过其他过滤器

-->

<onMatch>ACCEPT</onMatch>

</filter>

</filter>

<expression>return message.contains("xinfo");</expression>

</evaluator>

<OnMatch>ACCEPT</OnMatch>

</filter>

</appender>

日志输出格式详细说明

参数说明示例

c{length}

lo{legnth}

logger{length}

输出日志的logger , length缩短logger名 , 设置为0表示只输入logger最右边点符号之后内容(从右开始缩短 ,每个层级至少保留1位)

完整logger名 : cn.xbz.test.HelloController

%logger : cn.xbz.test.HelloController

%logger{0}: HelloController

%logger{5}: c.x.t.HelloController

%logger{20}: c.x.test.HelloController

C{length}

class{length}

输出当前调用者的全名(包名+类名) , 参数与上面一致 , 效率不高 , 尽量避免使用 %class

contextName

输出xml中配置的上下文名称 %contextName

d{pattern}

date{pattern}

输出当前的时间 , 字符串语法与SimpleDateFormat相同

%d : 2019-01-10 10:01:10,816

%date : 2019-01-10 10:01:10,816

%date{HH:mm:ss.SSS} : 10:01:10,816

%date{yyyy-MM-dd hh:mm:ss} : 2019-01-10 10:01:10

file

输出日志写入目标的文件名 , 尽量避免使用 %file

caller{depth}

caller{depth, evaluator-1, ... evaluator-n}

当前调用者的位置信息 ?

line

输出日期请求的行号 , 尽量避免使用 %line

msg

message

输出日志信息(必用) %message

method

当前执行日志请求的方法名 , 尽量避免使用 %method

n 输出平台相关的换行符("\n" 或 "\r\n") %n

level

输出日志级别(TRACE/DEBUG/INFO/WARN/ERROR/FATAL) %level

relative

输出自程序启动到创建日志记录的时间 , 单位毫秒 %relative

thread

输出调用日志的线程名 %thread

replace(p){r,t} 替换输出内容 , p为日志内容 , r是正则表达式 , 将p中符合r的内容替换为t %replace(%msg){'\s',''}

日志格式修饰符

可选的格式修饰符位于“%”和转换符之间。(%-5level / %.6logger)

第一个可选修饰符是左对齐标志，符号是减号“-”；接着是可选的最小宽度修饰符，用十进制数表示。如果字符小于最小宽度，则左填充或右填充，默认是左填充（即右对齐），填充符为空格。如果字符大于最小宽度，字符永远不会被截断。最大宽度修饰符，符号是点号"."后面加十进制数。如果字符大于最大宽度，则从前面截断。点符号“.”后面加减号“-”在加数字，表示从尾部截断。

例如：%-4relative 表示，将输出从程序启动到创建日志记录的时间进行左对齐且最小宽度为4