RequestID
RequestID middleware for Fiber that generates or propagates a request identifier. The ID is added to the response headers and stored in the request context.
Signatures
func New(config ...Config) fiber.Handler
func FromContext(c fiber.Ctx) string
Examples
Import the middleware package that is part of the Fiber web framework
import (
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/requestid"
)
After initializing your Fiber app, you can use the middleware in the following ways:
// 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 incoming request already contains the configured header, its value is reused instead of generating a new one.
Getting 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 | Next defines a function to skip this middleware when returned true. | nil |
Header | string | Header is the header key where to get/set the unique request ID. | "X-Request-ID" |
Generator | func() string | Generator defines a function to generate the unique identifier. | utils.UUID |
Default Config
The default config uses a fast UUID generator which will expose the number of
requests made to the server. To conceal this value for better privacy, use the
utils.UUIDv4
generator.
var ConfigDefault = Config{
Next: nil,
Header: fiber.HeaderXRequestID,
Generator: utils.UUID,
}