middleware

middleware

import "github.com/brpaz/lib-go/tracing/middleware"

Index

• func Tracing(opts ...TracingOption) func(http.Handler) http.Handler
• type TracingOption
  • func WithExcludeFunc(fn func(r *http.Request) bool) TracingOption
  • func WithExcludedRoutes(routes ...string) TracingOption
  • func WithSpanNameFormatter(fn func(r *http.Request) string) TracingOption

func Tracing

func Tracing(opts ...TracingOption) func(http.Handler) http.Handler

Tracing returns an OpenTelemetry HTTP middleware that creates a span per request.

type TracingOption

TracingOption configures the Tracing middleware.

type TracingOption func(*tracingConfig)

func WithExcludeFunc

func WithExcludeFunc(fn func(r *http.Request) bool) TracingOption

WithExcludeFunc excludes requests matching fn from tracing spans. Use it for prefix, glob or regex matching beyond the exact paths supported by WithExcludedRoutes.

func WithExcludedRoutes

func WithExcludedRoutes(routes ...string) TracingOption

WithExcludedRoutes excludes the given exact paths from tracing spans. By default, no paths are excluded.

func WithSpanNameFormatter

func WithSpanNameFormatter(fn func(r *http.Request) string) TracingOption

WithSpanNameFormatter sets a function to derive the span name from the request. This is useful to use the matched route pattern (e.g. from chi, gorilla/mux, etc.) so cardinality stays bounded in the collector.

By default, the span name is "<method> <path>".

Generated by gomarkdoc