middlewares

Documentation

Index

• Variables
• func NewOauthTransport(config OauthConfig) *oauthRoundTripper
• func NewTracedTransport(config TraceConfig) *traceTransport
• func SanitizeHeaders(headers http.Header, redactedHeaders ...string) http.Header
• type AuthStyle
• type Middleware
  • func NewLogger(config TraceConfig) Middleware
• type OauthConfig
  • func (c *OauthConfig) AuthStyleInHeader() *OauthConfig
  • func (c *OauthConfig) AuthStyleInParams() *OauthConfig
  • func (c OauthConfig) String() string
• type RoundTripperFunc
  • func (f RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)
• type TraceConfig

Variables

var AuthStyleAutoDetect = AuthStyle(oauth2.AuthStyleAutoDetect)

var AuthStyleInHeader = AuthStyle(oauth2.AuthStyleInHeader)

var AuthStyleInParams = AuthStyle(oauth2.AuthStyleInParams)

Functions

func NewOauthTransport

func NewOauthTransport(config OauthConfig) *oauthRoundTripper

func NewTracedTransport

func NewTracedTransport(config TraceConfig) *traceTransport

func SanitizeHeaders

func SanitizeHeaders(headers http.Header, redactedHeaders ...string) http.Header

Types

type AuthStyle

type AuthStyle oauth2.AuthStyle

type Middleware

type Middleware func(http.RoundTripper) http.RoundTripper

func NewLogger

func NewLogger(config TraceConfig) Middleware

type OauthConfig

type OauthConfig struct {
	ClientID     string
	ClientSecret string
	TokenURL     string
	Scopes       []string
	Params       map[string]string
	AuthStyle    AuthStyle
	Tracer       func(msg string)
}

func (*OauthConfig) AuthStyleInHeader

func (c *OauthConfig) AuthStyleInHeader() *OauthConfig

func (*OauthConfig) AuthStyleInParams

func (c *OauthConfig) AuthStyleInParams() *OauthConfig

func (OauthConfig) String

func (c OauthConfig) String() string

type RoundTripperFunc

type RoundTripperFunc func(*http.Request) (*http.Response, error)

func (RoundTripperFunc) RoundTrip

func (f RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)

type TraceConfig

type TraceConfig struct {
	// SpanName is an optional name for the span.
	// If not provided, the hostname of the requesting URL will be used.
	SpanName string

	// A list of patterns for headers which should be redacted in the trace.
	RedactedHeaders []string

	// MaxBodyLength is the max size of the body, in bytes, that will be traced.
	// If the response body is larger than this, it will not be traced at all.
	//
	//  Default: 4096 (4MB)
	MaxBodyLength int64

	// Body controls whether the request Body is traced
	Body bool

	// Response controls whether the Response body is traced
	Response bool

	// ResponseHeaders controls whether the response headers are traced
	ResponseHeaders bool

	// QueryParam controls whether the query parameters are traced
	QueryParam bool

	// Headers controls whether the Headers are traced
	Headers bool

	// TLS connection information
	TLS bool

	Timing bool
}