详解如何查看Elasticsearch的Debug日志

当我们遇到问题或者需要深入了解 Elasticsearch 的运行机制时，调整日志等级（logging level）到更详细的级别，比如DEBUG、TRACE，会是一个有效且必须要掌握的方法。

Elasticsearch 提供了如下的接口来支持动态变更 logging level，logger 后面是 package name 或者 class name。

1. PUT _cluster/settings 
2. { 
3.   "persistent": { 
4. "logger": { 
5.   "org.elasticsearch.action": "DEBUG" 
6. } 
7.   } 
8. } 

当然，你也可以去修改配置目录下面的 log4j2.properties，然后重启节点，但这种方法太过笨重，建议你不要用。

如果后续想要调整回默认设置，操作也简单，如下所示：

1. PUT _cluster/settings 
2. { 
3.   "persistent": { 
4. "logger": { 
5.   "org.elasticsearch.action": null 
6. } 
7.   } 
8. } 

上面的示例只是指定了一个 logger，当然也可以在一次请求中设定多个 logger，如下所示：

1. PUT _cluster/settings 
2. { 
3.   "persistent": { 
4. "logger": { 
5.   "_root": "INFO", 
6.   "org.elasticsearch.action": "DEBUG", 
7.   "org.elasticsearch.action.admin.cluster.health": "TRACE" 
8. } 
9.   } 
10. } 

上面的设定中，调用者的意图可能如下：

• root 的日志等级（默认所有 logger 的日志级别）设定为 INFO，虽然 log4j2.properties 中已经设定过了，保险起见，这里再指定一次。
• 设定 org.elasticsearch.action 这个 package 下所有 logger 的日志级别都为 DEBUG，需要查看下 transport action 的执行日志。
• 设定 org.elasticsearch.action.admin.cluster.health 这个 package 下所有 logger 的日志级别都为 TRACE，需要查看 Cluster Health 执行的更多日志。

但实际去运行时，Elasticsearch 并没有按照预期的结果去执行，没有相关DEBUG和TRACE级别的日志输出。这里直接给出原因和解决方案。

原因是 elasticsearch 在设定 logging level 时，会优先采用_root和parent logger的设定，这里和 log4j2.properties 中的设定有所差异。

上面的调用，最终结果是采用 _root 的设定，所有 logger 都是INFO，其他的设定都无效了。

解决方案如下，去除 _root 设定和 parent logger 的设定。

1. PUT _cluster/settings 
2. { 
3.   "persistent": { 
4. "logger": { 
5.   "_root": null, 
6.   "org.elasticsearch.action": null, 
7.   "org.elasticsearch.action.admin.cluster.health": "TRACE" 
8. } 
9.   } 
10. } 

下面就是源码分析了，感兴趣的可以继续看下去~

源码分析

相关实现逻辑在ClusterSetting.LoggingSettingUpdater里面，这里简单给下定位的思路，感兴趣的同学可以自己去翻下源码。

• rest 请求的入口是RestClusterUpdateSettingsAction，这里会转发请求到 master 节点
• master 处理的入口是TransportClusterUpdateSettingsAction，这里会去 update Cluster Setting，关键词为updater.updateSettings。
• 在 updateSettings的时候会调用所有的 ClusterSettingUpdater，Logging 就是其中之一。

apply setting 代码

1. for (String key : value.keySet()) { 
2. assert loggerPredicate.test(key); 
3. String component = key.substring("logger.".length()); 
4. if ("level".equals(component)) { 
5. continue; 
6. } 
7. if ("_root".equals(component)) { 
8. final String rootLevel = value.get(key); 
9. if (rootLevel == null) { 
10. Loggers.setLevel(LogManager.getRootLogger(), Loggers.LOG_DEFAULT_LEVEL_SETTING.get(settings)); 
11. } else { 
12. Loggers.setLevel(LogManager.getRootLogger(), rootLevel); 
13. } 
14. } else { 
15. Loggers.setLevel(LogManager.getLogger(component), value.get(key)); 
16. } 
17. } 

浅显易懂，不废话，而且这里的逻辑看起来很正常，那么继续来看下 Loggers.setLevel代码。

1. public static void setLevel(Logger logger, Level level) { 
2. if (!LogManager.ROOT_LOGGER_NAME.equals(logger.getName())) { 
3. Configurator.setLevel(logger.getName(), level); 
4. } else { 
5. final LoggerContext ctx = LoggerContext.getContext(false); 
6. final Configuration config = ctx.getConfiguration(); 
7. final LoggerConfig loggerConfig = config.getLoggerConfig(logger.getName()); 
8. loggerConfig.setLevel(level); 
9. ctx.updateLoggers(); 
10. } 
11. // we have to descend the hierarchy 
12. final LoggerContext ctx = LoggerContext.getContext(false); 
13. for (final LoggerConfig loggerConfig : ctx.getConfiguration().getLoggers().values()) { 
14. if (LogManager.ROOT_LOGGER_NAME.equals(logger.getName()) || loggerConfig.getName().startsWith(logger.getName() + ".")) { 
15. Configurator.setLevel(loggerConfig.getName(), level); 
16. } 
17. } 
18. } 

最后的处理逻辑会在每个 logger 设定完成后，去重新刷一遍现有的 logger，应用 root 或者 parent logger 的设定。

顺着代码的修改记录，找到了当初的修改 PR 如下：

[https://github.com/elastic/elasticsearch/pull/20463]()

其中也描述了修改的原因：

Today when setting the logging level via the command-line or an APIcall, the expectation is that the logging level should trickle down thehiearchy to descendant loggers. However, this is not necessarily thecase. For example, if loggers x and x.y are already configured thensetting the logging level on x will not descend to x.y. This is becausethe logging config for x.y has already been forked from the loggingconfig for x. Therefore, we must explicitly descend the hierarchy whensetting the logging level and that is what this commit does.

从这段描述看，当时要解决的问题是 x.y 没有继承 x logging level 的问题，所以加了这段显示继承的逻辑。

虽然这解决了继承的问题，但其行为本身与 log4j2.properties 中 logger 的修改逻辑就不一致了，难免带来困扰。

但考虑到这个配置是一个专家级别的配置，很少用户会使用，自己心里明白正确的使用方法就好了^_^