correlation

README

Correlation ID Middleware

The correlation ID middleware adds a X-Correlation-ID header to incoming requests, if they do not contain one already. The correlation ID can be used track the control flow in systems of microservices.

Example

finalHandler := midgard.StackMiddlewareHandler(
    []midgard.Middleware{
        correlation.New(),
    },
    http.HandlerFunc(HelloHandler),
)

Documentation

Index

• func New(options ...func(*Handler) error) (defs.Middleware, error)
• func WithLogLevel(level slog.Level) func(h *Handler) error
• func WithLogger(log *slog.Logger) func(h *Handler) error
• type Handler
  • func (h *Handler) GetMWBase() *defs.MWBase
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Functions

func New

func New(options ...func(*Handler) error) (defs.Middleware, error)

New generates a new correlation id enriching middleware.

func WithLogLevel

func WithLogLevel(level slog.Level) func(h *Handler) error

WithLogLevel configures the log level to use with the logger.

func WithLogger

func WithLogger(log *slog.Logger) func(h *Handler) error

WithLogger configures the logger to use.

Types

type Handler

type Handler struct {
	defs.MWBase
}

func (*Handler) GetMWBase

func (h *Handler) GetMWBase() *defs.MWBase

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is implements the correlation id enriching middleware. It adds an X-Correlation-ID header if none was present.