-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support custom ReflectType encoder (#1039)
This adds support for overriding the mechanism we use to encode `ReflectType` fields. That is, in the following, log.Info("foo", zap.Reflect("bar", baz)) It allows `baz` to be serialized using a third-party JSON library by providing a custom ReflectedEncoder in the zapcore.EncoderConfig. `encoding/json`'s Encoder type is a valid ReflectedEncoder. Resolves #1034 Co-authored-by: Sung Yoon Whang <[email protected]> Co-authored-by: Abhinav Gupta <[email protected]>
- Loading branch information
1 parent
9367581
commit 369c1bd
Showing
5 changed files
with
119 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
// Copyright (c) 2016 Uber Technologies, Inc. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a copy | ||
// of this software and associated documentation files (the "Software"), to deal | ||
// in the Software without restriction, including without limitation the rights | ||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
// copies of the Software, and to permit persons to whom the Software is | ||
// furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
// THE SOFTWARE. | ||
|
||
package zapcore | ||
|
||
import ( | ||
"encoding/json" | ||
"io" | ||
) | ||
|
||
// ReflectedEncoder serializes log fields that can't be serialized with Zap's | ||
// JSON encoder. These have the ReflectType field type. | ||
// Use EncoderConfig.NewReflectedEncoder to set this. | ||
type ReflectedEncoder interface { | ||
// Encode encodes and writes to the underlying data stream. | ||
Encode(interface{}) error | ||
} | ||
|
||
func defaultReflectedEncoder(w io.Writer) ReflectedEncoder { | ||
enc := json.NewEncoder(w) | ||
// For consistency with our custom JSON encoder. | ||
enc.SetEscapeHTML(false) | ||
return enc | ||
} |