requestid

Documentation

Index

• Constants
• Variables
• func GetContextRequestID(ctx context.Context) string
• func New() echo.MiddlewareFunc
• func NewWithConfig(config Config) echo.MiddlewareFunc
• func WithContextRequestID(ctx context.Context, rid string) context.Context
• type Config

Constants

const RequestIDKey requestIDKey = "custom.requestID"

RequestIDKey define a constant string for the request ID key

Variables

var DefaultRequestIDConfig = Config{
	Generator:    generator,
	TargetHeader: echo.HeaderXRequestID,
}

DefaultRequestIDConfig is the default RequestID middleware config.

Functions

func GetContextRequestID

func GetContextRequestID(ctx context.Context) string

GetContextRequestID takes a context as input and returns a pointer to a string of strings

func New

func New() echo.MiddlewareFunc

New returns a X-Request-ID middleware.

func NewWithConfig

func NewWithConfig(config Config) echo.MiddlewareFunc

NewWithConfig returns a X-Request-ID middleware with config.

func WithContextRequestID

func WithContextRequestID(ctx context.Context, rid string) context.Context

WithContextRequestID takes a context and request id as inputs and returns a new context with a value

Types

type Config

type Config struct {
	// Generator defines a function to generate an ID.
	// Optional. Defaults to generator for random string of length 32.
	Generator func() string

	// RequestIDHandler defines a function which is executed for a request id.
	RequestIDHandler func(echo.Context, string)

	// TargetHeader defines what header to look for to populate the id
	TargetHeader string
}

Config defines the config for RequestID middleware.