README
¶
clog
go get go.spiff.io/clog
clog is a simple package for attaching a Zap logger to a context, along with functions for logging from the context-attached logger or associating new fields to the logger.
Generally speaking this is a bad use of the context package, but utility won out over passing both a context and a logger around all the time. In particular, this is useful for passing a request-scoped logger through different http.Handler implementations that otherwise do not support Zap.
This is a fork of https://github.com/Kochava/clog.
Usage
A few examples of basic usage follow.
Attach a logger to a context
// var l *zap.Logger
// Attach the logger, l, to a context:
ctx := clog.WithLogger(context.Background(), l)
// Attach fields to the logger:
ctx = clog.With(ctx, zap.Int("field", 1234))
// Log at info level:
clog.Info(ctx, "Log message")
License
clog is made available under the ISC license. A copy of it can be found in the
repository in the COPYING file.
Documentation
¶
Overview ¶
Package clog is a convenience package for passing Zap loggers through contexts.
Index ¶
- func Check(ctx context.Context, lvl zapcore.Level, msg string) *zapcore.CheckedEntry
- func DPanic(ctx context.Context, msg string, fields ...zapcore.Field)
- func Debug(ctx context.Context, msg string, fields ...zapcore.Field)
- func Error(ctx context.Context, msg string, fields ...zapcore.Field)
- func Fatal(ctx context.Context, msg string, fields ...zapcore.Field)
- func Info(ctx context.Context, msg string, fields ...zapcore.Field)
- func Logger(ctx context.Context) (logger *zap.Logger)
- func Panic(ctx context.Context, msg string, fields ...zapcore.Field)
- func Sugar(ctx context.Context) *zap.SugaredLogger
- func Warn(ctx context.Context, msg string, fields ...zapcore.Field)
- func With(ctx context.Context, fields ...zapcore.Field) context.Context
- func WithLogger(ctx context.Context, logger *zap.Logger) context.Context
- func WithOptions(ctx context.Context, opts ...zap.Option) context.Context
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Sugar ¶
func Sugar(ctx context.Context) *zap.SugaredLogger
Sugar is a convenience function for calling Logger(ctx).Sugar().
func With ¶
With returns a context parented to ctx with a logger that has the given fields appended to it. The logger of ctx is the one returned by Logger.
func WithLogger ¶
WithLogger returns a context parented to ctx with the given logger attached as a value.
Types ¶
This section is empty.
Source Files