http

Documentation

Index

• Variables
• func DefaultURI(r *http.Request) string
• func NewClient(ca []byte) *http.Client
• func ServerMiddleware(opts ...Option) func(next http.Handler) http.Handler
• func ServerMiddlewareAll(opts ...Option) func(next http.Handler) http.Handler
• func UpdateClient(c *http.Client, opts ...Option) *http.Client
• type Option
  • func WithOperation(name string) Option
  • func WithOtelOpts(opts ...otelhttp.Option) Option
  • func WithPathExtractor(in PathExtractor) Option
  • func WithTel(t *tel.Telemetry) Option
• type PathExtractor
• type TracedServeMux
  • func NewServeMux(opts ...Option) *TracedServeMux
  • func (tm *TracedServeMux) Handle(pattern string, handler http.Handler)
  • func (tm *TracedServeMux) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var (
	DefaultSpanNameFormatter = func(_ string, r *http.Request) string {
		return fmt.Sprintf("%s: %s", r.Method, r.URL.Path)
	}
	DefaultFilter = func(r *http.Request) bool {
		return !(r.Method == http.MethodGet && strings.HasPrefix(r.URL.RequestURI(), "/health"))
	}
)

Functions

func DefaultURI

func DefaultURI(r *http.Request) string

func NewClient

func NewClient(ca []byte) *http.Client

NewClient with CA injection

func ServerMiddleware

func ServerMiddleware(opts ...Option) func(next http.Handler) http.Handler

ServerMiddleware perform: * telemetry log injection * measure execution time * recovery

func ServerMiddlewareAll

func ServerMiddlewareAll(opts ...Option) func(next http.Handler) http.Handler

ServerMiddlewareAll represent all essential metrics Execution order:

• opentracing injection via nethttp.Middleware
• recovery + measure execution time + debug log via own ServerMiddleware
• metrics via metrics.NewHTTPMiddlewareWithOption

func UpdateClient

func UpdateClient(c *http.Client, opts ...Option) *http.Client

UpdateClient inject tracer

Types

type Option

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

Option interface used for setting optional config properties.

func WithOperation

func WithOperation(name string) Option

func WithOtelOpts

func WithOtelOpts(opts ...otelhttp.Option) Option

func WithPathExtractor

func WithPathExtractor(in PathExtractor) Option

func WithTel

func WithTel(t *tel.Telemetry) Option

WithTel also add options to pass own metric and trace provider

type PathExtractor

type PathExtractor func(r *http.Request) string

type TracedServeMux

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

TracedServeMux is a wrapper around http.ServeMux that instruments handlers for tracing.

func NewServeMux

func NewServeMux(opts ...Option) *TracedServeMux

NewServeMux creates a new TracedServeMux.

func (*TracedServeMux) Handle

func (tm *TracedServeMux) Handle(pattern string, handler http.Handler)

Handle implements http.ServeMux#Handle

func (*TracedServeMux) ServeHTTP

func (tm *TracedServeMux) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.ServeMux#ServeHTTP