requestid

Documentation

Index

• Variables
• func New(config ...Config) fiber.Handler
• type Config

Variables

var ConfigDefault = Config{
	Next:       nil,
	Header:     fiber.HeaderXRequestID,
	Generator:  utils.UUID,
	ContextKey: "requestid",
}

ConfigDefault is the default config It 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.

Functions

func New

func New(config ...Config) fiber.Handler

New creates a new middleware handler

Types

type Config

type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *fiber.Ctx) bool

	// Header is the header key where to get/set the unique request ID
	//
	// Optional. Default: "X-Request-ID"
	Header string

	// Generator defines a function to generate the unique identifier.
	//
	// Optional. Default: utils.UUID
	Generator func() string

	// ContextKey defines the key used when storing the request ID in
	// the locals for a specific request.
	// Should be a private type instead of string, but too many apps probably
	// rely on this exact value.
	//
	// Optional. Default: "requestid"
	ContextKey interface{}
}

Config defines the config for middleware.