动态调整Logback的Appender的解决方案

前言

在复杂的应用环境中,动态调整Logback的Appender是非常实用的功能。

日志系统对于监控和调试应用程序至关重要,尤其是在生产环境。当应用运行时,不同的场景可能需要不同的日志级别或日志输出策略。例如,在出现异常情况或进行性能调优时,可能需要临时增加日志详细度(如从INFO级别改为DEBUG级别),以便收集更详尽的运行信息;而在系统正常运行且资源受限时,则可能需要降低日志级别以减少磁盘I/O和提升系统性能。

另外,有时需要根据实际需求灵活地更改日志的存储位置、格式或者启用新的Appender来将日志发送到不同的目标(如追加到文件、输出到控制台、发送到远程服务器或消息队列等)。

通过动态调整Appender,开发人员可以在不重启应用的前提下即时响应变化,增强了系统的可维护性和灵活性。这对于运维人员快速定位问题、实时分析系统状态以及保证服务稳定运行具有重要价值。

配置示例

如下,是一个logback.xml定义,配置了两个appender:

xml 复制代码
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 常规日志输出   -->
    <appender name="SIMPLE-CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%level %thread %msg \r\n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- json格式日志输出   -->
    <appender name="JSON-CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>{ "level":"%level", "thread": "%thread", "msg":"%msg" }\r\n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="SIMPLE-CONSOLE"/>
    </root>

    <logger name="com.xxd.demo" level="INFO" additivity="false">
        <appender-ref ref="SIMPLE-CONSOLE"/>  
        <appender-ref ref="JSON-CONSOLE"/>
    </logger>
</configuration>
  • SIMPLE-CONSOLE 输出纯文本行的日志
  • JSON-CONSOLE com.xxd.demo包下的,输出json格式的日志

看下效果,日志使用SIMPLE-CONSOLE和JSON-CONSOLE输出:

如果在项目运行过程中,想要把JSON-CONSOLE这个appender干掉,怎么办?

下面提供一个我自己摸索出来的解决思路,借助这个思路,如果有其它调整需求,可以参考一下。

Append调用位置

看上面图片右侧的调用栈,Logger.info()等方法,从info方法最终调用到appendLoopOnAppenders()方法,遍历配置的appender进行调用,输出日志。

如果我现在想要移除或增加某个appender,关键在于appenderList对象的处理。

解决思路

这个类里有两个关键的方法:

  • addAppender: 附加一个appender到appenderList。如果追加器已经在列表中,则不会再次添加。
  • detachAppender: 从appenderList移除一个appender

上面对应这几个方法的实现可以看源码。

现在需要解决的问题是如何调用到这两个方法。

很简单,我们创建的Logger对象有这个属性:AppenderAttachableImpl, AppenderAttachableImpl类有appenderList属性。

并且也提供了这几个方法,供我们操作:

如下是我们平常创建一个Logger对象

swift 复制代码
public static Logger log = LoggerFactory.getLogger(Application.class);

/**  
* 缓存每个logger对象配置的相关appender.  
*/  
public static Map<ch.qos.logback.classic.Logger, Appender<ILoggingEvent>> cache = new HashMap<>();

增加一个appender:

java 复制代码
    public static void addAppender() {
        ILoggerFactory factory = LoggerFactory.getILoggerFactory();
        // 强转为这个对象
        LoggerContext context = (LoggerContext) factory;
        List<ch.qos.logback.classic.Logger> loggerList = context.getLoggerList();
        loggerList.forEach(logger -> {
            // 遍历所有的logger实例
            if (cache.containsKey(logger)) {
                logger.addAppender(cache.get(logger));
                cache.remove(logger);
            }
        });
    }

移除appender:

java 复制代码
    public static void detachAppender() {
        ILoggerFactory factory = LoggerFactory.getILoggerFactory();
        LoggerContext context = (LoggerContext) factory;
        List<ch.qos.logback.classic.Logger> loggerList = context.getLoggerList();
        loggerList.forEach(logger -> {
            Appender<ILoggingEvent> appender = logger.getAppender("JSON-CONSOLE");
            if (appender != null) {
                cache.put(logger, appender);
                logger.detachAppender("JSON-CONSOLE");
            }
        });
    }

测试看下效果:

动态修改

目前已经实现了运行中的增、删appender,至于动态修改,方案比较多,这里提供一个思路:

对接配置中心,比如nacos,监听配置变动处理,在配置属性中配置是否隐藏或使用哪些appender,进行相关处理。

或者定时检查是否有配置变动等。

具体实现取决于自己项目实际情况。

相关推荐
小郑[努力版]1 分钟前
Nginx常用操作
java·python·中间件
倾听一世,繁花盛开4 分钟前
Java语言程序设计——篇二(1)
java·开发语言·eclipse
华子w90892585911 分钟前
60页论文参考:基于Java+SpringMvc+Vue技术的智慧校园系统设计与实现
java·开发语言·vue.js·论文阅读
java66666888823 分钟前
使用Java构建一个高性能的消息队列系统
java·开发语言·linq
m0_5719575827 分钟前
Java | Leetcode Java题解之第219题存在重复元素II
java·leetcode·题解
NullPointerExpection28 分钟前
h5 video 标签播放经过 java 使用 ws.schild( jave、ffmpeg ) 压缩后的 mp4 视频只有声音无画面的问题排查记录
java·ffmpeg·音视频·vlc·jave·ws.schild
u01040583638 分钟前
如何在Java中实现自动化测试和集成测试
java·开发语言·集成测试
菜鸡且互啄691 小时前
Spring Boot Security自定义AuthenticationProvider
java·jvm·spring boot
寻找自己的自己1 小时前
常用工具类
java
捕风捉你1 小时前
迭代器模式在金融业务中的应用及其框架实现
java·开发语言·迭代器模式