当前位置 博文首页 > 文章内容

    logback 自定义Pattern模板教程

    作者:shunshunshun18 栏目:未分类 时间:2021-07-26 14:43:04

    本站于2023年9月4日。收到“大连君*****咨询有限公司”通知
    说我们IIS7站长博客,有一篇博文用了他们的图片。
    要求我们给他们一张图片6000元。要不然法院告我们

    为避免不必要的麻烦,IIS7站长博客,全站内容图片下架、并积极应诉
    博文内容全部不再显示,请需要相关资讯的站长朋友到必应搜索。谢谢!

    另祝:版权碰瓷诈骗团伙,早日弃暗投明。

    相关新闻:借版权之名、行诈骗之实,周某因犯诈骗罪被判处有期徒刑十一年六个月

    叹!百花齐放的时代,渐行渐远!



    配色板

    "%black", "%red", "%green","%yellow","%blue", "%magenta","%cyan", "%white", "%gray","%boldRed","%boldGreen", "%boldYellow", "%boldBlue", "%boldMagenta","%boldCyan", "%boldWhite","%highlight"

    例:%red(XX),则 XX 这两个字为红色

    其它 %p 表示level,%t表示线程名

    自定义Pattern模板

    创建自定义格式转换符有两步:

    1.写一个转换器类,继承ClassicConvert

    示例代码:

    public class IpConvert extends ClassicConverter {
        @Override
        public String convert(ILoggingEvent event) {
            String ip = "10.10.10.10";
            return ip;
        }
    }

    2.在logback.xml中注册该转换器,并自定义转换符

    注册:

    <conversionRule conversionWord="ip" converterClass="com.hjx.log4j.IpConvert" />

    自定义ip转换符:

    <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%ip [%thread] %-5level %logger{36} -% msg%n</Pattern>

    经过这两步骤后,即可将自定义的ip转换符添加到输出模板当中了。

    测试结果:

    2015-05-01 15:25:16.887 10.10.10.10 [main] INFO c.s.f.log.normal.TestAppender

    这里的10.10.10.10便是转换后的值了。

    上面的步骤只是基本的自定义模板方法,不好的地方就是要在配置文件里注册,实际上只要模仿logback原生创建的方法把这个转换符加进去就可以了。可以看下PatternLayout.java源码:

    public class PatternLayout extends PatternLayoutBase<ILoggingEvent> {  
      public static final Map<String, String> defaultConverterMap = new HashMap<String, String>();  
      static {  
        defaultConverterMap.putAll(Parser.DEFAULT_COMPOSITE_CONVERTER_MAP);  
        defaultConverterMap.put("d",DateConverter.class.getName());  
        defaultConverterMap.put("date",DateConverter.class.getName());  
        defaultConverterMap.put("r",RelativeTimeConverter.class.getName());  
        defaultConverterMap.put("relative",RelativeTimeConverter.class.getName());  
         ...  

    现在只需在这个static方法快里加上一句:

    defaultConverterMap.put("ip",IpConvert.class.getName());

    即可。”ip”是转换的字符,IpConvert是上面定义的转换器类。但如何添加进去呢?下面便是一种实现方案:

    首先,定义一个类,该类继承PatternLayout.java:

    import ch.qos.logback.classic.PatternLayout;  
    public class MyPatternLayout extends PatternLayout {  
        static {  
            defaultConverterMap.put("ip",IpConvert.class.getName());  
        }  
    }  

    直接调用父类的属性,将自定义的转换符添加进去。IpConvert便是上面已实现的转换器。

    之后,便是在logback.xml中配置我们自定义的PatternLayout:

    <!-- 日志输出格式 -->  
    <layout class="com.hjx.log4j.MyPatternLayout">  
          <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %ip [%thread] %-5level %logger{36} -%msg%n</Pattern>  
    </layout>  

    原先的layout的class类为”ch.qos.logback.classic.PatternLayout”,这里换成我们自定义的即可。

    通过上述两种方案,便可实现自定义模板的功能。这种功能使用的一种场景便是在集群的环境下进行日志的分析,通常分析异常日志的时候,并不能准确定位到底是哪台主机上的哪个server出了错,如果添加了ip地址信息到日志中去,那么日志分析工作讲会变得更加准确高效。

    如果有类似于监控平台这样的系统,那么便可将所有的异常日志统一进行分析,只需在输出中定义一些类似于主机ip、系统应用id之类的区别的变量,这样处理的好处自然不言而喻。

    以下是我实际用到logback的配置

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    
        <!-- 配置IP地址 -->
        <conversionRule conversionWord="ip" converterClass="com.xyk.util.log4j.IpConvert" />
        <!-- Console 输出格式 -->
        <property name="CONSOLE_LOG_PATTERN"
                  value="%date{yyyy-MM-dd HH:mm:ss} %boldGreen(%ip) | %highlight(%-5level) | %boldYellow(%thread) | %boldGreen(%logger) | %msg%n"/>
    
        <!-- 文件输出格式 -->
        <property name="FILE_LOG_PATTERN"
                  value="===%d{yyyy-MM-dd HH:mm:ss.SSS} %ip %-5level %logger Line:%-3L - %msg%n"/>
    
        <!-- Console 输出设置 -->
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>
                    ${CONSOLE_LOG_PATTERN}
                </pattern>
                <charset>UTF-8</charset>
            </encoder>
            <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>debug</level>
            </filter>
        </appender>
    
        <!--
           说明:
           1、日志级别及文件
               日志记录采用分级记录,级别与日志文件名相对应,不同级别的日志信息记录到不同的日志文件中
               例如:error级别记录到log_error_xxx.log或log_error.log(该文件为当前记录的日志文件),而log_error_xxx.log为归档日志,
               日志文件按日期记录,同一天内,若日志文件大小等于或大于2M,则按0、1、2...顺序分别命名
               例如log-level-2013-12-21.0.log
               其它级别的日志也是如此。
           2、文件路径
               若开发、测试用,在Eclipse中运行项目,则到Eclipse的安装路径查找logs文件夹,以相对路径../logs。
               若部署到Tomcat下,则在Tomcat下的logs文件中
           3、Appender
               FILEERROR对应error级别,文件名以log-error-xxx.log形式命名
               FILEWARN对应warn级别,文件名以log-warn-xxx.log形式命名
               FILEINFO对应info级别,文件名以log-info-xxx.log形式命名
               FILEDEBUG对应debug级别,文件名以log-debug-xxx.log形式命名
               stdout将日志信息输出到控制上,为方便开发测试使用
        -->
        <contextName>SpringBootDemo</contextName>
        <property name="LOG_PATH" value="log/" />
        <!--设置系统日志目录-->
        <property name="APPDIR" value="pay-server" />
    
        <!-- 日志记录器,日期滚动记录 -->
        <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在记录的日志文件的路径及文件名 -->
            <file>${LOG_PATH}/${APPDIR}/log_error.log</file>
            <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 归档的日志文件的路径,例如今天是2013-12-21日志,当前写的日志文件路径为file节点指定,可以将此文件与file指定文件路径设置为不同路径,从而将当前日志文件或归档日志文件置不同的目录。
                而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 -->
                <fileNamePattern>${LOG_PATH}/${APPDIR}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <!-- 除按日志记录之外,还配置了日志文件不能超过2M,若超过2M,日志文件会以索引0开始,
                命名日志文件,例如log-error-2013-12-21.0.log -->
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <!-- 追加方式记录日志 -->
            <append>true</append>
            <!-- 日志文件的格式 -->
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>utf-8</charset>
            </encoder>
            <!-- 此日志文件只记录error级别的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>error</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 日志记录器,日期滚动记录 -->
        <appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在记录的日志文件的路径及文件名 -->
            <file>${LOG_PATH}/${APPDIR}/log_warn.log</file>
            <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 归档的日志文件的路径,例如今天是2013-12-21日志,当前写的日志文件路径为file节点指定,可以将此文件与file指定文件路径设置为不同路径,从而将当前日志文件或归档日志文件置不同的目录。
                而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 -->
                <fileNamePattern>${LOG_PATH}/${APPDIR}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <!-- 除按日志记录之外,还配置了日志文件不能超过2M,若超过2M,日志文件会以索引0开始,
                命名日志文件,例如log-error-2013-12-21.0.log -->
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <!-- 追加方式记录日志 -->
            <append>true</append>
            <!-- 日志文件的格式 -->
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>utf-8</charset>
            </encoder>
            <!-- 此日志文件只记录warn级别的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <!-- 日志记录器,日期滚动记录 -->
        <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 正在记录的日志文件的路径及文件名 -->
            <file>${LOG_PATH}/${APPDIR}/log_info.log</file>
            <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 归档的日志文件的路径,例如今天是2013-12-21日志,当前写的日志文件路径为file节点指定,可以将此文件与file指定文件路径设置为不同路径,从而将当前日志文件或归档日志文件置不同的目录。
                而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 -->
                <fileNamePattern>${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <!-- 除按日志记录之外,还配置了日志文件不能超过2M,若超过2M,日志文件会以索引0开始,
                命名日志文件,例如log-error-2013-12-21.0.log -->
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            <!-- 追加方式记录日志 -->
            <append>true</append>
            <!-- 日志文件的格式 -->
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>${FILE_LOG_PATTERN}</pattern>
                <charset>utf-8</charset>
            </encoder>
            <!-- 此日志文件只记录info级别的 -->
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <logger name="org.springframework" level="WARN" />
        <logger name="org.hibernate" level="WARN" />
    
        <!-- 生产环境下,将此级别配置为适合的级别,以免日志文件太多或影响程序性能 -->
        <!--这里改level 生产环境改成ERROR 开发环境为INFO-->
        <root level="INFO">
            <appender-ref ref="FILEERROR" />
            <appender-ref ref="FILEWARN" />
            <appender-ref ref="FILEINFO" />
    
            <!-- 生产环境将请stdout,testfile去掉 -->
            <appender-ref ref="STDOUT" />
        </root>
    </configuration>

    输出的日志为:

    这里写图片描述

    以上为个人经验,希望能给大家一个参考,也希望大家多多支持IIS7站长之家博文。