mux

Documentation

Overview

Package mux provides functions to trace the gorilla/mux package (https://github.com/gorilla/mux).

Currently only the routing of a received message can be instrumented. To do it, use the Middleware function.

Index

• func Middleware(service string, opts ...Option) mux.MiddlewareFunc
• type Config
• type Option
  • func WithPropagators(propagators otelpropagation.Propagators) Option
  • func WithTracer(tracer oteltrace.Tracer) Option

Functions

func Middleware

func Middleware(service string, opts ...Option) mux.MiddlewareFunc

Middleware sets up a handler to start tracing the incoming requests. The service parameter should describe the name of the (virtual) server handling the request.

Types

type Config

type Config struct {
	Tracer      oteltrace.Tracer
	Propagators otelpropagation.Propagators
}

Config is used to configure the mux middleware.

type Option

type Option func(*Config)

Option specifies instrumentation configuration options.

func WithPropagators

func WithPropagators(propagators otelpropagation.Propagators) Option

WithPropagators specifies propagators to use for extracting information from the HTTP requests. If none are specified, global ones will be used.

func WithTracer

func WithTracer(tracer oteltrace.Tracer) Option

WithTracer specifies a tracer to use for creating spans. If none is specified, a tracer named "go.opentelemetry.io/contrib/instrumentation/gorilla/mux" from the global provider is used.