middleware

Documentation

Index

• func VersionMiddleware(next http.Handler) http.Handler
• type JwtMiddleware
  • func NewJwtMiddleware(issuer, secret string) *JwtMiddleware
  • func (m *JwtMiddleware) Handler(next http.HandlerFunc) http.HandlerFunc
• type LoggingMiddleware
  • func NewLoggingMiddleware(logger *zap.Logger) *LoggingMiddleware
  • func (m *LoggingMiddleware) Handler(next http.Handler) http.Handler
• type PrometheusMiddleware
  • func NewPrometheusMiddleware() *PrometheusMiddleware
  • func (p *PrometheusMiddleware) Handler(next http.Handler) http.Handler

Functions

func VersionMiddleware

func VersionMiddleware(next http.Handler) http.Handler

VersionMiddleware sets the build version and revision in the request header

Types

type JwtMiddleware

type JwtMiddleware struct {
	Issuer string
	Secret string
}

JwtMiddleware witholds jwt issuer and secret

func NewJwtMiddleware

func NewJwtMiddleware(issuer, secret string) *JwtMiddleware

NewJwtMiddleware returns a new pointer reference to a JwtMiddleware

func (*JwtMiddleware) Handler

func (m *JwtMiddleware) Handler(next http.HandlerFunc) http.HandlerFunc

Handler is the jwt middleware handler function. It extracts a jwt token from a request header and asserts it is still valid in a middleware chain

type LoggingMiddleware

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

LoggingMiddleware witholds logging functionality useful for logging request metadata

func NewLoggingMiddleware

func NewLoggingMiddleware(logger *zap.Logger) *LoggingMiddleware

NewLoggingMiddleware returns a news pointer reference to LoggingMiddleware

func (*LoggingMiddleware) Handler

func (m *LoggingMiddleware) Handler(next http.Handler) http.Handler

Handler is the login middleware's handler function. It logs request metadata in a middleware chain

type PrometheusMiddleware

type PrometheusMiddleware struct {
	Histogram *prometheus.HistogramVec
	Counter   *prometheus.CounterVec
}

PrometheusMiddleware is a middleware object witholding various metric types. These counters prove useful in emitting metrics at the request level

func NewPrometheusMiddleware

func NewPrometheusMiddleware() *PrometheusMiddleware

NewPrometheusMiddleware returns a new pointer reference to a PrometheusMiddleware object

func (*PrometheusMiddleware) Handler

func (p *PrometheusMiddleware) Handler(next http.Handler) http.Handler

Handler serves as the metrics endpoint http handler