如何在 Serilog 中将对象序列化为字符串？

Question

我有很多这样的日志：

Log.Information("Submitting order {@order}", order);

此日志通过 RabbitMq -> LogStash -> Elastic 并最终生成大量字段（我假设每个属性一个字段）。最终我在 Elastic 中有成千上万的字段，这带来了各种各样的问题。

如果我将整个对象指定为参数，这通常意味着我不太关心它的所有字段是否都被解析，如果它被存储为单个字符串对象我会非常高兴（但仍然序列化为 json)。有没有办法在 Serilog 中自定义它？

Answer 1

我认为您可以使用 $ 运算符强制字符串化。而且我认为您可以覆盖 ToString 方法来调整输出。在serilog的documentation中也有一个简短的例子如何强制字符串化：

var unknown = new[] { 1, 2, 3 }
Log.Information("Received {$Data}", unknown);

这是日志功能的输出：

Received "System.Int32[]"

Answer 2

如果您乐于更改对象的 ToString() 表示，

效果很好。如果您已经覆盖 ToString() 或者您不希望它成为 return 一个 JSON 字符串，请考虑以下选项之一。

如果不想记录类型为 JSON all 的时候，可以考虑在记录消息时只序列化对象。这是最明确的方法，允许您选择哪些消息具有序列化形式，哪些消息具有解构形式，但它可能会使您的日志语句非常冗长：

// Using Newtonsoft.Json to serialize.
Log.Information("Submitting order {Order}", JsonConvert.SerializeObject(order));

如果您总是想要将一个类型序列化为JSON，您可以为该特定类型注册一个解构策略。这使您的日志语句简洁明了，并确保类型始终以相同的方式序列化：

// When configuring your logger.
Log.Logger = new LoggerConfiguration()
    .Destructure.ByTransforming<Order>(order => JsonConvert.SerializeObject(order))
    // ...

// This will use the destructurer registered above, so will convert to a JSON string.
Log.Information("Submitting order {@Order}", order);

// These will still use the ToString() method.
Log.Information("Submitting order {Order}", order);
Log.Information("Submitting order {$Order}", order);

这种方法的另一个优点是，如果你想改变你代表那种类型的对象的方式，或者如果你想恢复到默认的解构方法，你只需要改变配置时使用的策略记录器（即上面代码片段中的 lambda）。

如果您的序列化方法太复杂而无法放入 lambda 中，或者您想对大量类型使用相同的序列化方法，您可以定义自己的 IDestructuringPolicy 然后将其注册到类似方式：

class SerializationPolicy : IDestructuringPolicy
{
    public bool TryDestructure(object value, ILogEventPropertyValueFactory propertyValueFactory, out LogEventPropertyValue result)
    {
        // Check type of `value` and serialize if required.
    }
}

// When configuring your logger.
Log.Logger = new LoggerConfiguration()
    .Destructure.With<SerializationPolicy>()
    // ...

如何在 Serilog 中将对象序列化为字符串？

How to serialise an object as a string in Serilog?

serilog