roundtripware

Documentation

Index

• func LabelerFromContext(ctx context.Context) (context.Context, *otelhttp.Labeler)
• type Handler
• type RecoverOption
  • func RecoverWithDisablePrintStack(v bool) RecoverOption
• type RecoverOptions
  • func GetDefaultRecoverOptions() RecoverOptions
• type RequestIDOption
  • func RequestIDWithHeader(v string) RequestIDOption
  • func RequestIDWithProvider(v provider.RequestID) RequestIDOption
• type RequestIDOptions
  • func GetDefaultRequestIDOptions() RequestIDOptions
• type RoundTripper
  • func NewRoundTripper(l *zap.Logger, parent http.RoundTripper, roundTripwares ...RoundTripware) *RoundTripper
  • func (rt *RoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type RoundTripware
  • func Dump() RoundTripware
  • func DumpRequest() RoundTripware
  • func DumpResponse() RoundTripware
  • func Logger() RoundTripware
  • func Metric(meter metric.Meter, name, description string) RoundTripware
  • func Recover(opts ...RecoverOption) RoundTripware
  • func RecoverWithOptions(opts RecoverOptions) RoundTripware
  • func RequestID(opts ...RequestIDOption) RoundTripware
  • func SessionID(opts ...SessionIDOption) RoundTripware
  • func TrackingID(opts ...TrackingIDOption) RoundTripware
• type SessionIDGenerator
• type SessionIDOption
  • func SessionIDWithHeader(v string) SessionIDOption
• type SessionIDOptions
  • func GetDefaultSessionIDOptions() SessionIDOptions
• type TrackingIDGenerator
• type TrackingIDOption
  • func TrackingIDWithHeader(v string) TrackingIDOption
• type TrackingIDOptions
  • func GetDefaultTrackingIDOptions() TrackingIDOptions

Functions

func LabelerFromContext

func LabelerFromContext(ctx context.Context) (context.Context, *otelhttp.Labeler)

LabelerFromContext retrieves a Labeler instance from the provided context if one is available. If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.

Types

type Handler

type Handler func(r *http.Request) (*http.Response, error)

type RecoverOption

type RecoverOption func(options *RecoverOptions)

func RecoverWithDisablePrintStack

func RecoverWithDisablePrintStack(v bool) RecoverOption

RecoverWithDisablePrintStack roundTripware option

type RecoverOptions

type RecoverOptions struct {
	DisablePrintStack bool
}

func GetDefaultRecoverOptions

func GetDefaultRecoverOptions() RecoverOptions

GetDefaultRecoverOptions returns the default options

type RequestIDOption

type RequestIDOption func(*RequestIDOptions)

func RequestIDWithHeader

func RequestIDWithHeader(v string) RequestIDOption

RequestIDWithHeader middleware option

func RequestIDWithProvider

func RequestIDWithProvider(v provider.RequestID) RequestIDOption

RequestIDWithProvider middleware option

type RequestIDOptions

type RequestIDOptions struct {
	Header    string
	Provider  provider.RequestID
	SetHeader bool
}

func GetDefaultRequestIDOptions

func GetDefaultRequestIDOptions() RequestIDOptions

GetDefaultRequestIDOptions returns the default options

type RoundTripper

type RoundTripper struct {
	http.RoundTripper
	// contains filtered or unexported fields
}

func NewRoundTripper

func NewRoundTripper(l *zap.Logger, parent http.RoundTripper, roundTripwares ...RoundTripware) *RoundTripper

func (*RoundTripper) RoundTrip

func (rt *RoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type RoundTripware

type RoundTripware func(l *zap.Logger, next Handler) Handler

func Dump

func Dump() RoundTripware

Dump returns a RoundTripper which prints out the request & response object

func DumpRequest

func DumpRequest() RoundTripware

DumpRequest returns a RoundTripper which prints out the request object

func DumpResponse

func DumpResponse() RoundTripware

DumpResponse returns a RoundTripper which prints out the response object

func Logger

func Logger() RoundTripware

Logger returns a RoundTripware which logs all requests

func Metric

func Metric(meter metric.Meter, name, description string) RoundTripware

Metric returns a RoundTripper which prints out the request & response object

func Recover

func Recover(opts ...RecoverOption) RoundTripware

Recover returns a RoundTripper which catches any panics

func RecoverWithOptions

func RecoverWithOptions(opts RecoverOptions) RoundTripware

RecoverWithOptions returns a RoundTripper which catches any panics

func RequestID

func RequestID(opts ...RequestIDOption) RoundTripware

RequestID returns a RoundTripper which prints out the request & response object

func SessionID

func SessionID(opts ...SessionIDOption) RoundTripware

SessionID returns a RoundTripper which prints out the request & response object

func TrackingID

func TrackingID(opts ...TrackingIDOption) RoundTripware

TrackingID returns a RoundTripper which prints out the request & response object

type SessionIDGenerator

type SessionIDGenerator func() string

type SessionIDOption

type SessionIDOption func(*SessionIDOptions)

func SessionIDWithHeader

func SessionIDWithHeader(v string) SessionIDOption

SessionIDWithHeader middleware option

type SessionIDOptions

type SessionIDOptions struct {
	Header string
}

func GetDefaultSessionIDOptions

func GetDefaultSessionIDOptions() SessionIDOptions

GetDefaultSessionIDOptions returns the default options

type TrackingIDGenerator

type TrackingIDGenerator func() string

type TrackingIDOption

type TrackingIDOption func(*TrackingIDOptions)

func TrackingIDWithHeader

func TrackingIDWithHeader(v string) TrackingIDOption

TrackingIDWithHeader middleware option

type TrackingIDOptions

type TrackingIDOptions struct {
	Header string
}

func GetDefaultTrackingIDOptions

func GetDefaultTrackingIDOptions() TrackingIDOptions

GetDefaultTrackingIDOptions returns the default options