httpmiddleware

Documentation

Overview

Package httpmiddleware contains HTTP middlewares.

Index

• func Wrap(h http.Handler, middlewares ...Middleware) http.Handler
• type Metrics
• type Middleware
  • func InjectLogger(lg *zap.Logger) Middleware
  • func Instrument(serviceName string, find RouteFinder, m Metrics) Middleware
  • func LogRequests(find RouteFinder) Middleware
• type OgenRoute
• type OgenServer
• type RouteFinder
  • func MakeRouteFinder[R OgenRoute, S OgenServer[R]](server S) RouteFinder

Functions

func Wrap

func Wrap(h http.Handler, middlewares ...Middleware) http.Handler

Wrap handler using given middlewares.

Types

type Metrics

type Metrics interface {
	TracerProvider() trace.TracerProvider
	MeterProvider() metric.MeterProvider
	TextMapPropagator() propagation.TextMapPropagator
}

Metrics wraps TracerProvider and MeterProvider.

type Middleware

type Middleware = func(http.Handler) http.Handler

Middleware is a net/http middleware.

func InjectLogger

func InjectLogger(lg *zap.Logger) Middleware

InjectLogger injects logger into request context.

func Instrument

func Instrument(serviceName string, find RouteFinder, m Metrics) Middleware

Instrument setups otelhttp.

func LogRequests

func LogRequests(find RouteFinder) Middleware

LogRequests logs incoming requests using context logger.

type OgenRoute

type OgenRoute interface {
	Name() string
	OperationID() string
}

OgenRoute is a generic ogen route type.

type OgenServer

type OgenServer[R OgenRoute] interface {
	FindPath(method string, u *url.URL) (r R, _ bool)
}

OgenServer is a generic ogen server type.

type RouteFinder

type RouteFinder func(method string, u *url.URL) (OgenRoute, bool)

RouteFinder finds Route by given URL.

func MakeRouteFinder

func MakeRouteFinder[R OgenRoute, S OgenServer[R]](server S) RouteFinder

MakeRouteFinder creates RouteFinder from given server.