箱猫日和

[Java]运行时动态改变日志级别

其实这不是什么神奇的trick，只是很多人包括我在一直以来使用Java的日志框架比如log4j时没有意识到可以动态改变日志级别。如果你看到别人这么写了的话，很快就会转变观念的，我也是。

https://github.com/xnnyygn/dynamic-log-level 这个github是我整理的log4j动态改变日志级别的代码以及测试，有兴趣的可以参考下。

个人觉得这个trick可以用的地方还是程序员给自己开“后门”，特别是查线上问题时。由于很多人打印日志的级别的convention不一致。比如我喜欢非常详细的输入参数和输出结果用DEBUG，但是有些人就喜欢打INFO。一些复杂的逻辑有些人打了十几八行的INFO级别日志，看得我心烦，这帮人打INFO就像喝水一样……所以有些时候临时改变日志级别可能是有用的。不过从开发上来说，没有很好地统一日志级别规范，没有重视CR，是导致这个问题的主因，但是作为程序员要给自己留一手，比如动态改变日志级别之类的。

言归正题，具体代码其实不复杂，以下展示下测试代码和实现代码。

测试代码如下

import org.apache.log4j.Logger;
import org.junit.Test;

public class Log4jLogLevelManagerTest {

  private static final Logger logger = Logger.getLogger("test");

  @Test
  public void test() {
    Log4jLogLevelManager manager = new Log4jLogLevelManager();

    // original level of logger 'test' is INFO
    logger.info("info message should be outputed");
    logger.debug("debug message should not be outputed");

    // change log level to debug
    manager.changeLogLevel("test", "DEBUG");

    logger.debug("debug message should be outputed now");

    // reset level of logger 'test'
    manager.resetLogLevel("test");

    logger.debug("debug message should not be outputed again");
  }

}

运行时会产生类似如下信息

2015-05-16 08:10:16,295 INFO  [main] dynamicloglevel.Log4jLogLevelManagerTest (Log4jLogLevelManagerTest.java:23) - info message should be outputed
2015-05-16 08:10:16,301 DEBUG [main] dynamicloglevel.Log4jLogLevelManagerTest (Log4jLogLevelManagerTest.java:29) - debug message should be outputed now

实现代码如下

import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import org.apache.log4j.Level;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;

public class Log4jLogLevelManager implements LogLevelManager {

  private ConcurrentMap<String, Level> levels =
      new ConcurrentHashMap<String, Level>();

  public void changeLogLevel(String loggerName, String level) {
    Logger logger = determineLogger(loggerName);
    if (logger == null) return; // logger not found

    // push original level in the first time of changing
    levels.putIfAbsent(loggerName, logger.getLevel());
    logger.setLevel(Level.toLevel(level));
  }

  private Logger determineLogger(String loggerName) {
    if ("ROOT".equals(loggerName)) return LogManager.getRootLogger();
    // don't use LogManager#getLogger here since getLogger will cause
    // making of new logger if logger not found
    return LogManager.exists(loggerName);
  }

  public void resetLogLevel(String loggerName) {
    Logger logger = determineLogger(loggerName);
    if (logger == null) return; // logger not found

    Level originalLevel = levels.get(loggerName);
    if(originalLevel == null) return; // level of logger is not changed

    logger.setLevel(originalLevel);
  }

}

注意这里使用了ConcurrentMap，考虑到类似web环境下并发的可能，这里还是加上并发控制比较好。注意使用原子操作，比如putIfAbsent。

总体来说，这个trick不是很复杂，就当是笔记好了，说不定哪天可以使用。

xnnyygn