原文： https://howtodoinjava.com/log4j2/threadcontext-fish-tagging/

Log4j2 ThreadContext允许您使用多个唯一的标签标记日志语句，以分析日志，同时在运行时诊断问题 - 主要是在多线程应用中，其中应用会在短时间内生成大量日志。 例如。 您可能需要扫描所有日志以查找特定的用户事务或完成会话。 此过程也称为鱼标（即，在每个日志语句中添加一些额外的上下文信息）。 鱼标可以帮助使用自动化工具记录日志，例如 Splunk 。

让我们看看如何在 log4j2 中将ThreadContext类用于鱼标。

在ThreadContext中添加上下文信息

为了唯一标记每个请求，ThreadContext提供了put(String key, String value)方法，该方法接受键及其值。 您可以根据需要添加任意数量的标签以捕获整个上下文信息。 请注意，ThreadContext类的所有方法都是静态的。

  1. package com.howtodoinjava.log4j2.examples;
  3. import java.util.UUID;
  5. import org.apache.logging.log4j.LogManager;
  6. import org.apache.logging.log4j.Logger;
  7. import org.apache.logging.log4j.ThreadContext;
  9. public class Log4j2HelloWorldExample 
  10. {
  11.     private static final Logger LOGGER = LogManager.getLogger(Log4j2HelloWorldExample.class.getName());
  13.     public static void main(String[] args) 
  14.     {
  15.         //Add context information
  16.         ThreadContext.put("id", UUID.randomUUID().toString());
  17.         ThreadContext.put("ipAddress", "192.168.21.9");
  19.         LOGGER.debug("Debug Message Logged !!");
  20.         LOGGER.info("Info Message Logged !!");
  21.         LOGGER.debug("Another Debug Message !!");
  23.         //Clear the map
  24.         ThreadContext.clearMap();
  26.         LOGGER.debug("Thread Context Cleaned up !!");
  27.         LOGGER.debug("Log message with no context information !!");
  28.     }
  29. }

或者，您可以将ThreadContext的Stack实现与ThreadContext.push(String value)协作，如下所示：

  1. //Add context information
  2. ThreadContext.push(UUID.randomUUID().toString());
  3. ThreadContext.push("192.168.21.9");
  5. LOGGER.debug("Debug Message Logged !!");
  6. LOGGER.info("Info Message Logged !!");
  7. LOGGER.debug("Another Debug Message !!");
  9. //Clear the map
  10. ThreadContext.clearStack();
  12. LOGGER.debug("Thread Context Cleaned up !!");
  13. LOGGER.debug("Log message with no context information !!");

事务处理结束或不再需要上下文信息后，可以使用ThreadContext.clearMap()方法清空信息。

默认情况下，ThreadContext的栈和映射是按线程管理的，并且基于ThreadLocal。 通过将系统属性isThreadContextMapInheritable设置为true，上下文映射的内容将传递给子线程。

修改log4j2.xml中的转换模式

现在要在日志语句中打印以上标记，您需要在 log4j2 配置文件中修改转换模式。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Configuration status="INFO">
  3.     <Appenders>
  4.         <Console name="console" target="SYSTEM_OUT">
  5.             <PatternLayout
  6.                 pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] [%X{id}] [%X{ipAddress}] %c{1} - %msg%n" />
  7.         </Console>
  8.     </Appenders>
  9.     <Loggers>
  10.         <Root level="debug" additivity="false">
  11.             <AppenderRef ref="console" />
  12.         </Root>
  13.     </Loggers>
  14. </Configuration>
  • 单独使用%X可以包含映射的全部内容。
  • 使用%X{key}包含指定的键。
  • 使用%x包含栈的全部内容。

现在，当您运行上面的代码时 – 您将获得以下输出：

  2. [DEBUG] 2016-06-21 13:09:56.485 [main] [7cdd4cf0-2c26-4b81-b374-1adce3781499] [192.168.21.9] Log4j2HelloWorldExample - Debug Message Logged !!
  3. [INFO ] 2016-06-21 13:09:56.487 [main] [7cdd4cf0-2c26-4b81-b374-1adce3781499] [192.168.21.9] Log4j2HelloWorldExample - Info Message Logged !!
  4. [DEBUG] 2016-06-21 13:09:56.487 [main] [7cdd4cf0-2c26-4b81-b374-1adce3781499] [192.168.21.9] Log4j2HelloWorldExample - Another Debug Message !!
  5. [DEBUG] 2016-06-21 13:09:56.487 [main] [] [] Log4j2HelloWorldExample - Thread Context Cleaned up !!
  6. [DEBUG] 2016-06-21 13:09:56.487 [main] [] [] Log4j2HelloWorldExample - Log message with no context information !!

如您所见，前三个日志语句中添加了上下文信息 - 其他两个语句没有此类信息。

学习愉快！