middleware

README

Here are a few example middlewares for natsmicromw. The middlewares are:

• requestid.go: Request ID middleware that parses the header for a request id (storing it into the request context), or generates a unique ID for each request using the header tag 'request_id' or a specified header tag.
• metrics.go: Metrics middleware that collects Prometheus metrics for NATS messages including the total number of messages received, duration of requests, and size of payloads.
• compression.go: Middleware that supports both request and reply data compression based on specific headers.

Documentation

Index

• Constants
• Variables
• func CompressionMiddleware(next natsmicromw.MicroHandlerFunc) natsmicromw.MicroHandlerFunc
• func GetCompressMin() int
• func MetricsContextMiddleware(next natsmicromw.ContextHandlerFunc) natsmicromw.ContextHandlerFunc
• func MetricsMicroMiddleware(next natsmicromw.MicroHandlerFunc) natsmicromw.MicroHandlerFunc
• func MetricsMiddleware(next micro.Handler) micro.Handler
• func RequestIdFromContext(ctx context.Context) string
• func RequestIdMicroMiddleware(tags ...string) func(next natsmicromw.MicroHandlerFunc) natsmicromw.MicroHandlerFunc
• func RequestIdMiddleware(tags ...string) func(next natsmicromw.ContextHandlerFunc) natsmicromw.ContextHandlerFunc
• func SetCompressMin(minBytes int)
• type CompressionType

Constants

const (
	CompressionNone    CompressionType = ""
	CompressionGzip    CompressionType = "gzip"
	CompressionDeflate CompressionType = "deflate"

	HeaderAcceptEncoding string = "accept-encoding"
	HeaderEncoding              = "encoding"
)

Variables

var (
	ErrUnsupportedEncoding = errors.New("unsupported encoding")
)

Functions

func CompressionMiddleware

func CompressionMiddleware(next natsmicromw.MicroHandlerFunc) natsmicromw.MicroHandlerFunc

func GetCompressMin

func GetCompressMin() int

GetCompressMin retrieves the current global minimum size for compression.

func MetricsContextMiddleware

func MetricsContextMiddleware(next natsmicromw.ContextHandlerFunc) natsmicromw.ContextHandlerFunc

Same middleware but with context support

func MetricsMicroMiddleware

func MetricsMicroMiddleware(next natsmicromw.MicroHandlerFunc) natsmicromw.MicroHandlerFunc

One more version for `MicroRequest` and `MicroReply`

func MetricsMiddleware

func MetricsMiddleware(next micro.Handler) micro.Handler

Middleware that increments the message count metric

func RequestIdFromContext

func RequestIdFromContext(ctx context.Context) string

Get current request Id from the context

func RequestIdMicroMiddleware

func RequestIdMicroMiddleware(tags ...string) func(next natsmicromw.MicroHandlerFunc) natsmicromw.MicroHandlerFunc

Same example with `MicroRequest` and `MicroReply`

func RequestIdMiddleware

func RequestIdMiddleware(tags ...string) func(next natsmicromw.ContextHandlerFunc) natsmicromw.ContextHandlerFunc

An example request id middleware

func SetCompressMin

func SetCompressMin(minBytes int)

SetCompressMin sets the global minimum size for compression.

Types

type CompressionType

type CompressionType string