ctxzap

README

ctxzap

install

go get github.com/liguangsheng/go-ctxzap

example

simple

package main

func init() {
	ctxzap.BetterDefault() // this will replace global zap logger with a better default logger
}

func SomeFunction(ctx context.Context) {
    logger := ctxzap.L(ctx)
    logger.Info("some log") 
    ...
}

func main() {
	originContext := context.Background()
	newCtx := zapctx.ToContext(originContext, zap.L())
	SomeFunction(newCtx)
}

gin middleware

engine := gin.Default()
engine.Use(ctxzap.Gin(zap.L()))

grpc middleware

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

Documentation

Index

• func BetterDefaults()
• func Extract(ctx context.Context) *_context
• func Gin(logger *zap.Logger, hooks ...HookFunc) gin.HandlerFunc
• func L(ctx context.Context) *zap.Logger
• func N(ctx context.Context) *zap.Logger
• func OpenTraceFields(ctx context.Context) context.Context
• func S(ctx context.Context) *zap.SugaredLogger
• func ToContext(ctx context.Context, logger *zap.Logger) context.Context
• func UnaryServerInterceptor(logger *zap.Logger, hooks ...HookFunc) grpc.UnaryServerInterceptor
• type Context
• type HookFunc

Functions

func BetterDefaults

func BetterDefaults()

func Extract

func Extract(ctx context.Context) *_context

Extract

func Gin

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

func L

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

L return logger from context or zap.L()

func N

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

N return logger from context or nopLogger

func OpenTraceFields

func OpenTraceFields(ctx context.Context) context.Context

func S

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

S return logger from context or zap.S()

func ToContext

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

ToContext place *zap.Logger to context

func UnaryServerInterceptor

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

Types

type Context

type Context = *_context

type HookFunc

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