feat(log): support customization of log json marshal #18429
Conversation
Walkthrough# Walkthrough
The recent changes aim to enhance the flexibility of JSON marshaling within the logging package. This is achieved by introducing a new field `JSONMarshal` to the `Config` struct, along with a corresponding function to set this field. The `zerolog.InterfaceMarshalFunc` is now conditionally set based on the presence of `logCfg.JSONMarshal`, allowing for custom JSON marshaling of various types. Additionally, the `init` function and `NewLogger` function have been modified to incorporate the new JSON marshaling logic.
# Changes
| File(s) | Change Summary |
| --------------------- | -------------------------------------------------------------------------------------------------------------------- |
| log/CHANGELOG.md | Added support for customization of log JSON marshaling through pull request #18429. |
| log/logger.go | Introduced a new conditional block to set the `zerolog.InterfaceMarshalFunc` based on `logCfg.JSONMarshal`. Modified the `init` and `NewLogger` functions to incorporate the new JSON marshaling logic. |
| log/options.go | Added a new field `JSONMarshal` to the `Config` struct and a corresponding function `JSONMarshalOption` to set this field. Imported the "encoding/json" package and assigned `json.Marshal` to the `JSONMarshal` field in the `defaultConfig` variable. |TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (3)
- log/CHANGELOG.md (1 hunks)
- log/logger.go (1 hunks)
- log/options.go (2 hunks)
Additional comments: 5
log/CHANGELOG.md (1)
- 23-24: The changelog entry is clear and concise, providing a link to the pull request for more details. Ensure that the link is correct and leads to the correct pull request.
log/logger.go (1)
- 74-90: The new conditional block allows for custom JSON marshaling of various types including
json.Marshaler,encoding.TextMarshaler, andfmt.Stringer. This enhances the flexibility of JSON marshaling within the logger. However, it's important to ensure that thelogCfg.JSONMarshalfunction is thoroughly tested to handle all these types correctly.log/options.go (3)
18-18: The default JSON marshaler is set to
json.Marshal. This is a sensible default, but it's important to ensure that all types that will be logged are compatible with this marshaler. If a type implements thejson.Marshalerinterface, that will be used instead.29-29: The
JSONMarshalfield is added to theConfigstruct. This allows for custom JSON marshaling functions to be used. This is a good addition for flexibility, but it's important to ensure that the provided function is safe and performs as expected.95-99: The
JSONMarshalOptionfunction is added. This function allows for theJSONMarshalfield in theConfigstruct to be set. This is a good addition for flexibility, but it's important to ensure that the provided function is safe and performs as expected.
julienrbrt
changed the title
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: Julien Robert <julien@rbrt.fr>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- log/options.go (2 hunks)
Additional comments: 3
log/options.go (3)
18-18: The default JSON marshaler is set to
json.Marshal. This is a good default as it is the standard way to marshal JSON in Go. However, it's important to note that this could be overridden by the user, potentially leading to unexpected behavior if the provided function does not properly marshal to JSON.29-29: The
JSONMarshalfield has been added to theConfigstruct. This allows for customization of the JSON marshaling function. This is a good addition as it allows for more flexibility in how JSON is marshaled.95-99: The
JSONMarshalOptionfunction has been added to set theJSONMarshalfield in theConfigstruct. This is a good addition as it allows for theJSONMarshalfield to be set in a consistent manner with the other options.
Co-authored-by: Julien Robert <julien@rbrt.fr>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (2)
- log/logger.go (2 hunks)
- log/options.go (2 hunks)
Additional comments: 4
log/options.go (3)
10-19: The
defaultConfighas been updated to includeJSONMarshal: json.Marshal. This is a sensible default as it uses the standard library's JSON marshaling function. Ensure that this default behavior is documented.22-30: A new field
JSONMarshalhas been added to theConfigstruct. This allows for custom JSON marshaling functions to be used. This is a good addition as it increases the flexibility of the logger.94-99: The
JSONMarshalOptionfunction has been added. This function allows for theJSONMarshalfield in theConfigstruct to be set. This is a good addition as it allows for the use of custom JSON marshaling functions.log/logger.go (1)
- 59-81: The new logic for setting the
jsonMarshalerand updating thezerolog.InterfaceMarshalFuncis sound. However, theinitfunction mentioned in the previous comment is not present in the provided code. If it exists elsewhere, consider removing it as suggested by the previous reviewer, since the initialization is now handled here.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- log/logger.go (2 hunks)
Additional comments: 2
log/logger.go (2)
64-66: The
jsonMarshaleris being set based on thelogCfg.JSONMarshal. IflogCfg.JSONMarshalisnil,json.Marshalis used as a default. This is a good practice as it provides a sensible default and allows for customization.67-75: The
InterfaceMarshalFuncis being set to handle different types of interfaces. This is a good practice as it allows for different types of interfaces to be marshaled correctly.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- log/logger.go (3 hunks)
Additional comments: 1
log/logger.go (1)
- 52-65: The
WithJSONMarshalfunction allows the user to specify a custom JSON marshaling function. This is a good addition for flexibility. However, it's important to note that this function changes the globalInterfaceMarshalFuncofzerolog, which could affect other parts of the application that also usezerolog. Make sure to document this side effect clearly.
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- log/logger.go (3 hunks)
Additional comments: 2
log/logger.go (2)
13-18: The previous comment about
InterfaceMarshalFuncbeing set in theinitfunction is still valid. Consider moving this to a function that is explicitly called by the user.52-65: The new
WithJSONMarshalfunction allows for custom JSON marshaling. Ensure that themarshalerfunction passed as an argument is robust and handles all necessary types. Also, consider adding error handling within this function to handle potential failures of themarshalerfunction.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- log/logger.go (3 hunks)
Additional comments: 2
log/logger.go (2)
13-18: The
initfunction has been updated to set thezerolog.InterfaceMarshalFuncto a function that accepts any type and returns a JSON marshaled byte array. This change allows for custom JSON marshaling of various types, enhancing flexibility. However, ensure that the custom marshaling function handles all types that may be passed to it, as the default case simply attempts to marshal the input without any type checking. This could potentially lead to runtime errors if an incompatible type is passed.52-65: The
WithJSONMarshalfunction has been added to configure global JSON encoding for zerolog. This function accepts a custom marshaler function and sets thezerolog.InterfaceMarshalFuncto a function that uses this custom marshaler. This is a good addition as it allows for customization of the JSON marshaling behavior. However, similar to theinitfunction, ensure that the custom marshaler function handles all types that may be passed to it.
when a struct implements stringer and json.Marshaller, we should use that one first.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (1)
- log/logger.go (2 hunks)
Additional comments: 1
log/logger.go (1)
- 17-17: The comment from julienrbrt suggests that there might be some code that was removed and should be brought back. Please verify if this is the case.
Description
support customization json marshal of the log sdk
Author Checklist
!to the type prefix if API or client breaking changeCHANGELOG.mdmake lintandmake testSummary by CodeRabbit