middleware

Documentation

Index

• func NewHealthCheckMW(basePath string, checker HealthChecker) alice.Constructor
• func NewTracingMW(tr opentracing.Tracer, options ...MWOption) alice.Constructor
• type HealthCheck
  • func NewHealthCheck(basePath string, checker HealthChecker, next http.Handler) *HealthCheck
  • func (h *HealthCheck) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type HealthChecker
• type MWOption
  • func OperationNameFunc(f func(r *http.Request) string) MWOption
• type Tracer
  • func NewTracer(tr opentracing.Tracer, next http.Handler, options ...MWOption) *Tracer
  • func (t *Tracer) ServeHTTP(rw http.ResponseWriter, r *http.Request)

Functions

func NewHealthCheckMW

func NewHealthCheckMW(basePath string, checker HealthChecker) alice.Constructor

NewHealthCheckMW creates a new health check middleware at the specified path

func NewTracingMW

func NewTracingMW(tr opentracing.Tracer, options ...MWOption) alice.Constructor

NewTracingMW creates a new health check middleware at the specified path

Types

type HealthCheck

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

HealthCheck is a middleware that serves healthcheck information

func NewHealthCheck

func NewHealthCheck(basePath string, checker HealthChecker, next http.Handler) *HealthCheck

NewHealthCheck creates a new health check middleware at the specified path

func (*HealthCheck) ServeHTTP

func (h *HealthCheck) ServeHTTP(rw http.ResponseWriter, r *http.Request)

ServeHTTP is the middleware interface implementation

type HealthChecker

type HealthChecker func() error

HealthChecker is executed to verify health of the service.

type MWOption

type MWOption func(*mwOptions)

MWOption contols the behavior of the Middleware.

func OperationNameFunc

func OperationNameFunc(f func(r *http.Request) string) MWOption

OperationNameFunc returns a MWOption that uses given function f to generate operation name for each server-side span.

type Tracer

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

Tracer is a middleware that traces HTTP requests

func NewTracer

func NewTracer(tr opentracing.Tracer, next http.Handler, options ...MWOption) *Tracer

NewTracer creates a new health check middleware at the specified path

func (*Tracer) ServeHTTP

func (t *Tracer) ServeHTTP(rw http.ResponseWriter, r *http.Request)

ServeHTTP is the middleware interface implementation