Skip to content

Request ID ​

Added: v1.3.0

Injects a unique request ID into every request. The ID is set on the response header (X-Request-Id by default) and stored in the context store under "request_id".

Usage ​

go
r.Use(middleware.RequestID())

With Config ​

go
r.Use(middleware.RequestIDWithConfig(middleware.RequestIDConfig{
    Header: "X-Trace-Id",
    Generator: func() string {
        return uuid.New().String()
    },
    Skipper: zen.SkipPrefixes("/health", "/metrics"),
}))

Or start from defaults and modify:

go
cfg := middleware.DefaultRequestIDConfig()
cfg.Header = "X-Trace-Id"
cfg.Generator = func() string {
    return uuid.New().String()
}
cfg.Skipper = zen.SkipPrefixes("/health", "/metrics")

r.Use(middleware.RequestIDWithConfig(cfg))

Options ​

OptionDefaultDescription
HeaderX-Request-IdResponse header name for the request ID
Generator16-byte hexCustom ID generator function
SkippernilSkip request ID for matching requests

Retrieving the Request ID ​

The ID is available on the response header after the middleware runs:

go
r.GET("/", func(c *zen.Ctx) {
    id := c.Response.Header().Get(middleware.HeaderXRequestID)
    c.String(200, id)
})

It is also stored in the context store under "request_id":

go
if id, ok := c.Get("request_id"); ok {
    // use id
}

Client-Provided IDs ​

If the client sends an X-Request-Id header, it is preserved and echoed back:

go
// Client sends: X-Request-Id: abc-123
// Middleware uses "abc-123" as-is

Released under the MIT License.