java - 记录可选键值

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 的方法。