logging

Documentation

Index

• func NewContext(ctx context.Context, instrumentOpts instrument.Options, ...) context.Context
• func NewContextWithGeneratedID(ctx context.Context, instrumentOpts instrument.Options) context.Context
• func NewContextWithID(ctx context.Context, id string, instrumentOpts instrument.Options) context.Context
• func ReadContextID(ctx context.Context) string
• func WithContext(ctx context.Context, instrumentOpts instrument.Options) *zap.Logger
• func WithPanicErrorResponder(next http.Handler, instrumentOpts instrument.Options) http.Handler
• func WithResponseTimeAndPanicErrorLogging(next http.Handler, instrumentOpts instrument.Options, opts ...MiddlewareOption) http.Handler
• func WithResponseTimeAndPanicErrorLoggingFunc(next func(w http.ResponseWriter, r *http.Request), ...) http.Handler
• type MiddlewareOption
  • func WithNoResponseLog() MiddlewareOption
  • func WithPostRequestMiddleware(m PostRequestMiddleware) MiddlewareOption
  • func WithPreRequestMiddleware(m PreRequestMiddleware) MiddlewareOption
  • func WithResponseLogThreshold(threshold time.Duration) MiddlewareOption
• type PostRequestMiddleware
• type PreRequestMiddleware
• type RequestMiddlewareMetadata

Functions

func NewContext

func NewContext(
	ctx context.Context,
	instrumentOpts instrument.Options,
	fields ...zapcore.Field,
) context.Context

NewContext returns a context has a zap logger with the extra fields added.

func NewContextWithGeneratedID

func NewContextWithGeneratedID(
	ctx context.Context,
	instrumentOpts instrument.Options,
) context.Context

NewContextWithGeneratedID returns a context with a generated id with a zap logger and an id field.

func NewContextWithID

func NewContextWithID(
	ctx context.Context,
	id string,
	instrumentOpts instrument.Options,
) context.Context

NewContextWithID returns a context which has a zap logger and an id field.

func ReadContextID

func ReadContextID(ctx context.Context) string

ReadContextID returns the context's id or "undefined".

func WithContext

func WithContext(ctx context.Context, instrumentOpts instrument.Options) *zap.Logger

WithContext returns a zap logger with as much context as possible.

func WithPanicErrorResponder

func WithPanicErrorResponder(
	next http.Handler,
	instrumentOpts instrument.Options,
) http.Handler

WithPanicErrorResponder wraps around the given handler, providing panic recovery and logging.

func WithResponseTimeAndPanicErrorLogging

func WithResponseTimeAndPanicErrorLogging(
	next http.Handler,
	instrumentOpts instrument.Options,
	opts ...MiddlewareOption,
) http.Handler

WithResponseTimeAndPanicErrorLogging wraps around the given handler, providing panic recovery and response time logging.

func WithResponseTimeAndPanicErrorLoggingFunc

func WithResponseTimeAndPanicErrorLoggingFunc(
	next func(w http.ResponseWriter, r *http.Request),
	instrumentOpts instrument.Options,
	opts ...MiddlewareOption,
) http.Handler

WithResponseTimeAndPanicErrorLoggingFunc wraps around the http request handler function, providing panic recovery and response time logging.

Types

type MiddlewareOption

type MiddlewareOption func(*middlewareOptions)

MiddlewareOption is an option to pass to a middleware.

func WithNoResponseLog

func WithNoResponseLog() MiddlewareOption

WithNoResponseLog is a middleware option to disable response logging.

func WithPostRequestMiddleware

func WithPostRequestMiddleware(m PostRequestMiddleware) MiddlewareOption

WithPostRequestMiddleware is a middleware option to set post-request middleware.

func WithPreRequestMiddleware

func WithPreRequestMiddleware(m PreRequestMiddleware) MiddlewareOption

WithPreRequestMiddleware is a middleware option to set pre-request middleware.

func WithResponseLogThreshold

func WithResponseLogThreshold(threshold time.Duration) MiddlewareOption

WithResponseLogThreshold is a middleware option to set response log threshold.

type PostRequestMiddleware

type PostRequestMiddleware func(req *http.Request, meta RequestMiddlewareMetadata)

PostRequestMiddleware is middleware that runs before a request.

type PreRequestMiddleware

type PreRequestMiddleware func(req *http.Request)

PreRequestMiddleware is middleware that runs before a request.

type RequestMiddlewareMetadata

type RequestMiddlewareMetadata struct {
	Start       time.Time
	End         time.Time
	Duration    time.Duration
	WroteHeader bool
	StatusCode  int
}

RequestMiddlewareMetadata is metadata available to middleware about a request.