fiber/docs/middleware/requestid.md

id

id
requestid

RequestID

The RequestID middleware generates or propagates a request identifier, adding it to the response headers and request context.

Signatures

func New(config ...Config) fiber.Handler
func FromContext(ctx any) string

FromContext accepts a fiber.CustomCtx, fiber.Ctx, a *fasthttp.RequestCtx, or a context.Context.

Examples

Import the middleware package:

import (
    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/requestid"
)

Once your Fiber app is initialized, add the middleware like this:

// Initialize default config
app.Use(requestid.New())

// Or extend your config for customization
app.Use(requestid.New(requestid.Config{
    Header:    "X-Custom-Header",
    Generator: func() string {
        return "static-id"
    },
}))

If the request already includes the configured header, that value is reused instead of generating a new one. The middleware rejects IDs containing characters outside the visible ASCII range (for example, control characters or obs-text bytes) and will regenerate the value using up to three attempts from the configured generator (or SecureToken when no generator is set). When a custom generator fails to produce a valid ID, the middleware falls back to SecureToken to keep headers RFC-compliant across transports.

Retrieve the request ID

func handler(c fiber.Ctx) error {
    id := requestid.FromContext(c)
    log.Printf("Request ID: %s", id)
    return c.SendString("Hello, World!")
}

Config

Property	Type	Description	Default
Next	func(fiber.Ctx) bool	Skip when the function returns true.	nil
Header	string	Header key used to store the request ID.	"X-Request-ID"
Generator	func() string	Function that generates the identifier.	utils.SecureToken

Default Config

The default config uses a cryptographically secure token generator for better security and privacy.

var ConfigDefault = Config{
    Next:       nil,
    Header:     fiber.HeaderXRequestID,
    Generator:  utils.SecureToken,
}