zapctx

README

zapctx

zap logger from context.

example

simple

package main

func init() {
	zapctx.BetterDefault()
}

func SomeFunction(ctx context.Context) {
    logger := zapctx.L(ctx)
    
	logger.Info("some log") 
	// {"level":"info","time":"2019-10-11T10:28:18.492+0800","caller":"_playground/main.go:64","msg":"some log","hello":"world"}
	
	logger.Info("some log") 
	// {"level":"info","time":"2019-10-11T10:28:18.492+0800","caller":"_playground/main.go:64","msg":"some log","hello":"world"}
	
	sampledLogger := zapctx.Sampled(ctx)
	sampledLogger.Info("some log") 
	// nothing, because Sampled is false
}

func main() {
	originContext := context.Background()
	newCtx := zapctx.ToContext(originContext, zap.L())
	_ctx := zapctx.Extract(newCtx)
	_ctx.AddFields(zap.String("hello", "world"))
	_ctx.Sampled = false

	SomeFunction(newCtx)
}

gin middleware

engine := gin.Default()
engine.Use(zapctx.GinMiddleware(zap.L(), zapctx.OpenTraceInject))

grpc middleware

grpc.NewServer(
	grpc.StatsHandler(statsHandler),
	grpc.UnaryInterceptor(grpc_middleware.ChainUnaryServer(
		zapctx.UnaryServerInterceptor(zap.L(), zapctx.OpenTraceInject),
	)))

TODO

• payload middleware

Documentation

Index

• func BetterDefault()
• func Extract(ctx context.Context) *zapContext
• func GinMiddleware(logger *zap.Logger, hooks ...HookFunc) gin.HandlerFunc
• func L(ctx context.Context) *zap.Logger
• func OpenTraceInject(ctx context.Context) context.Context
• func S(ctx context.Context) *zap.SugaredLogger
• func Sampled(ctx context.Context) *zap.Logger
• func ToContext(ctx context.Context, logger *zap.Logger) context.Context
• func UnaryServerInterceptor(logger *zap.Logger, hooks ...HookFunc) grpc.UnaryServerInterceptor
• type HookFunc

Functions

func BetterDefault

func BetterDefault()

func Extract

func Extract(ctx context.Context) *zapContext

func GinMiddleware

func GinMiddleware(logger *zap.Logger, hooks ...HookFunc) gin.HandlerFunc

func L

func L(ctx context.Context) *zap.Logger

func OpenTraceInject

func OpenTraceInject(ctx context.Context) context.Context

func S

func S(ctx context.Context) *zap.SugaredLogger

func Sampled

func Sampled(ctx context.Context) *zap.Logger

func ToContext

func ToContext(ctx context.Context, logger *zap.Logger) context.Context

func UnaryServerInterceptor

func UnaryServerInterceptor(logger *zap.Logger, hooks ...HookFunc) grpc.UnaryServerInterceptor

Types

type HookFunc

type HookFunc func(ctx context.Context) context.Context