Spring日志输出级别的热更新

Bertha 。 2021-12-15 16:05 247阅读 0赞

这个问题是我曾经的一个问题，虽然比较容易解决，但是一直没有去写下来。

**问题**是这样的：  
一般在开发环境下使用DEBUG级别的日志输出是为了方便查看问题，而在线上一般都使用INFO、WARN、ERROR级别的日志，主要记录业务操作或者错误的日志。

**下面几种场景：**  
1、针对上面问题所述的情况，我们正常的操作是这样的：  
开发的时候本地修改日志输出级别，如果打的包是上生产环境的包（不管你用手工还是CI打包工具），会把这个日志级别修改为你线上环境的级别。

2、假设我们线上环境出了相关问题，开发人员说，我debug日志中打了重要内容，我想看一下。这个时候运维的正常做法是先修改日志级别配置然后重启服务。哒哒哒你可以看到debug日志了，然后开发人员排查完问题后，运维再把日志级别修改回去。

3、那么如果你部署的节点是不可停机的呢？或者领导不允许进行停机呢？程序猿内心开始抓狂、焦虑（what the fuck）……

**解决思路**  
思路？哪有什么特别的思路，即便是日志配置文件，也肯定被解析成一个日志管理类了。实现不停机修改日志级别，就是找到对应的托管类，动态更新里面的日志级别就完事了呗！  
纳尼？区别是有的人知道怎么弄，有的人不知道。  
Spring中可以通过注入 `LoggingSystem` 来随时更新（也可以动态添加）日志级别。  
例如：

@Autowired
    	private LoggingSystem loggingSystem;
        // 省略代码
        loggingSystem.setLogLevel("com.shanhy.demo", "DEBUG");
        // 省略代码

你可以**写一个Controller**，提供一个请求，通过传入日志setLogLevel需要的2个参数，可以进行请求变更。比如你要变更日志级别的时候，找运维curl或wget敲一下http请求即可。

--------------------

而**我的做法**是这样的：我接入的配置中心（Apollo），在程序中可以监听配置中心的变更事件。这样我需要调整日志级别的时候，在配置中心里修改日志级别即可。  
下面是我的完整代码类：

import org.apache.commons.lang3.StringUtils;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.logging.LogLevel;
    import org.springframework.boot.logging.LoggingSystem;
    import org.springframework.context.annotation.Configuration;
    
    import com.ctrip.framework.apollo.model.ConfigChange;
    import com.ctrip.framework.apollo.model.ConfigChangeEvent;
    import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
    
    /**
     * 热更新Apollo中的日志打印
     * 一般在开发环境下使用DEBUG级别的日志输出是为了方便查看问题，而在线上一般都使用INFO或者ERROR级别的日志，主要记录业务操作或者错误的日志。
     * 
     * 但是如果我们可以随时根据实际情况热调整日志的输出就接近完美了，所以该类实现了该功能，监听Apollo中的配置，热更新日志，这样我们可以实现随时根据实际情况调整日志的数据。
     * 特别有利于解决线上问题（当然，调整日志的输出级别，我们从前都是修改配置文件重启服务来实现的，那样在线上发现问题的时候分析日志不是很好）
     * 
     * @author 单红宇
     * @date 2019年7月2日
     *
     */
    @Configuration
    public class LoggerConfig {
    
    	private static final Logger logger = LoggerFactory.getLogger(LoggerConfig.class);
    	// 日志前缀TAG，springboot标准（对应在配置中心的示例为：logging.level.com.shanhy.demo 其实就是对应的 com.shanhy.demo 这个包）
    	private static final String LOGGER_TAG = "logging.level.";
    
    	@Autowired
    	private LoggingSystem loggingSystem;
    
    	/**
    	 * ApolloConfigChangeListener
    	 * 监听配置中心配置的更新事件，若该事件发生，则调用refreshLoggingLevels方法，处理该事件
    	 * 
    	 * @param changeEvent 可以获取被修改配置项的key集合，以及被修改配置项的新值、旧值和修改类型等信息
    	 */
    	@ApolloConfigChangeListener
    	private void configChangeListener(ConfigChangeEvent changeEvent) {
    		for (String key : changeEvent.changedKeys()) {
    			if(StringUtils.containsIgnoreCase(key, LOGGER_TAG)) {
    				ConfigChange change = changeEvent.getChange(key);
    				String strLevel = change.getNewValue() == null ? change.getOldValue() : change.getNewValue();
    				LogLevel level = LogLevel.valueOf(strLevel.toUpperCase());
    				loggingSystem.setLogLevel(key.replace(LOGGER_TAG, ""), level);
    				logger.info("{}={}", key, strLevel);
    			}
    		}
    	}
    	
    }

友情提醒，如果使用Apollo配置中心托管日志配置，需要在application.properties中添加如下内容：  
其原因如果你用了这个你就会知道，这里不做赘述。

#put apollo initialization before logging system initialization
    apollo.bootstrap.eagerLoad.enabled=true

因为线上我们对日志的等级变更需求频率是较低的，所以你可以选择你需要的方法。上面所说的Controller暴露一个请求的方法也是比较实用的（如果你是对网关的接口工程，注意请对该请求做一下权限处理）。

技术没有什么特殊的技术，思路也比较常规。仅供大家参考。

（END）