apmchiv5

Documentation

Overview

Package apmchiv5 provides middleware for the v5 Chi router, for tracing HTTP requests.

Index

• func Middleware(o ...Option) func(http.Handler) http.Handler
• type Option
  • func WithPanicPropagation() Option
  • func WithRequestIgnorer(r apmhttp.RequestIgnorerFunc) Option
  • func WithTracer(t *apm.Tracer) Option

Functions

func Middleware

func Middleware(o ...Option) func(http.Handler) http.Handler

Middleware returns a new chi middleware handler for tracing requests and reporting errors.

The server request name will use the fully matched, parametrized route.

By default, the middleware will use apm.DefaultTracer(). Use WithTracer to specify an alternative tracer.

Types

type Option

type Option func(*options)

Option sets options for tracing.

func WithPanicPropagation

func WithPanicPropagation() Option

WithPanicPropagation returns an Option which enable panic propagation. Any panic will be recovered and recorded as an error in a transaction, then the panic will fire again.

func WithRequestIgnorer

func WithRequestIgnorer(r apmhttp.RequestIgnorerFunc) Option

WithRequestIgnorer returns a Option which sets r as the function to use to determine whether or not a request should be ignored. If r is nil, all requests will be reported.

func WithTracer

func WithTracer(t *apm.Tracer) Option

WithTracer returns an Option which sets t as the tracer to use for tracing server requests.