Documentation
¶
Index ¶
- Constants
- func NegroniRecoverHandler() negroni.Handler
- func NewBackendMetricsMiddleware(registry metrics.Registry, backendName string) negroni.Handler
- func NewCircuitBreakerOptions(expression string) cbreaker.CircuitBreakerOption
- func NewEntryPointMetricsMiddleware(registry metrics.Registry, entryPointName string) negroni.Handler
- func NewReplacePathRegexHandler(regex string, replacement string, handler http.Handler) http.Handler
- func NewSecure(headers *types.Headers) *secure.Secure
- func RecoverHandler(next http.Handler) http.Handler
- type AddPrefix
- type CircuitBreaker
- type Compress
- type DefaultNetErrorRecorder
- type EmptyBackendHandler
- type HandlerSwitcher
- type HeaderOptions
- type HeaderStruct
- type IPWhiteLister
- type MetricsRetryListener
- type NetErrorRecorder
- type ReplacePath
- type ReplacePathRegex
- type Retry
- type RetryListener
- type RetryListeners
- type Routes
- type Stateful
- type Stats
- type StatsRecorder
- type StripPrefix
- type StripPrefixRegex
Constants ¶
const ForwardedPrefixHeader = "X-Forwarded-Prefix"
ForwardedPrefixHeader is the default header to set prefix
const ReplacedPathHeader = "X-Replaced-Path"
ReplacedPathHeader is the default header to set the old path to
Variables ¶
This section is empty.
Functions ¶
func NegroniRecoverHandler ¶
NegroniRecoverHandler recovers from a panic in negroni handlers
func NewBackendMetricsMiddleware ¶
NewBackendMetricsMiddleware creates a new metrics middleware for a Backend.
func NewCircuitBreakerOptions ¶
func NewCircuitBreakerOptions(expression string) cbreaker.CircuitBreakerOption
NewCircuitBreakerOptions returns a new CircuitBreakerOption
func NewEntryPointMetricsMiddleware ¶
func NewEntryPointMetricsMiddleware(registry metrics.Registry, entryPointName string) negroni.Handler
NewEntryPointMetricsMiddleware creates a new metrics middleware for an Entrypoint.
func NewReplacePathRegexHandler ¶
func NewReplacePathRegexHandler(regex string, replacement string, handler http.Handler) http.Handler
NewReplacePathRegexHandler returns a new ReplacePathRegex
Types ¶
type AddPrefix ¶
AddPrefix is a middleware used to add prefix to an URL request
func (*AddPrefix) SetHandler ¶
SetHandler sets handler
type CircuitBreaker ¶
type CircuitBreaker struct {
// contains filtered or unexported fields
}
CircuitBreaker holds the oxy circuit breaker.
func NewCircuitBreaker ¶
func NewCircuitBreaker(next http.Handler, expression string, options ...cbreaker.CircuitBreakerOption) (*CircuitBreaker, error)
NewCircuitBreaker returns a new CircuitBreaker.
func (*CircuitBreaker) ServeHTTP ¶
func (cb *CircuitBreaker) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
type Compress ¶
type Compress struct{}
Compress is a middleware that allows redirection
func (*Compress) ServeHTTP ¶
func (c *Compress) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
ServerHTTP is a function used by Negroni
type DefaultNetErrorRecorder ¶
type DefaultNetErrorRecorder struct{}
DefaultNetErrorRecorder is the default NetErrorRecorder implementation.
func (DefaultNetErrorRecorder) Record ¶
func (DefaultNetErrorRecorder) Record(ctx context.Context)
Record is recording network errors by setting the context value for the defaultNetErrCtxKey to true.
type EmptyBackendHandler ¶
type EmptyBackendHandler struct {
// contains filtered or unexported fields
}
EmptyBackendHandler is a middlware that checks whether the current Backend has at least one active Server in respect to the healthchecks and if this is not the case, it will stop the middleware chain and respond with 503.
func NewEmptyBackendHandler ¶
func NewEmptyBackendHandler(lb healthcheck.LoadBalancer, next http.Handler) *EmptyBackendHandler
NewEmptyBackendHandler creates a new EmptyBackendHandler instance.
func (*EmptyBackendHandler) ServeHTTP ¶
func (h *EmptyBackendHandler) ServeHTTP(rw http.ResponseWriter, r *http.Request)
ServeHTTP responds with 503 when there is no active Server and otherwise invokes the next handler in the middleware chain.
type HandlerSwitcher ¶
type HandlerSwitcher struct {
// contains filtered or unexported fields
}
HandlerSwitcher allows hot switching of http.ServeMux
func NewHandlerSwitcher ¶
func NewHandlerSwitcher(newHandler *mux.Router) (hs *HandlerSwitcher)
NewHandlerSwitcher builds a new instance of HandlerSwitcher
func (*HandlerSwitcher) GetHandler ¶
func (hs *HandlerSwitcher) GetHandler() (newHandler *mux.Router)
GetHandler returns the current http.ServeMux
func (*HandlerSwitcher) ServeHTTP ¶
func (hs *HandlerSwitcher) ServeHTTP(rw http.ResponseWriter, r *http.Request)
func (*HandlerSwitcher) UpdateHandler ¶
func (hs *HandlerSwitcher) UpdateHandler(newHandler *mux.Router)
UpdateHandler safely updates the current http.ServeMux with a new one
type HeaderOptions ¶
type HeaderOptions struct {
// If Custom request headers are set, these will be added to the request
CustomRequestHeaders map[string]string
// If Custom response headers are set, these will be added to the ResponseWriter
CustomResponseHeaders map[string]string
}
HeaderOptions is a struct for specifying configuration options for the headers middleware.
type HeaderStruct ¶
type HeaderStruct struct {
// contains filtered or unexported fields
}
HeaderStruct is a middleware that helps setup a few basic security features. A single headerOptions struct can be provided to configure which features should be enabled, and the ability to override a few of the default values.
func NewHeaderFromStruct ¶
func NewHeaderFromStruct(headers *types.Headers) *HeaderStruct
NewHeaderFromStruct constructs a new header instance from supplied frontend header struct.
func (*HeaderStruct) ModifyRequestHeaders ¶
func (s *HeaderStruct) ModifyRequestHeaders(r *http.Request)
ModifyRequestHeaders set or delete request headers
func (*HeaderStruct) ModifyResponseHeaders ¶
func (s *HeaderStruct) ModifyResponseHeaders(res *http.Response) error
ModifyResponseHeaders set or delete response headers
func (*HeaderStruct) ServeHTTP ¶
func (s *HeaderStruct) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
type IPWhiteLister ¶
type IPWhiteLister struct {
// contains filtered or unexported fields
}
IPWhiteLister is a middleware that provides Checks of the Requesting IP against a set of Whitelists
func NewIPWhiteLister ¶
func NewIPWhiteLister(whiteList []string, useXForwardedFor bool) (*IPWhiteLister, error)
NewIPWhiteLister builds a new IPWhiteLister given a list of CIDR-Strings to whitelist
func (*IPWhiteLister) ServeHTTP ¶
func (wl *IPWhiteLister) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
type MetricsRetryListener ¶
type MetricsRetryListener struct {
// contains filtered or unexported fields
}
MetricsRetryListener is an implementation of the RetryListener interface to record RequestMetrics about retry attempts.
type NetErrorRecorder ¶
type NetErrorRecorder interface {
// Record can be used to signal the retry middleware that an network error happened
// and therefore the request should be retried.
Record(ctx context.Context)
}
NetErrorRecorder is an interface to record net errors.
type ReplacePath ¶
ReplacePath is a middleware used to replace the path of a URL request
func (*ReplacePath) ServeHTTP ¶
func (s *ReplacePath) ServeHTTP(w http.ResponseWriter, r *http.Request)
type ReplacePathRegex ¶
ReplacePathRegex is a middleware used to replace the path of a URL request with a regular expression
func (*ReplacePathRegex) ServeHTTP ¶
func (s *ReplacePathRegex) ServeHTTP(w http.ResponseWriter, r *http.Request)
type Retry ¶
type Retry struct {
// contains filtered or unexported fields
}
Retry is a middleware that retries requests
type RetryListener ¶
type RetryListener interface {
// Retried will be called when a retry happens, with the request attempt passed to it.
// For the first retry this will be attempt 2.
Retried(req *http.Request, attempt int)
}
RetryListener is used to inform about retry attempts.
func NewMetricsRetryListener ¶
func NewMetricsRetryListener(retryMetrics retryMetrics, backendName string) RetryListener
NewMetricsRetryListener instantiates a MetricsRetryListener with the given retryMetrics.
type RetryListeners ¶
type RetryListeners []RetryListener
RetryListeners is a convenience type to construct a list of RetryListener and notify each of them about a retry attempt.
type Routes ¶
type Routes struct {
// contains filtered or unexported fields
}
Routes holds the gorilla mux routes (for the API & co).
func (*Routes) ServeHTTP ¶
func (router *Routes) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
type Stateful ¶
type Stateful interface {
http.ResponseWriter
http.Hijacker
http.Flusher
http.CloseNotifier
}
Stateful interface groups all http interfaces that must be implemented by a stateful middleware (ie: recorders)
type Stats ¶
type Stats struct {
RecentErrors []*statsError `json:"recent_errors"`
}
Stats includes all of the stats gathered by the recorder.
type StatsRecorder ¶
type StatsRecorder struct {
// contains filtered or unexported fields
}
StatsRecorder is an optional middleware that records more details statistics about requests and how they are processed. This currently consists of recent requests that have caused errors (4xx and 5xx status codes), making it easy to pinpoint problems.
func NewStatsRecorder ¶
func NewStatsRecorder(numRecentErrors int) *StatsRecorder
NewStatsRecorder returns a new StatsRecorder
func (*StatsRecorder) Data ¶
func (s *StatsRecorder) Data() *Stats
Data returns a copy of the statistics that have been gathered.
func (*StatsRecorder) ServeHTTP ¶
func (s *StatsRecorder) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
ServeHTTP silently extracts information from the request and response as it is processed. If the response is 4xx or 5xx, add it to the list of 10 most recent errors.
type StripPrefix ¶
StripPrefix is a middleware used to strip prefix from an URL request
func (*StripPrefix) ServeHTTP ¶
func (s *StripPrefix) ServeHTTP(w http.ResponseWriter, r *http.Request)
func (*StripPrefix) SetHandler ¶
func (s *StripPrefix) SetHandler(Handler http.Handler)
SetHandler sets handler
type StripPrefixRegex ¶
StripPrefixRegex is a middleware used to strip prefix from an URL request
func NewStripPrefixRegex ¶
func NewStripPrefixRegex(handler http.Handler, prefixes []string) *StripPrefixRegex
NewStripPrefixRegex builds a new StripPrefixRegex given a handler and prefixes
func (*StripPrefixRegex) ServeHTTP ¶
func (s *StripPrefixRegex) ServeHTTP(w http.ResponseWriter, r *http.Request)
func (*StripPrefixRegex) SetHandler ¶
func (s *StripPrefixRegex) SetHandler(Handler http.Handler)
SetHandler sets handler
Source Files
Directories