contrib

Documentation

Overview

This package implements integration between echo (https://github.com/labstack/echo) and OpenTelemetry.

import "github.com/americanas-go/ignite/labstack/echo.v4/plugins/contrib/opentelemetry/otelecho.v1"

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, server *echo.Server) error
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
• type OtelEcho
  • func NewOtelEcho(tracingOptions ...otelecho.Option) *OtelEcho
  • func NewOtelEchoWithConfigPath(path string, tracingOptions ...otelecho.Option) (*OtelEcho, error)
  • func NewOtelEchoWithOptions(options *Options) *OtelEcho
  • func (i *OtelEcho) Register(ctx context.Context, server *echo.Server)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, server *echo.Server) error

Register registers a new opentelemetry plugin for echo server.

Types

type Options

type Options struct {
	Enabled        bool
	TracingOptions []otelecho.Option
}

Options represents the opentelemetry plugin for echo server options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.

type OtelEcho

type OtelEcho struct {
	// contains filtered or unexported fields
}

OtelEcho represents opentelemetry plugin for echo server.

func NewOtelEcho

func NewOtelEcho(tracingOptions ...otelecho.Option) *OtelEcho

NewOtelEcho returns a new opentelemetry plugin with default options.

func NewOtelEchoWithConfigPath

func NewOtelEchoWithConfigPath(path string, tracingOptions ...otelecho.Option) (*OtelEcho, error)

NewOtelEchoWithConfigPath returns a new opentelemetry plugin with options from config path.

func NewOtelEchoWithOptions

func NewOtelEchoWithOptions(options *Options) *OtelEcho

NewOtelEchoWithOptions returns a new opentelemetry plugin with options.

func (*OtelEcho) Register

func (i *OtelEcho) Register(ctx context.Context, server *echo.Server)

Register registers this opentelemetry plugin for echo server.