zapmw

README

A basic net/http-compatible logging middleware based on go.uber.org/zap.

Documentation

Index

• func Extract(ctx context.Context) *zap.Logger
• func New(logger *zap.Logger, opts ...Option) func(next http.Handler) http.Handler
• type Option
  • func WithClientErrorLevel(level zapcore.Level) Option
  • func WithRedirectionLevel(level zapcore.Level) Option
  • func WithReferrer() Option
  • func WithRemoteAddr() Option
  • func WithServerErrorLevel(level zapcore.Level) Option
  • func WithSuccessLevel(level zapcore.Level) Option
  • func WithUserAgent() Option

Functions

func Extract

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

Extract returns the *zap.Logger set by zapmw. If no logger is found in the context, zap.NewNop() is returned.

func New

func New(logger *zap.Logger, opts ...Option) func(next http.Handler) http.Handler

New returns a new logging middleware using the provided *zap.Logger

Types

type Option

type Option struct {
	// contains filtered or unexported fields
}

Option configures the logging middleware.

func WithClientErrorLevel

func WithClientErrorLevel(level zapcore.Level) Option

WithClientErrorLevel sets the log level for 4xx responses. The default is DebugLevel.

func WithRedirectionLevel

func WithRedirectionLevel(level zapcore.Level) Option

WithRedirectionLevel sets the log level for 3xx responses. The default is DebugLevel.

func WithReferrer

func WithReferrer() Option

WithReferrer adds a referrer field to the logger with the value of *http.Request.Referer().

func WithRemoteAddr

func WithRemoteAddr() Option

WithRemoteAddr adds a remote_addr field to the logger with the value of *http.Request.RemoteAddr.

func WithServerErrorLevel

func WithServerErrorLevel(level zapcore.Level) Option

WithServerErrorLevel sets the log level for 5xx responses. The default is ErrorLevel.

func WithSuccessLevel

func WithSuccessLevel(level zapcore.Level) Option

WithSuccessLevel sets the log level for 2xx responses. The default is DebugLevel.

func WithUserAgent

func WithUserAgent() Option

WithUserAgent adds a user_agent field to the logger with the value of *http.Request.UserAgent().