type Option … type optionFunc … func (f optionFunc) apply(log *Logger) { … } // WrapCore wraps or replaces the Logger's underlying zapcore.Core. func WrapCore(f func(zapcore.Core) zapcore.Core) Option { … } // Hooks registers functions which will be called each time the Logger writes // out an Entry. Repeated use of Hooks is additive. // // Hooks are useful for simple side effects, like capturing metrics for the // number of emitted logs. More complex side effects, including anything that // requires access to the Entry's structured fields, should be implemented as // a zapcore.Core instead. See zapcore.RegisterHooks for details. func Hooks(hooks ...func(zapcore.Entry) error) Option { … } // Fields adds fields to the Logger. func Fields(fs ...Field) Option { … } // ErrorOutput sets the destination for errors generated by the Logger. Note // that this option only affects internal errors; for sample code that sends // error-level logs to a different location from info- and debug-level logs, // see the package-level AdvancedConfiguration example. // // The supplied WriteSyncer must be safe for concurrent use. The Open and // zapcore.Lock functions are the simplest ways to protect files with a mutex. func ErrorOutput(w zapcore.WriteSyncer) Option { … } // Development puts the logger in development mode, which makes DPanic-level // logs panic instead of simply logging an error. func Development() Option { … } // AddCaller configures the Logger to annotate each message with the filename, // line number, and function name of zap's caller. See also WithCaller. func AddCaller() Option { … } // WithCaller configures the Logger to annotate each message with the filename, // line number, and function name of zap's caller, or not, depending on the // value of enabled. This is a generalized form of AddCaller. func WithCaller(enabled bool) Option { … } // AddCallerSkip increases the number of callers skipped by caller annotation // (as enabled by the AddCaller option). When building wrappers around the // Logger and SugaredLogger, supplying this Option prevents zap from always // reporting the wrapper code as the caller. func AddCallerSkip(skip int) Option { … } // AddStacktrace configures the Logger to record a stack trace for all messages at // or above a given level. func AddStacktrace(lvl zapcore.LevelEnabler) Option { … } // IncreaseLevel increase the level of the logger. It has no effect if // the passed in level tries to decrease the level of the logger. func IncreaseLevel(lvl zapcore.LevelEnabler) Option { … } // WithPanicHook sets a CheckWriteHook to run on Panic/DPanic logs. // Zap will call this hook after writing a log statement with a Panic/DPanic level. // // For example, the following builds a logger that will exit the current // goroutine after writing a Panic/DPanic log message, but it will not start a panic. // // zap.New(core, zap.WithPanicHook(zapcore.WriteThenGoexit)) // // This is useful for testing Panic/DPanic log output. func WithPanicHook(hook zapcore.CheckWriteHook) Option { … } // OnFatal sets the action to take on fatal logs. // // Deprecated: Use [WithFatalHook] instead. func OnFatal(action zapcore.CheckWriteAction) Option { … } // WithFatalHook sets a CheckWriteHook to run on fatal logs. // Zap will call this hook after writing a log statement with a Fatal level. // // For example, the following builds a logger that will exit the current // goroutine after writing a fatal log message, but it will not exit the // program. // // zap.New(core, zap.WithFatalHook(zapcore.WriteThenGoexit)) // // It is important that the provided CheckWriteHook stops the control flow at // the current statement to meet expectations of callers of the logger. // We recommend calling os.Exit or runtime.Goexit inside custom hooks at // minimum. func WithFatalHook(hook zapcore.CheckWriteHook) Option { … } // WithClock specifies the clock used by the logger to determine the current // time for logged entries. Defaults to the system clock with time.Now. func WithClock(clock zapcore.Clock) Option { … }
Codebase Browser
kubernetes