日志配置热更新技术实践

一 为什么需要服务日志热更新?

成都创新互联成立于2013年，是专业互联网技术服务公司，拥有项目成都网站设计、成都网站制作网站策划，项目实施与项目整合能力。我们以让每一个梦想脱颖而出为使命，1280元官渡做网站,已为上家服务,为官渡各地企业和个人服务,联系电话:13518219792

对于后端老鸟来说，一定遇到过这样的场景：

为了排查线上突发的问题，非常希望能够全面的看到请求在服务链路上的完整日志输出;

But，在生产环境中，为了避免日志打印过量造成磁盘空间浪费，通常会将日志级别设定在INFO，并关闭一般情况用不到的日志输出;

在不重启服务的情况下，开启本已经关闭的业务日志输出，能不能搞的定呢?答案是当然没问题。

二 需求分析

熟悉logback的同学此时肯定已经想到通过扫描监听logback.xml文件配置变化来实现日志级别的调整，像如下这种方式：

 
 
 
    
  
  
  
    2.

但通常情况下，你的业务服务是分布式部署的，后端节点有多台，如果一台台的去改，且不说运维大哥未必就会同意给你生产机器文件的修改权限，即使可以，这么做未免有些过于“老实”了;有没有一种可以集中管理日志配置，修改文件后再逐个分发给各节点的解决方案呢?沿着这个思路，自然而然就会联想到配置中心，这里，我主要介绍携程开源的apollo，同类的配置中心产品还有百度Disconf、阿里ACM和Spring Cloud Config，感兴趣的自行研究。

三 做实验

熟悉apollo文件管理的同学都知道，apollo通过推拉结合的方式将服务端存储的应用配置文件缓存到本地是以properties的格式存储的，如下面所示：

demo+dev+logback.xml.properties

 
 
 
    
  
  
  
  1. content=\n\n\t\n\n\t\n\t\t\n\t\t\t%d{yyyy-MM-dd HH\:mm\:ss.SSS}|%X{requestId}|[%t] %-5level %logger{50} %line - %m%n\n\t\t\n\t\n\n\t\n\t\tlogs/brm.log\n\t\t\n\t\t\t%d{yyyy-MM-dd HH\:mm\:ss.SSS}|%X{requestId}|%X{requestSeq}|[%t] %-5level %logger{50} %line - %m%n\n\t\t\n\t\t\n\t\t\tlogs/brm-%d{yyyy-MM-dd-HH}-%i.log>\n\t\t\t<\!--单个文件切割阈值，超过生成新log文件-->\n\t\t\t200MB\n\t\t\t<\!--最大保留天数-->\n\t\t\t336\n\t\t\n\t\n\n    <\!--log4jdbc -->\n    \n    \n    \n    \n    \n    \n        \n\t\n\t\t\n\t\t\n\t\n
    2.

HH\:mm\:ss.SSS}|%X{requestId}|%X{requestSeq}|[%t] %-5level %logger{50} %line - %m%n \n\t\t \n\t\t \n\t\t\t logs/brm-%d{yyyy-MM-dd-HH}-%i.log >\n\t\t\t<\!--单个文件切割阈值，超过生成新log文件-->\n\t\t\t 200MB \n\t\t\t<\!--最大保留天数-->\n\t\t\t 336 \n\t\t \n\t \n\n <\!--log4jdbc -->\n \n \n \n \n \n \n \n\t \n\t\t \n\t\t \n\t \n

而我们通常在配置logback的时候使用的是xml文件;

因此，我们要想办法让logback能够加载context的内存值信息。

阅读logback资料发现，JoranConfigurator支持我们以自定义的方式配置logback，

而springboot是通过LoggingSystem来加载管理日志系统的;如果我能在springboot启动的时候指定我自定义的日志加载类，问题便迎刃而解。

这里，我们在resources目录下新建META-INF文件夹，添加spring.factories，内容如下：

 
 
 
    
  
  
  
  1. org.springframework.context.ApplicationContextInitializer = com.zhoupu.zplog.refresher.LoggerRefresher
    2. 
  
  
  
  2. org.springframework.boot.env.EnvironmentPostProcessor = com.zhoupu.zplog.refresher.LoggerRefresher
    3.

这里我们定义一个LoggerRefresher，该类重写loadDefaults和loadConfiguration方法，通过JoranConfigurator加载logback配置，并在configureByApollo中添加一个apollo事件监听器，当发现logback.xml文件有变化时，重新执行configureByApollo方法刷新日志配置。

核心代码部分如下：

 
 
 
    
  
  
  
  1. package com.zhoupu.zplog.refresher;
    2. 
  
  
  
  2. 
  
  
  
  3. import ch.qos.logback.classic.LoggerContext;
    4. 
  
  
  
  4. import ch.qos.logback.classic.joran.JoranConfigurator;
    5. 
  
  
  
  5. import ch.qos.logback.core.joran.spi.JoranException;
    6. 
  
  
  
  6. import com.ctrip.framework.apollo.Config;
    7. 
  
  
  
  7. import com.ctrip.framework.apollo.ConfigChangeListener;
    8. 
  
  
  
  8. import com.ctrip.framework.apollo.ConfigService;
    9. 
  
  
  
  9. import com.ctrip.framework.apollo.model.ConfigChangeEvent;
    10. 
  
  
  
  10. import com.ctrip.framework.apollo.spring.config.PropertySourcesConstants;
    11. 
  
  
  
  11. import org.slf4j.ILoggerFactory;
    12. 
  
  
  
  12. import org.slf4j.Logger;
    13. 
  
  
  
  13. import org.slf4j.LoggerFactory;
    14. 
  
  
  
  14. import org.springframework.boot.SpringApplication;
    15. 
  
  
  
  15. import org.springframework.boot.env.EnvironmentPostProcessor;
    16. 
  
  
  
  16. import org.springframework.context.ApplicationContextInitializer;
    17. 
  
  
  
  17. import org.springframework.context.ConfigurableApplicationContext;
    18. 
  
  
  
  18. import org.springframework.core.Ordered;
    19. 
  
  
  
  19. import org.springframework.core.env.ConfigurableEnvironment;
    20. 
  
  
  
  20. import org.springframework.util.StringUtils;
    21. 
  
  
  
  21. 
  
  
  
  22. import javax.xml.parsers.DocumentBuilder;
    23. 
  
  
  
  23. import javax.xml.parsers.DocumentBuilderFactory;
    24. 
  
  
  
  24. import java.io.ByteArrayInputStream;
    25. 
  
  
  
  25. import java.io.UnsupportedEncodingException;
    26. 
  
  
  
  26. 
  
  
  
  27. /**
    28. 
  
  
  
  28.  *
    29. 
  
  
  
  29.  * @author vigor
    30. 
  
  
  
  30.  * @date 2019/6/14 上午11:27
    31. 
  
  
  
  31.  */
    32. 
  
  
  
  32. 
  
  
  
  33. public class LoggerRefresher implements ApplicationContextInitializer, EnvironmentPostProcessor, Ordered {
    34. 
  
  
  
  34.     private static final Logger log = LoggerFactory.getLogger(LoggerRefresher.class);
    35. 
  
  
  
  35. 
  
  
  
  36.     private boolean loadFlag = false;
    37. 
  
  
  
  37. 
  
  
  
  38.     @Override
    39. 
  
  
  
  39.     public void initialize(ConfigurableApplicationContext context) {
    40. 
  
  
  
  40.         ConfigurableEnvironment environment = context.getEnvironment();
    41. 
  
  
  
  41.         load(environment);
    42. 
  
  
  
  42. 
  
  
  
  43.     }
    44. 
  
  
  
  44. 
  
  
  
  45.     @Override
    46. 
  
  
  
  46.     public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
    47. 
  
  
  
  47.         load(environment);
    48. 
  
  
  
  48.     }
    49. 
  
  
  
  49. 
  
  
  
  50.     @Override
    51. 
  
  
  
  51.     public int getOrder() {
    52. 
  
  
  
  52.         return 1;
    53. 
  
  
  
  53.     }
    54. 
  
  
  
  54. 
  
  
  
  55.     private void load(ConfigurableEnvironment environment) {
    56. 
  
  
  
  56.         if (!loadFlag) {
    57. 
  
  
  
  57.             environment.getPropertySources().forEach(ps -> {
    58. 
  
  
  
  58.                 if (PropertySourcesConstants.APOLLO_BOOTSTRAP_PROPERTY_SOURCE_NAME.equals(ps.getName())) {
    59. 
  
  
  
  59.                     configureByApollo();
    60. 
  
  
  
  60.                     loadFlag = true;
    61. 
  
  
  
  61.                 }
    62. 
  
  
  
  62.             });
    63. 
  
  
  
  63.         }
    64. 
  
  
  
  64.     }
    65. 
  
  
  
  65. 
  
  
  
  66.     private void configureByApollo() {
    67. 
  
  
  
  67.         Config config = ConfigService.getConfig("logback.xml");
    68. 
  
  
  
  68. 
  
  
  
  69.         String content = config.getProperty("content", "");
    70. 
  
  
  
  70.         if (StringUtils.isEmpty(content) || !validateXML(content)) {
    71. 
  
  
  
  71.             return;
    72. 
  
  
  
  72.         }
    73. 
  
  
  
  73. 
  
  
  
  74.         config.addChangeListener(new ConfigChangeListener() {
    75. 
  
  
  
  75.             @Override
    76. 
  
  
  
  76.             public void onChange(ConfigChangeEvent changeEvent) {
    77. 
  
  
  
  77.                 configureByApollo();
    78. 
  
  
  
  78.             }
    79. 
  
  
  
  79. 
  
  
  
  80.             @Override
    81. 
  
  
  
  81.             public boolean equals(Object obj) {
    82. 
  
  
  
  82.                 if (this == obj) {
    83. 
  
  
  
  83.                     return true;
    84. 
  
  
  
  84.                 }
    85. 
  
  
  
  85.                 if (this.getClass().equals(obj.getClass())) {
    86. 
  
  
  
  86.                     return true;
    87. 
  
  
  
  87.                 }
    88. 
  
  
  
  88.                 return false;
    89. 
  
  
  
  89.             }
    90. 
  
  
  
  90. 
  
  
  
  91.             @Override
    92. 
  
  
  
  92.             public int hashCode() {
    93. 
  
  
  
  93.                 return 1;
    94. 
  
  
  
  94.             }
    95. 
  
  
  
  95.         });
    96. 
  
  
  
  96. 
  
  
  
  97.         ILoggerFactory loggerFactory = LoggerFactory.getILoggerFactory();
    98. 
  
  
  
  98.         LoggerContext loggerContext = (LoggerContext) loggerFactory;
    99. 
  
  
  
  99.         loggerContext.reset();
    100. 
  
  
  
  100.         JoranConfigurator configurator = new JoranConfigurator();
    101. 
  
  
  
  101.         configurator.setContext(loggerContext);
    102. 
  
  
  
  102.         try {
    103. 
  
  
  
  103.             configurator.doConfigure(new ByteArrayInputStream(content.getBytes("utf-8")));
    104. 
  
  
  
  104.             log.warn("*****************************logback configureByApollo success!********************************");
    105. 
  
  
  
  105.         } catch (JoranException e) {
    106. 
  
  
  
  106.             e.printStackTrace();
    107. 
  
  
  
  107.         } catch (UnsupportedEncodingException e) {
    108. 
  
  
  
  108.             e.printStackTrace();
    109. 
  
  
  
  109.         }
    110. 
  
  
  
  110.     }
    111. 
  
  
  
  111. 
  
  
  
  112.     private boolean validateXML(String xml){
    113. 
  
  
  
  113.         boolean isValidated = true;
    114. 
  
  
  
  114.         try {
    115. 
  
  
  
  115.             DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
    116. 
  
  
  
  116.             DocumentBuilder builder = documentBuilderFactory.newDocumentBuilder();
    117. 
  
  
  
  117.             builder.parse(new ByteArrayInputStream(xml.getBytes("utf-8")));
    118. 
  
  
  
  118.         } catch (Exception e) {
    119. 
  
  
  
  119.             log.error("apollo logback config error = {}", e);
    120. 
  
  
  
  120.             isValidated = false;
    121. 
  
  
  
  121.         }
    122. 
  
  
  
  122.         return isValidated;
    123. 
  
  
  
  123.     }
    124. 
  
  
  
  124. 
  
  
  
  125. }
    126.

至此已完成所有准备工作，运行demo程序，我的项目使用log4jdbc输出sql，这里我通过修改apollo配置管理后台jdbc日志配置，将sqltiming级别改为INFO：

 
 
 
    
  
  
  
    2. 
  
  
  
  2.     
    3. 
  
  
  
  3.     
    4. 
  
  
  
  4.     
    5. 
  
  
  
  5.     
    6. 
  
  
  
  6.     
    7. 
  
  
  
  7.     
    8.

发起一个后端请求，查看控制台日志输出，有了!

 
 
 
    
  
  
  
  1. 2019-11-08 10:11:27.794|1fe97e7dcfeb4fc2810d8a7a706fad2a||[http-nio-8062-exec-3] INFO  jdbc.sqltiming 357 - SELECT id, row_state, created_at, updated_at, created_by, updated_by, business_id, contact_name,
    2. 
  
  
  
  2. role, mobile, contact_type FROM t_business_contact WHERE row_state = 0 AND business_id = 1000006
    3.

惊不惊喜_，意不意外!

四 总结

一个简单的日志配置热更新尝试，串联起了logback的自定义配置加载原理，apollo的配置中心使用方法和事件监听机制，以及springboot日志管理和自动装配等知识点，希望大家能从中有所收获!

【本文是专栏机构“舟谱数据”的原创文章，微信公众号“舟谱数据( id: zhoupudata)”】

文章标题：日志配置热更新技术实践
文章出自：http://www.zyruijie.cn/qtweb/news31/8881.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

网站策划知识

各行业网站

成都响应式网站建设　　 　成都网站制作　　 　光华村机房　　 　帛金家居　　 　建站定制开发　　 　注册域名　　 　成都西云机房　　 　微官网开发　　 　边坡防护网厂家　　 　成都保温材料　　 　ssl数字证书　　 　成都响应式网站建设公司　　 　成都品牌官网设计公司　　 　成都木托盘　　 　子晨木包装箱　　 　眉山托管服务器　　 　微信小程序公众号开发　　 　成都网站代运营　　 　郫县封阳台　　 　微信小程序