跳至主要内容

Log4j Conditional Log

Basic Log

Log4j is a very common log library for Java, which can has most common features that we need:

  • configure log target: file, console, network etc;
  • configure log format: layout, pattern;
  • configure log threshold;

Property File Config Example

The following is a sample config:

log4j.rootLogger=CONSOLE,E

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.Threshold = Warn
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern = %d{ABSOLUTE} %5p %c{1}:%L - %m%n

log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = logs/log_error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

Conditional Log

In some cases, we want to log some specific information, but filter out some others. One common way to do this is using different logging levels, which is the value of Threshold. Log4j has five pre-defined levels:

  • FATAL
  • ERROR
  • WARN
  • INFO
  • DEBUG
  • TRACE

In some other cases, we shouldn’t use logging levels, but some finer granularity of control method. In this case, we can use filters to meet the needs.

Log4j has four common filters to filter the output:

  • DenyAllFilter: drop all logging event
  • LevelMatchFilter: a level to match and a boolean to decide whether accept this level
  • LevelRangeFilter: a range to match and a boolean to decide whether accept this range
  • StringMatchFilter: a string to match and a boolean to decide whether accept event that contains this string

A Wrong Example

The following is a wrong example I copy from web:

log4j.appender.X=...
// here, the name of logger is wrong, so not work
og4j.appender.x.filter.1=org.apache.log4j.varia.StringMatchFilter
log4j.appender.X.filter.1.StringToMatch=ErrorCodeException
log4j.appender.X.filter.1.AcceptOnMatch=false

What should be noticed here is the name of logger should match the following config, or filtering will fail.

PropertyConfigurator

If we find our config not working, we may need to find out whether our version of Log4j is right, whether those filters are exists in our version.

If it is still not work, we can find class PropertyConfigurator in Log4j, which is used to parse property file and set up Log4j config.

The following is the part of code parse filters, through which, we find out the bug of upper config.

void parseAppenderFilters(Properties props, String appenderName, Appender appender) {

    // property key, have to match the name of logger, or won't config filter
    String key = (String) e.nextElement();
    if (key.startsWith(filterPrefix)) {...}
}

StringMatchFilter

If we are still confused with how StringMatchFilter works, we can read the code to find out:

int decide(LoggingEvent event) {
  String msg = event.getRenderedMessage();

  if(msg == null ||  stringToMatch == null)
    return Filter.NEUTRAL;


  if( msg.indexOf(stringToMatch) == -1 ) {
    return Filter.NEUTRAL;
  } else { // we've got a match
    if(acceptOnMatch) {
return Filter.ACCEPT;
    } else {
return Filter.DENY;
    }
  }
}

By reading the source of decide, we can see, it will ignore this log message if contains specific string, because the use of indexOf.

Written with StackEdit.

标签：

评论

发表评论

此博客中的热门博文

Spring Boot: Customize Environment

Spring Boot: Customize Environment Environment variable is a very commonly used feature in daily programming: used in init script used in startup configuration used by logging etc In Spring Boot, all environment variables are a part of properties in Spring context and managed by Environment abstraction. Because Spring Boot can handle the parse of configuration files, when we want to implement a project which uses yml file as a separate config file, we choose the Spring Boot. The following is the problems we met when we implementing the parse of yml file and it is recorded for future reader. Bind to Class Property values can be injected directly into your beans using the @Value annotation, accessed via Spring’s Environment abstraction or bound to structured objects via @ConfigurationProperties. As the document says, there exists three ways to access properties in *.properties or *.yml : @Value : access single value Environment : can access multi...
5 条评论
阅读全文

Elasticsearch: Join and SubQuery

Elasticsearch: Join and SubQuery Tony was bothered by the recent change of search engine requirement: they want the functionality of SQL-like join in Elasticsearch! “They are crazy! How can they think like that. Didn’t they understand that Elasticsearch is kind-of NoSQL 1 in which every index should be independent and self-contained? In this way, every index can work independently and scale as they like without considering other indexes, so the performance can boost. Following this design principle, Elasticsearch has little related supports.” Tony thought, after listening their requirements. Leader notice tony’s unwillingness and said, “Maybe it is hard to do, but the requirement is reasonable. We need to search person by his friends, didn’t we? What’s more, the harder to implement, the more you can learn from it, right?” Tony thought leader’s word does make sense so he set out to do the related implementations Application-Side Join “The first implementation ...
发表评论
阅读全文

Learn Spring Expression Language

When reading the source code of some Spring based projects, we can see some code like following: @Value( "${env}" ) private int value ; and like following: @Autowired public void configure (MovieFinder movieFinder, @ Value ("#{ systemProperties[ 'user.region' ] } ") String defaultLocale) { this.movieFinder = movieFinder; this.defaultLocale = defaultLocale; } In this way, we can inject values from different sources very conveniently, and this is the features of Spring EL. What is Spring EL? How to use this handy feature to assist our developments? Today, we are going to learn some basics of Spring EL. Features The full name of Spring EL is Spring Expression Language, which exists in form of Java string and evaluated by Spring. It supports many syntax, from simple property access to complex safe navigation – method invocation when object is not null. And the following is the feature list from Spring EL document : ...
发表评论
阅读全文