-
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(zapslog): implement stack trace handling (#1339)
fix: #1329 As discussed in the issue, replacing the `HandlersOptions` with functional options, i also renamed `addSource` to `addCaller` to properly match the `zap` semantic. --------- Co-authored-by: Abhinav Gupta <mail@abhinavg.net>
- Loading branch information
Showing
6 changed files
with
123 additions
and
42 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
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,72 @@ | ||
| // Copyright (c) 2023 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. | ||
|
|
||
| //go:build go1.21 | ||
|
|
||
| package zapslog | ||
|
|
||
| import "log/slog" | ||
|
|
||
| // An Option configures a slog Handler. | ||
| type Option interface { | ||
| apply(*Handler) | ||
| } | ||
|
|
||
| // optionFunc wraps a func so it satisfies the Option interface. | ||
| type optionFunc func(*Handler) | ||
|
|
||
| func (f optionFunc) apply(handler *Handler) { | ||
| f(handler) | ||
| } | ||
|
|
||
| // WithName configures the Logger to annotate each message with the logger name. | ||
| func WithName(name string) Option { | ||
| return optionFunc(func(h *Handler) { | ||
| h.name = name | ||
| }) | ||
| } | ||
|
|
||
| // WithCaller configures the Logger to include the filename and line number | ||
| // of the caller in log messages--if available. | ||
| func WithCaller(enabled bool) Option { | ||
| return optionFunc(func(handler *Handler) { | ||
| handler.addCaller = enabled | ||
| }) | ||
| } | ||
|
|
||
| // WithCallerSkip increases the number of callers skipped by caller annotation | ||
| // (as enabled by the [WithCaller] option). | ||
| // | ||
| // When building wrappers around the Logger, | ||
| // supplying this Option prevents Zap from always reporting | ||
| // the wrapper code as the caller. | ||
| func WithCallerSkip(skip int) Option { | ||
| return optionFunc(func(log *Handler) { | ||
| log.callerSkip += skip | ||
| }) | ||
| } | ||
|
|
||
| // AddStacktraceAt configures the Logger to record a stack trace | ||
| // for all messages at or above a given level. | ||
| func AddStacktraceAt(lvl slog.Level) Option { | ||
| return optionFunc(func(log *Handler) { | ||
| log.addStackAt = lvl | ||
| }) | ||
| } |