如何将完整的对象添加到 Serilog Azure Tablestorage 接收器，该对象未在消息中写出？

Question

所以，我现在正在尝试将 Serilog 包含在我的应用程序中，并且想知道以下内容：

是否可以添加一个对象，以便我的 Azure Tablestorage 接收器将其提取并在相应的“数据”列中将其完全写入 JSON，而不将其添加到纯文本消息中？

我最初的方法是这样的：

m_logger.Information("{message} @{context}", message, context);

这就是我的问题的来源。 这行得通，但我想让消息本身保持人类可读性，并将上下文中的元数据保存在单独的列中。

所以，我的第二次尝试现在看起来像这样：

using (LogContext.PushProperty("context", context))
{
    m_logger.Information("{message}", message);
}

鉴于，我将此添加到我的记录器配置中： .Enrich.FromLogContext()

现在这种工作，该对象不再出现在消息中，而是实际添加到数据中，但不是将其完全写出到 JSON，这就是我在 Tablestorage 端点上的数据列中得到的结果：

{"Timestamp":"2019-09-01T08:52:29.4835746+02:00","Level":"Information","MessageTemplate":"{message}","Properties":{"message":"Login happened","context":"MooMed.Core.DataTypes.Session.Context"}}

所以，看起来这在内部只是调用.ToString() 。

我现在想知道是否有内置的方法来递归地对对象进行 jsonify，或者我是否必须（似乎）只是在我的Context类中覆盖.ToString() ？

Answer 1

除非您明确告诉 Serilog 解构您的上下文数据，否则它只会使用ToString表示。 在您最初的方法中，您告诉 Serilog 使用@符号进行解构（尽管我假设您在花括号内而不是在外使用它，即{@context}而不是@{context}否则这不应该起作用） .

使用LogContext您可以通过在推送属性时传递标志来告诉 Serilog 解构对象：

using (LogContext.PushProperty("context", context, destructureObjects: true))
{
    // ...
}

我假设您知道这会将上下文添加到using块内记录的所有消息中，包括发生在调用堆栈下方的任何消息。 作为替代方案，如果您想更好地控制将上下文添加到哪些消息，您还可以创建一个临时记录器，其中包含此上下文数据。 这是使用ILogger.ForContext方法完成的：

var enrichedLogger = m_logger.ForContext("context", context, destructureObjects: true);

// Use `enrichedLogger` instead of `m_logger` whenever you want context data included.
enrichedLogger.Information("This message has context data attached!");
m_logger.Information("This message does not have context data attached.");

您还可以使用上述相同的方法向单个消息添加上下文：

m_logger.ForContext("context", context, destructureObjects: true)
    .Information("This message has context data attached!")