macaron

Documentation

Overview

Package macaron provides functions to trace the macaron.v1 package (https://github.com/go-macaron/macaron).

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) macaron.Handler
• type Config
• type Option
  • func WithPropagators(propagators propagation.Propagators) Option
  • func WithTracer(tracer trace.Tracer) Option

Functions

func Middleware

func Middleware(service string, opts ...Option) macaron.Handler

Middleware returns a macaron Handler to trace requests to the server.

Types

type Config

type Config struct {
	Tracer      trace.Tracer
	Propagators propagation.Propagators
}

Config is a helper struct to configure Macaron options

type Option

type Option func(*Config)

Option specifies instrumentation configuration options.

func WithPropagators

func WithPropagators(propagators propagation.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 trace.Tracer) Option

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