logback java动态配置【动态修改日志级别,动态修改appender】

logback 动态配置

写在前面

在做java日志之前,强烈建议大家读一下这篇java日志的前世今生,对理清java日志框架很有帮助!

奉上地址: 一个著名的日志系统是怎么设计出来的

然后说一下,为啥要使用动态日志配置。对于业务系统来讲,有些日志并非必须日志,但是对于调试是很重要的,当我们需要监控一个时段的日志,而过去这个时段,我们便不需要这些日志了,我们就可以通过命令,或者请求,动态开启日志输出,不想要日志时,动态关闭日志即可。
对于试运行阶段的项目,我们需要收集比较详细的日志,当我们认为系统稳定了,没有问题了,就可以动态关闭日志。

再者,有需求,我们的日志输出源发生改变,比如ELK变为了kafka ,我们在不停止服务的情况下,就可以动态操作,修改掉输出对象。

简述java日志框架

logback java动态配置【动态修改日志级别,动态修改appender】_第1张图片

spring boot 默认的日志框架为 slf4j+logback 。这里也强烈建议写日志时面向 slf4j(面向接口),几乎目前主流的日志框架(指java日志框架)都实现了slf4j,因此面向slf4j写日志,日志框架非常容易迁移。
例如将log4j2 迁移为 logback ,只需要修改部分配置文件即可。

logback的执行步骤 :

logback java动态配置【动态修改日志级别,动态修改appender】_第2张图片

logback的主要对象

对象 简述
LoggerContext logback的核心对象,加载配置文件,存储loggerList……是log back的核心容器
Logger 这个Logger为logback的logger 它实现了slf4j的Logger对象,除了实现了所有的logger方法外,我们动态配置日志输出源,也需要里面的 addAppender(),detachAppender()方法
Appender 日志输出的最终实现, doAppend(E e)方法,最终实现了日志的输出,如果自定义appender 需要最终实现该接口

注:以上对象并非logback全部核心对象,对于今天的日志动态输出,仅仅涉及到以上核心对象。

实现logback 动态改变日志级别

实现流程如下 :

logback java动态配置【动态修改日志级别,动态修改appender】_第3张图片

下面附上测试源代码:

package com.kgo.logger.logback;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.LoggerContext;
import com.kgo.logger.appender.DemoAppender;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ContextTest {
    public static final String demoApName = "demo";
    public static void main(String[] args) {
        // 定义日志输出
        Logger logger = LoggerFactory.getLogger(ContextTest.class);
        logger.debug("=== 我输出了 === ");
        // 第一步:获取日志上下文
        LoggerContext lc = (LoggerContext)LoggerFactory.getILoggerFactory();
        // 第二步:获取日志对象 (日志是有继承关系的,关闭上层,下层如果没有特殊说明也会关闭)
        ch.qos.logback.classic.Logger logbackLogger = lc.getLogger("com.kgo.logger.logback");
        ch.qos.logback.classic.Logger rootLogger = lc.getLogger("root");
        // 第三步:修改日志级别
        logbackLogger.setLevel(Level.INFO);
        logger.debug("===== 我是 debug  =====");
        logger.info("===== 我是 info  =====");
        logger.error("===== 我是 ERROR  =====");
    }
}

输出结果如下:

在这里插入图片描述

可以看到 日志级别修改为INFO之后,日志 “===== 我是 debug =====” 没有输出
logback 基本选择规则如下 :

logback java动态配置【动态修改日志级别,动态修改appender】_第4张图片

动态添加删除 appender

实现步骤和 修改日志级别基本一致,流程如下:

logback java动态配置【动态修改日志级别,动态修改appender】_第5张图片

附上测试代码:

package com.kgo.logger.logback;

import ch.qos.logback.classic.LoggerContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ChangeAppender {
    public static final String demoApName = "demo";
    public static void main(String[] args) {
        // 定义日志输出
        Logger logger = LoggerFactory.getLogger(ContextTest.class);
        logger.debug("=== 我输出了 === \n ");
        // 第一步:获取日志上下文
        LoggerContext lc = (LoggerContext)LoggerFactory.getILoggerFactory();
        // 第二步:获取日志对象 (日志是有继承关系的,关闭上层,下层如果没有特殊说明也会关闭)
        ch.qos.logback.classic.Logger logbackLogger = lc.getLogger("com.kgo.logger.logback");
        ch.qos.logback.classic.Logger rootLogger = lc.getLogger("root");
        // 第三步:移除 appender
        logbackLogger.detachAppender("STDOUT");
        logger.debug("仅仅移除 com.kgo.logger.logback 的 appender");
        logger.debug("===== 我是 debug  =====");
        logger.info("===== 我是 info  =====");
        logger.error("===== 我是 ERROR  =====");
        rootLogger.detachAppender("STDOUT");
        logger.debug("\n 仅仅移除root 的 appender");
        logger.debug("===== 我是 debug  =====");
        logger.info("===== 我是 info  =====");
        logger.error("===== 我是 ERROR  =====");

    }
}

在执行这段代码的时候我在本地已经配置的 logback-test.xml ,其中 “STDOUT” 便是在该文件中做的配置,配置如下:

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%npattern>
        encoder>
    appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    root>
 <logger name="com.kgo.logger.logback" level="DEBUG" >
        <appender-ref ref="STDOUT" />
    logger>
configuration>

输出结果如下:

logback java动态配置【动态修改日志级别,动态修改appender】_第6张图片

  • 在配置文件里配置了两个 Logger ,都输出给 STDOUT appender ,因此 “ === 我输出了 === ” 被打印了两次,
  • 当我移除掉了名字为 “ com.kgo.logger.logback” Logger的Appender , 下面的 日志仅输出了一次 (Root 的输出),
  • 当将root的appender 也移除掉后,日志不在输出(没有了输出对象)。

就先分享到这里,接下里会写一篇 自定义appender ,并且动态添加append的 博客 ,本系列的博客目标 为 实现 日志的 全自动化
包括:收集,上传,分类 ,自定义字段,实时更新,elk 等。

如果感觉有用,点个赞再走吧,大佬

------------------------------------------------------- 这就是我的底线了 --------------------------------------------------------------

你可能感兴趣的:(logback)