httpmw

Documentation

Index

• func ContextMiddleware(opts ...Option) func(http.Handler) http.Handler
• type Option
  • func WithGenerateMissingIDs(enable bool) Option
  • func WithIDGenerator(fn func() string) Option
  • func WithRequestHeader(name string) Option
  • func WithTraceHeader(name string) Option

Functions

func ContextMiddleware

func ContextMiddleware(opts ...Option) func(http.Handler) http.Handler

ContextMiddleware enriches the request context with identifiers commonly used by the logger.

Types

type Option

type Option func(*options)

Option configures the behaviour of the ContextMiddleware.

func WithGenerateMissingIDs

func WithGenerateMissingIDs(enable bool) Option

WithGenerateMissingIDs instructs the middleware to create ids when headers are absent.

func WithIDGenerator

func WithIDGenerator(fn func() string) Option

WithIDGenerator provides a custom generator used when headers are missing.

func WithRequestHeader

func WithRequestHeader(name string) Option

WithRequestHeader configures the header used to populate the request id.

func WithTraceHeader

func WithTraceHeader(name string) Option

WithTraceHeader configures the header used to populate the trace id.