logback系列之八:自定义Pattern模板

原创 2016年08月29日 14:28:24
创建自定义格式转换符有两步:

1.写一个转换器类,继承ClassicConvert
package com.cj.log;  
  
import ch.qos.logback.classic.pattern.ClassicConverter;  
import ch.qos.logback.classic.spi.ILoggingEvent;  
  
public class IpConvert extends ClassicConverter {  
  
    @Override  
    public String convert(ILoggingEvent event) {  
        return "10.10.10.10";  
    }  
}  
2.在logback.xml中注册该转换器,并自定义转换符

注册:
<conversionRule conversionWord="ip" converterClass="com.cj.log.IpConvert" />

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

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

测试结果:
2013-04-01 15:25:16.887 10.10.10.10 [main] ERROR 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:
package com.cj.log;  
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.cj.log.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控制台输出类名行号带链接的Pattern配置

从log4j切换到logback会发现,原来在log4j使用的日志格式 %l 的功能不见了。Eclipse控制台的输出,不再带有可快速进入的链接了。 在logback里,需要使用%c%L才能打印...

logback高级特性使用(二) 自定义Pattern模板

自定义Pattern模板 创建自定义格式转换符有两步: 1.写一个转换器类,继承ClassicConvert 示例代码: [java] ...

阅读Logback文档笔记--Logback的Layout配置

什么是 layout ? Layout 是Logback中的组件,负责将到来的event转换成 String。Layout 接口中的 doLayout(E event)方法接受一个模板类 event ...

logback 配置详解(一)

一:根节点包含的属性:   scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。 scanPeriod: 设置监测配置文件是否有...
  • haidage
  • haidage
  • 2011年09月20日 17:20
  • 181167

日志组件logback的介绍及配置使用方法

转载于:http://sunney2010.iteye.com/blog/1404729   一、logback的介绍      Logback是由log4j创始人设计的又一个开源日志组件。lo...
  • zgmzyr
  • zgmzyr
  • 2012年12月06日 21:22
  • 63909

Java深入 - logback的配置和使用

转自:http://blog.csdn.net/initphp/article/details/40891821 1. logback介绍 Logback是由log4j创始人设计的又一...

Logback常用配置详解

logback是一套日志框架,由log4j的优化版,由同一个作者开发,在速度和性能上都超过其他日志框架,再结合slf4j,已成为当前最流行的日志框架。Logback最常用就是在classpath定义一...

log4j日志扩展---自定义PatternLayout

目前扩展log4j的日志一般使用扩展adaper的方法,这里使用一种扩展PatternLayout方法. log4j.rootLogger=debug, stdout, R log4j.appe...

Log4j扩展使用--日志格式化器Layout

Layout:格式化输出日志信息 OK,前面我已经知道了。Appender必须使用一个与之相关联的Layout,这样才能知道怎样格式化输出日志信息。 日志格式化器Layout负责格式化日志信息,方法...

logback.xml配置模版

UTF-8                                          %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %l...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:logback系列之八:自定义Pattern模板
举报原因:
原因补充:

(最多只允许输入30个字)