[CLOB-1001] Add custom error value formatter to zerolog logging library #31
Conversation
|
@jonfung-dydx your pull request is missing a changelog! |
There was a problem hiding this comment.
Note that this change could be done within the SDK without needing to modify the Cosmos fork by updating root.go inside the PersistentPreRunE to set zerolog.ErrorMarshalFunc since it is a global variable.
| @@ -197,9 +199,39 @@ func CreateSDKLogger(ctx *Context, out io.Writer) (log.Logger, error) { | |||
| // Check if the CometBFT flag for trace logging is set and enable stack traces if so. | |||
| opts = append(opts, log.TraceOption(ctx.Viper.GetBool("trace"))) // cmtcli.TraceFlag | |||
|
|
|||
| // Error fields should be set under error object | |||
| zerolog.ErrorFieldName = "error" | |||
There was a problem hiding this comment.
This is the default in the library so we don't need to do it.
https://pkg.go.dev/github.com/rs/zerolog#section-readme
| zerolog.ErrorFieldName = "error" | ||
|
|
||
| // Add the kind and message field | ||
| zerolog.ErrorMarshalFunc = func(err error) interface{} { |
There was a problem hiding this comment.
We should guard this behind a flag to allow people to opt out of the custom marshalling function in case they aren't using datadog.
| } | ||
| objectToReturn := DatadogErrorTrackingObject{ | ||
| // Discard common prefix stack traces from zerolog call sites | ||
| Stack: stackArr[5:], |
There was a problem hiding this comment.
We should have a test for this to ensure that we are discarding exactly how much we want in case the stack depth changes due to a change in the implementation of this code or the underlying library.
|
Closing this. Did this in the protocol. |
For datadog error tracking, we want each error-based log field to have:
In order to do this, we introduce a custom error formatter to the zerolog logger that is used by
cometbft,cosmos-sdk, andv4-chain.This formatter will run on any log event
Key:Valuetag value of type errors and massage it to be of the above form.Thus, any error logs that have
"error": errorwill be automatically datadog error tracked.Note that
cosmos-sdkemits error logs with the key"err"instead of"error". Zerolog logging library is not powerful enough to support custom error event logging for stack traces in their customErrorStackMarshallingFunchere. We could PR into the library, but an easier solution we have done is to set up a datadog log pipeline that remaps allerrkeys intoerrorkeys. That way, we can datadog error trackcosmos-sdkerrors.TL;DR all
erroranderrkeys are now properly datadog error tracked.