otelecho

Documentation

Overview

Package otelecho instruments the labstack/echo package (https://github.com/labstack/echo).

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

Deprecated: otelecho has no Code Owner. After August 21, 2024, it may no longer be supported and may stop receiving new releases unless a new Code Owner is found. See this issue if you would like to become the Code Owner of this module.

Index

• Constants
• func Middleware(service string, opts ...Option) echo.MiddlewareFunc
• func SemVersion() string
• func Version() string
• type Option
  • func WithPropagators(propagators propagation.TextMapPropagator) Option
  • func WithSkipper(skipper middleware.Skipper) Option
  • func WithTracerProvider(provider oteltrace.TracerProvider) Option

Constants

const (

	// ScopeName is the instrumentation scope name.
	ScopeName = "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho"
)

Functions

func Middleware

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

Middleware returns echo middleware which will trace incoming requests.

func SemVersion

func SemVersion() string

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

Deprecated: Use Version instead.

func Version

func Version() string

Version is the current release version of the echo 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 WithSkipper

func WithSkipper(skipper middleware.Skipper) Option

WithSkipper specifies a skipper for allowing requests to skip generating spans.

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.