记录可选键值

Question

我有这个网络应用程序，日志记录相当多。我们为每个请求线程实现了对

MDC

的调用，以便能够在日志中跟踪用户。

日志消息可能如下所示：

INFO  [2017-10-09 10:10:55,841] user_uuid=123-123-123 com.myapp.SomeClass: Some log message...

现在的问题是，大多数时候，不存在当前用户，并且我们没有使用上面日志示例中的

user_uuid

字段。所以，它看起来像这样：

INFO  [2017-10-09 10:10:55,841] user_uuid= com.myapp.SomeClass: Some log message...

如果没有MDC值，有没有办法不将MDC键和值写入日志？有些日志格式我还没有找到？

如果没有找到 MDC 值，我希望它看起来像这样：

INFO  [2017-10-09 10:10:55,841] com.myapp.SomeClass: Some log message...

上述（MDC）示例的配置如下：

%-5p [%d{ISO8601,UTC}] user_uuid=%mdc{user_uuid:-} %c: %m%n%rEx

Answer 1

您的模式中的此条目...

user_uuid=%mdc{user_uuid:-}

...由两部分组成：

1. 静态“根”（即赋值的左侧）始终存在于输出中。包含此内容的决定是在 Logback 初始化自身时做出的。

2. 一个值（即赋值的右侧），仅当填充了 MDC 属性

   user_uuid

   时，该值才会出现在输出中。包含此内容的决定是在运行时为每个日志事件做出的。

可能不会告诉您任何新内容，但关键点是左侧的包含不能通过评估应用程序发出的每个日志事件时启动的任何条件逻辑来撤消。 Logback 的

PatternLayoutBase

遍历其给定的模式，每次遇到有条件或可导出的内容时，它都会对其进行评估并将评估值附加到它正在遍历的模式中。所以，对于你的模式； Logback 在开始评估 MDC 条件之前就已经将“user_uuid=”分配给当前的 StringBuilder。

但是，您可以通过使用以下内容填充

user_uuid

MDC属性来实现所需的最终目标：

user_uuid=<the user id>

，然后更改记录模式以仅记录MDC值而不进行分配。例如：

%-5p [%d{ISO8601,UTC}] %mdc{user_uuid:-}%c: %m%n%rEx

使用该模式后，以下日志调用...

logger.info("Does this include the user_uuid?");
MDC.put("user_uuid", "user_uuid=me ");
logger.info("Or does this include the user_uuid?");

...会发出：

INFO  [2017-10-09 11:15:22,420] com.stackoverflow.SomeClassTest: Does this include the user_uuid?
INFO  [2017-10-09 11:15:22,435] user_uuid=me com.stackoverflow.SomeClassTest: Or does this include the user_uuid?

虽然这有点尴尬，因为您必须记住在 MDC 值末尾包含一个空格，并且此

user_uuid

MDC 值仅适用于在此特定模式内进行日志记录（而仅包含

user_uuid

- 没有左侧手边和等于运算符 - 会更普遍有用）。

如果这些缺点使这种方法对你来说无法使用，那么我认为你将不得不陷入 Logback 的

PatternLayoutBase

或

FormattingConverter

来实现某种形式的前瞻或某种修改正在进行的 StringBuilder 的方法（如果正确的话）赋值的手边返回一个空字符串。

Answer 2

如果缺少值，您可以使用

%replace

将

user_uuid=

替换为空字符串（请注意正则表达式中尾随的

$

，表示“输入结束”）：

%-5p [%d{ISO8601,UTC}]%replace( user_uuid=%mdc{user_uuid}){' user_uuid=$', ''} %c: %m%n%rEx

作为奖励，如果值丢失，上面的代码还会删除前导空格，因此如果值丢失，您的日志消息中不会出现两个连续的空格。

Answer 3

与 Alin Sînpălean 的回应类似，这个 hack 也将有助于处理尾随空格，

[text before]%replace( %X{any_key} ){'  ', ' '}[text after]

注意

%replace( %X{any_key} )

中包裹表达式的两个空格

如果变量为空，双空格将被替换为单空格，因此看起来一致：

[text before] [text after] 

如果它包含任何东西，它会被适当间隔

[text before] content [text after]