correlationid

Documentation

Index

• func DefaultGeneratorSource() *generatorSource
• func DefaultHeaderSource() *headerSource
• func New(options ...Option) *middleware
• func NewGeneratorSource(generator correlationIdGenerator) *generatorSource
• func NewHeaderSource(headers ...string) *headerSource
• type Option
  • func Source(s ...correlationIdSource) Option
  • func Store(s ...correlationIdStore) Option
  • func WithSource(s ...correlationIdSource) Option
  • func WithStore(s ...correlationIdStore) Option
• type Options

Functions

func DefaultGeneratorSource

func DefaultGeneratorSource() *generatorSource

DefaultGeneratorSource returns a new correlation ID source which generates a new correlation ID. The underlying generator is a default random string generator.

func DefaultHeaderSource

func DefaultHeaderSource() *headerSource

DefaultHeaderSource returns a correlation ID source which retrieves the correlation ID from common HTTP headers.

func New

func New(options ...Option) *middleware

New returns a new correlation ID middleware.

func NewGeneratorSource

func NewGeneratorSource(generator correlationIdGenerator) *generatorSource

NewGeneratorSource returns a new correlation ID source which generates a new correlation ID.

func NewHeaderSource

func NewHeaderSource(headers ...string) *headerSource

NewHeaderSource returns a correlation ID source which retrieves the correlation ID from given HTTP headers.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is used to define middleware configuration.

func Source

func Source(s ...correlationIdSource) Option

Source sets a set of correlation ID sources in the middleware.

func Store

func Store(s ...correlationIdStore) Option

Store sets a set of correlation ID stores in the middleware.

func WithSource

func WithSource(s ...correlationIdSource) Option

WithSource appends a set of correlation ID sources in the middleware.

func WithStore

func WithStore(s ...correlationIdStore) Option

WithStore appends a set of correlation ID stores in the middleware.

type Options

type Options []Option

Options is a set of middleware options together.