const (
CONSOLE = iota
JSON
LOGFMT
)
const (
// DisabledLevel represents a disabled log level. Logs at this level should
// never be emitted.
DisabledLevel = zapcore.Level(math.MinInt8)
// PayloadLevel is used to log the extremely detailed message level debug
// information.
PayloadLevel = zapcore.Level(zapcore.DebugLevel - 1)
)
func ActivateSpec(spec string)
ActivateSpec is used to activate a logging specification.
func DefaultLevel() string
DefaultLevel returns the fallback value for loggers to use if parsing fails.
func GetLoggerLevel(loggerName string) string
GetLoggerLevel gets the current logging level for the logger with the provided name.
func Init(config Config)
Init initializes logging with the provided config.
func InitBackend(formatter logging.Formatter, output io.Writer)
InitBackend sets up the logging backend based on the provided logging formatter and I/O writer.
func InitFromSpec(spec string) string
InitFromSpec initializes the logging based on the supplied spec. It is exposed externally so that consumers of the flogging package may parse their own logging specification. The logging specification has the following form:
[<logger>[,<logger>...]=]<level>[:[<logger>[,<logger>...]=]<logger>...]
func IsValidLevel(level string) bool
func NameToLevel(level string) zapcore.Level
NameToLevel converts a level name to a zapcore.Level. If the level name is unknown, zapcore.InfoLevel is returned.
func NewGRPCLogger(l *zap.Logger) *zapgrpc.Logger
NewGRPCLogger creates a grpc.Logger that delegates to a zap.Logger.
func NewZapLogger(core zapcore.Core, options ...zap.Option) *zap.Logger
NewZapLogger creates a zap logger around a new zap.Core. The core will use the provided encoder and sinks and a level enabler that is associated with the provided logger name. The logger that is returned will be named the same as the logger.
func Reset()
Reset sets logging to the defaults defined in this package.
Used in tests and in the package init
func SetFormat(formatSpec string) logging.Formatter
SetFormat sets the logging format.
Config is used to provide dependencies to a Logging instance.
type Config struct {
// Format is the log record format specifier for the Logging instance. If the
// spec is the string "json", log records will be formatted as JSON. Any
// other string will be provided to the FormatEncoder. Please see
// fabenc.ParseFormat for details on the supported verbs.
//
// If Format is not provided, a default format that provides basic information will
// be used.
Format string
// LogSpec determines the log levels that are enabled for the logging system. The
// spec must be in a format that can be processed by ActivateSpec.
//
// If LogSpec is not provided, loggers will be enabled at the INFO level.
LogSpec string
// Writer is the sink for encoded and formatted log records.
//
// If a Writer is not provided, os.Stderr will be used as the log sink.
Writer io.Writer
}
Core is a custom implementation of a zapcore.Core. It's a terrible hack that only exists to work around the intersection of state associated with encoders, implementation hiding in zapcore, and implicit, ad-hoc logger initialization within fabric.
In addition to encoding log entries and fields to a buffer, zap Encoder implementations also need to maintain field state. When zapcore.Core.With is used, the associated encoder is cloned and the fields are added to the encoder. This means that encoder instances cannot be shared across cores.
In terms of implementation hiding, it's difficult for our FormatEncoder to cleanly wrap the JSON and console implementations from zap as all methods from the zapcore.ObjectEncoder would need to be implemented to delegate to the correct backend.
This implementation works by associating multiple encoders with a core. When fields are added to the core, the fields are added to all of the encoder implementations. The core also references the logging configuration to determine the proper encoding to use, the writer to delegate to, and the enabled levels.
type Core struct {
zapcore.LevelEnabler
Levels *LoggerLevels
Encoders map[Encoding]zapcore.Encoder
Selector EncodingSelector
Output zapcore.WriteSyncer
Observer Observer
}
func (c *Core) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
func (c *Core) Sync() error
func (c *Core) With(fields []zapcore.Field) zapcore.Core
func (c *Core) Write(e zapcore.Entry, fields []zapcore.Field) error
type Encoding int8
EncodingSelector is used to determine whether log records are encoded as JSON or in human readable CONSOLE or LOGFMT formats.
type EncodingSelector interface {
Encoding() Encoding
}
A FabricLogger is an adapter around a zap.SugaredLogger that provides structured logging capabilities while preserving much of the legacy logging behavior.
The most significant difference between the FabricLogger and the zap.SugaredLogger is that methods without a formatting suffix (f or w) build the log entry message with fmt.Sprintln instead of fmt.Sprint. Without this change, arguments are not separated by spaces.
type FabricLogger struct {
// contains filtered or unexported fields
}
func MustGetLogger(loggerName string) *FabricLogger
MustGetLogger creates a logger with the specified name. If an invalid name is provided, the operation will panic.
func NewFabricLogger(l *zap.Logger, options ...zap.Option) *FabricLogger
NewFabricLogger creates a logger that delegates to the zap.SugaredLogger.
func (f *FabricLogger) Critical(args ...interface{})
for backwards compatibility
func (f *FabricLogger) Criticalf(template string, args ...interface{})
func (f *FabricLogger) DPanic(args ...interface{})
func (f *FabricLogger) DPanicf(template string, args ...interface{})
func (f *FabricLogger) DPanicw(msg string, kvPairs ...interface{})
func (f *FabricLogger) Debug(args ...interface{})
func (f *FabricLogger) Debugf(template string, args ...interface{})
func (f *FabricLogger) Debugw(msg string, kvPairs ...interface{})
func (f *FabricLogger) Error(args ...interface{})
func (f *FabricLogger) Errorf(template string, args ...interface{})
func (f *FabricLogger) Errorw(msg string, kvPairs ...interface{})
func (f *FabricLogger) Fatal(args ...interface{})
func (f *FabricLogger) Fatalf(template string, args ...interface{})
func (f *FabricLogger) Fatalw(msg string, kvPairs ...interface{})
func (f *FabricLogger) Info(args ...interface{})
func (f *FabricLogger) Infof(template string, args ...interface{})
func (f *FabricLogger) Infow(msg string, kvPairs ...interface{})
func (f *FabricLogger) IsEnabledFor(level zapcore.Level) bool
func (f *FabricLogger) Named(name string) *FabricLogger
func (f *FabricLogger) Notice(args ...interface{})
func (f *FabricLogger) Noticef(template string, args ...interface{})
func (f *FabricLogger) Panic(args ...interface{})
func (f *FabricLogger) Panicf(template string, args ...interface{})
func (f *FabricLogger) Panicw(msg string, kvPairs ...interface{})
func (f *FabricLogger) Sync() error
func (f *FabricLogger) Warn(args ...interface{})
func (f *FabricLogger) Warnf(template string, args ...interface{})
func (f *FabricLogger) Warning(args ...interface{})
func (f *FabricLogger) Warningf(template string, args ...interface{})
func (f *FabricLogger) Warnw(msg string, kvPairs ...interface{})
func (f *FabricLogger) With(args ...interface{}) *FabricLogger
func (f *FabricLogger) WithOptions(opts ...zap.Option) *FabricLogger
func (f *FabricLogger) Zap() *zap.Logger
LoggerLevels tracks the logging level of named loggers.
type LoggerLevels struct {
// contains filtered or unexported fields
}
func (l *LoggerLevels) ActivateSpec(spec string) error
ActivateSpec is used to modify logging levels.
The logging specification has the following form:
[<logger>[,<logger>...]=]<level>[:[<logger>[,<logger>...]=]<level>...]
func (l *LoggerLevels) DefaultLevel() zapcore.Level
DefaultLevel returns the default logging level for loggers that do not have an explicit level set.
func (l *LoggerLevels) Enabled(lvl zapcore.Level) bool
Enabled function is an enabled check that evaluates the minimum active logging level. It serves as a fast check before the (relatively) expensive Check call in the core.
func (l *LoggerLevels) Level(loggerName string) zapcore.Level
Level returns the effective logging level for a logger. If a level has not been explicitly set for the logger, the default logging level will be returned.
func (l *LoggerLevels) Spec() string
Spec returns a normalized version of the active logging spec.
Logging maintains the state associated with the fabric logging system. It is intended to bridge between the legacy logging infrastructure built around go-logging and the structured, level logging provided by zap.
type Logging struct {
*LoggerLevels
// contains filtered or unexported fields
}
var Global *Logging
func New(c Config) (*Logging, error)
New creates a new logging system and initializes it with the provided configuration.
func (s *Logging) Apply(c Config) error
Apply applies the provided configuration to the logging system.
func (s *Logging) Check(e zapcore.Entry, ce *zapcore.CheckedEntry)
func (s *Logging) Encoding() Encoding
Encoding satisfies the Encoding interface. It determines whether the JSON or CONSOLE encoder should be used by the Core when log records are written.
func (s *Logging) Logger(name string) *FabricLogger
Logger instantiates a new FabricLogger with the specified name. The name is used to determine which log levels are enabled.
func (s *Logging) SetFormat(format string) error
SetFormat updates how log records are formatted and encoded. Log entries created after this method has completed will use the new format.
An error is returned if the log format specification cannot be parsed.
func (s *Logging) SetObserver(observer Observer)
SetObserver is used to provide a log observer that will be called as log levels are checked or written.. Only a single observer is supported.
func (s *Logging) SetWriter(w io.Writer)
SetWriter controls which writer formatted log records are written to. Writers, with the exception of an *os.File, need to be safe for concurrent use by multiple go routines.
func (s *Logging) Sync() error
Sync satisfies the zapcore.WriteSyncer interface. It is used by the Core to flush log records before terminating the process.
func (s *Logging) Write(b []byte) (int, error)
Write satisfies the io.Write contract. It delegates to the writer argument of SetWriter or the Writer field of Config. The Core uses this when encoding log records.
func (s *Logging) WriteEntry(e zapcore.Entry, fields []zapcore.Field)
func (s *Logging) ZapLogger(name string) *zap.Logger
ZapLogger instantiates a new zap.Logger with the specified name. The name is used to determine which log levels are enabled.
type Observer interface {
Check(e zapcore.Entry, ce *zapcore.CheckedEntry)
WriteEntry(e zapcore.Entry, fields []zapcore.Field)
}