Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(log): support customization of log json marshal #18429

Merged
merged 13 commits into from
Nov 12, 2023
Merged

feat(log): support customization of log json marshal #18429

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f029c91
feat: support customization of json marshal
lilasxie Nov 10, 2023
a3ae7b2
update changelog.md
lilasxie Nov 10, 2023
9c77618
Update log/CHANGELOG.md
lilasxie Nov 10, 2023
0ef59d0
Update log/options.go
lilasxie Nov 10, 2023
1404ef9
Update log/options.go
lilasxie Nov 10, 2023
eb9740d
fix: fix typo of any
lilasxie Nov 11, 2023
e95f6f4
refactor: remove init function
lilasxie Nov 11, 2023
ee15a68
refactor: simplify switch statement
lilasxie Nov 11, 2023
757f332
refactor: refactor the implementation of json marshaler customization
lilasxie Nov 11, 2023
1233ff2
Update log/logger.go
lilasxie Nov 11, 2023
9fcb000
Update logger.go
lilasxie Nov 11, 2023
a8e29de
revert switch statement simplify
lilasxie Nov 11, 2023
e77c305
Merge branch 'main' into feat/custom-log-json-marshal
julienrbrt Nov 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions log/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Each entry must include the Github issue reference in the following format:

## [Unreleased]

* [#18429](https://github.com/cosmos/cosmos-sdk/pull/18429) Support customization of log json marshal.

## [v1.2.1](https://github.com/cosmos/cosmos-sdk/releases/tag/log/v1.2.1) - 2023-08-25

* [#17532](https://github.com/cosmos/cosmos-sdk/pull/17532) Proper marshalling of `fmt.Stringer` (follow-up of [#17205](https://github.com/cosmos/cosmos-sdk/pull/17205)).
Expand Down
17 changes: 12 additions & 5 deletions log/logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package log

import (
"encoding"
"encoding/json"
"fmt"
"io"
Expand All @@ -14,10 +13,6 @@ import (
func init() {
zerolog.InterfaceMarshalFunc = func(i interface{}) ([]byte, error) {
switch v := i.(type) {
case json.Marshaler:
lilasxie marked this conversation as resolved.
Show resolved Hide resolved
return json.Marshal(i)
case encoding.TextMarshaler:
return json.Marshal(i)
case fmt.Stringer:
return json.Marshal(v.String())
default:
lilasxie marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -57,6 +52,18 @@ type Logger interface {
Impl() any
}

// WithJSONMarshal configures zerolog global json encoding.
func WithJSONMarshal(marshaler func(v any) ([]byte, error)) {
zerolog.InterfaceMarshalFunc = func(i any) ([]byte, error) {
switch v := i.(type) {
case fmt.Stringer:
lilasxie marked this conversation as resolved.
Show resolved Hide resolved
lilasxie marked this conversation as resolved.
Show resolved Hide resolved
return marshaler(v.String())
default:
return marshaler(i)
}
}
}

type zeroLogWrapper struct {
*zerolog.Logger
}
Expand Down