使用 zap logger 将 protobuf 消息记录为未转义的 JSON 格式

Question

我有一个Go项目，我使用Zap结构化日志记录来记录结构的内容。这就是我初始化记录器的方式：

zapLog, err := zap.NewProductionConfig().Build()

if err != nil {

    panic(err)

}

最初，我从我自己的结构开始，带有json标签，一切都很完美：

zapLog.Info("Event persisted", zap.Any("event", &event))

结果：

{"level":"info","ts":1626448680.69099,"caller":"persisters/log.go:56",

 "msg":"Event persisted","event":{"sourceType":4, "sourceId":"some-source-id", 

 "type":"updated", "value":"{...}", "context":{"foo":"bar"}}}

我现在切换到原型布夫，我正在努力实现相同的结果。最初，在使用zap时，我只是得到了“反射地图”版本。任何（）：

zapLog.Info("Event persisted", zap.Any("event", &event))

{"level":"info","ts":1626448680.69099,"caller":"persisters/log.go:56",

 "msg":"Event persisted","event":"sourceType:TYPE_X sourceId:\"some-source-id\", 

 type:\"updated\" value:{...}, context:<key: foo, value:bar>}

我尝试使用 jsonpb 编组器对对象进行编组，该编组器在自身上生成了正确的输出，但是，当我在 中使用它时，字符串被转义，因此我在每个引号前面得到一组额外的“\”。由于稍后会处理日志，因此这会导致问题，因此我想避免它：zap.String()

m := jsonpb.Marshaler{}

var buf bytes.Buffer

if err := m.Marshal(&buf, msg); err != nil {

    // handle error

}

zapLog.Info("Event persisted", zap.ByteString("event", buf.Bytes()))

结果：

{"level":"info","ts":1626448680.69099,"caller":"persisters/log.go:56",

 "msg":"Event persisted","event":"{\"sourceType\":\"TYPE_X\", \"sourceId\":\"some-source-id\", 

 \"type\":\"updated\", \"value\":\"{...}\", \"context\":{\"foo\":"bar\"}}"}

然后，我尝试使用最接近我需要的东西来代替它，除了枚举被渲染为它们的数值（初始解没有枚举，所以这在protobuf之前的解决方案中也不起作用）：zap.Reflect()zap.Any()

zapLog.Info("Event persisted", zap.Reflect("event", &event))

结果：

{"level":"info","ts":1626448680.69099,"caller":"persisters/log.go:56",

 "msg":"Event persisted","event":{"sourceType":4, "sourceId":"some-source-id", 

 "type":"updated", "value":"{...}", "context":{"foo":"bar"}}}

到目前为止，我看到的唯一选择是编写自己的函数：MarshalLogObject()

但是由于它是一个复杂的结构，我宁愿使用一个不易出错和维护较重的解决方案。理想情况下，我会告诉zap以某种方式使用jsonpb编组器，但我不知道这是否可能。

Answer 1

使用扎普。任何带有&nbsp;json 的内容。原始消息。您可以直接转换 的字节输出：jsonpb.Marshaler&nbsp;foo := &pb.FooMsg{&nbsp; &nbsp; &nbsp; &nbsp; Foo: "blah",&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; Bar:&nbsp; 1,&nbsp; &nbsp; }&nbsp; &nbsp; m := jsonpb.Marshaler{}&nbsp; &nbsp; var buf bytes.Buffer&nbsp; &nbsp; if err := m.Marshal(&buf, foo); err != nil {&nbsp; &nbsp; &nbsp; &nbsp; // handle error&nbsp; &nbsp; }&nbsp; &nbsp; logger, _ := zap.NewDevelopment()&nbsp; &nbsp; logger.Info("Event persisted", zap.Any("event", json.RawMessage(buf.Bytes())))字节将打印为：事件持久 {“事件”： {“foo”：“blah”，“bar”：“1”}}'我相信这是最简单的方法，但是我也知道一个包卡泽古苏里/go-proto-zap-marshaler（我不隶属于它），它生成实现作为原型插件。您可能也想看看。MarshalLogObject()

Answer 2

我使用了另一种方法来 json 化原型。由于原型可以自然地封送，我只是将它们包装在严格到json的封送处理器中。您可以修改内部结构以使用原型（较新的 jsonpb）。与上一个解决方案中的封送处理器不同，此封送处理程序不需要预先记录处理。type jsonObjectMarshaler struct {&nbsp; &nbsp; obj&nbsp; any}func (j *jsonObjectMarshaler) MarshalJSON() ([]byte, error) {&nbsp; &nbsp; bytes, err := json.Marshal(j.obj)&nbsp; &nbsp; // bytes, err := protojson.Marshal(j.obj)&nbsp; &nbsp; if err != nil {&nbsp; &nbsp; &nbsp; &nbsp; return nil, fmt.Errorf("json marshaling failed: %w", err)&nbsp; &nbsp; }&nbsp; &nbsp; return bytes, nil}func ZapJsonable(key string, obj any) zap.Field {&nbsp; &nbsp; return zap.Reflect(key, &jsonObjectMarshaler{obj: obj})}然后使用它，只是logger, _ := zap.NewDevelopment()logger.Info("Event persisted", ZapJsonable("event", buf))