middleware

Documentation

Index

• Constants
• func DebugTrace(format propagation.HTTPFormat, key string) func(handler http.Handler) http.Handler
• func NewRecovery(recoverFunc func(w http.ResponseWriter, r *http.Request, err interface{})) func(http.Handler) http.Handler
• func RequestID(handler http.Handler) http.Handler
• type HostMatcher
  • func NewHostMatcher(hosts []string) *HostMatcher
  • func (h *HostMatcher) Handler(handler http.Handler) http.Handler
• type Logger
  • func NewLogger() *Logger
  • func (m *Logger) Handler(handler http.Handler) http.Handler
• type Stats
  • func NewStats(statsClient client.Client) *Stats
  • func (m *Stats) Handler(handler http.Handler) http.Handler
• type StatsTagger
  • func NewStatsTagger(tags []tag.Mutator) *StatsTagger
  • func (h *StatsTagger) Handler(handler http.Handler) http.Handler

Constants

const (
	// DebugTraceHeader is the header key used for detecting if
	// trace should be force sampled and returned in the response
	DebugTraceHeader = "X-Debug-Trace"
)

Functions

func DebugTrace

func DebugTrace(format propagation.HTTPFormat, key string) func(handler http.Handler) http.Handler

DebugTrace is a middleware that allows debugging requests by providing the Trace ID back to the caller in the same header in the response

func NewRecovery

func NewRecovery(recoverFunc func(w http.ResponseWriter, r *http.Request, err interface{})) func(http.Handler) http.Handler

NewRecovery creates a new instance of Recovery

func RequestID

func RequestID(handler http.Handler) http.Handler

RequestID middleware

Types

type HostMatcher

type HostMatcher struct {
	// contains filtered or unexported fields
}

HostMatcher is a middleware that matches any host with the given list of hosts. It also supports regex host like *.example.com

func NewHostMatcher

func NewHostMatcher(hosts []string) *HostMatcher

NewHostMatcher creates a new instance of HostMatcher

func (*HostMatcher) Handler

func (h *HostMatcher) Handler(handler http.Handler) http.Handler

Handler is the middleware function

type Logger

type Logger struct{}

Logger struct contains data and logic required for middleware functionality

func NewLogger

func NewLogger() *Logger

NewLogger builds and returns new Logger middleware instance

func (*Logger) Handler

func (m *Logger) Handler(handler http.Handler) http.Handler

Handler implementation

type Stats

type Stats struct {
	// contains filtered or unexported fields
}

Stats represents the stats middleware

func NewStats

func NewStats(statsClient client.Client) *Stats

NewStats creates a new instance of Stats

func (*Stats) Handler

func (m *Stats) Handler(handler http.Handler) http.Handler

Handler is the middleware function

type StatsTagger

type StatsTagger struct {
	// contains filtered or unexported fields
}

StatsTagger is a middleware that takes a list of tags and adds them into context to be propagated

func NewStatsTagger

func NewStatsTagger(tags []tag.Mutator) *StatsTagger

NewStatsTagger creates a new instance of StatsTagger

func (*StatsTagger) Handler

func (h *StatsTagger) Handler(handler http.Handler) http.Handler

Handler is the middleware function