otelmux

Documentation

Overview

Package otelmux instruments the github.com/gorilla/mux package.

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
• func SemVersion() string
• func Version() string
• type Option
  • func WithPropagators(propagators propagation.TextMapPropagator) Option
  • func WithTracerProvider(provider oteltrace.TracerProvider) 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.

func SemVersion

func SemVersion() string

SemVersion is the semantic version to be supplied to tracer/meter creation.

func Version

func Version() string

Version is the current release version of the gorilla/mux instrumentation.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option specifies instrumentation configuration options.

func WithPropagators

func WithPropagators(propagators propagation.TextMapPropagator) Option

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

func WithTracerProvider

func WithTracerProvider(provider oteltrace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.