correlation

package

v0.2.0 Latest Latest Go to latest Published: Oct 1, 2025 License: MPL-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/AlphaOne1/midgard

Links

Open Source Insights

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 ¶

Overview ¶

Package correlation provides a middleware for adding correlation ids to HTTP requests.

Index ¶

Variables
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)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNilOption = errors.New("option cannot be nil")

ErrNilOption is returned when an option is nil.

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
}

Handler is the basic structure of the correlation id enriching middleware.

func (*Handler) GetMWBase ¶

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

GetMWBase returns the MWBase instance of the handler.

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.

Source Files ¶

View all Source files

correlation.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL