otel

README

Docs: link

Documentation

Overview

Package otel provides an OpenTelemetry plugin for RoadRunner that enables distributed tracing and metrics collection. It configures exporters, samplers, and propagators, and provides HTTP middleware that creates root server spans for incoming requests.

Index

• func HTTPHandler(next http.Handler, middleware httpMiddleware) http.Handler
• func TemporalHandler(interceptor temporalInterceptor) interceptor.WorkerInterceptor
• type Client
• type Config
  • func (c *Config) InitDefault(log *zap.Logger)
• type Configurer
• type Exporter
• type Logger
• type Plugin
  • func (p *Plugin) Init(cfg Configurer, log Logger) error
  • func (p *Plugin) Middleware(next http.Handler) http.Handler
  • func (p *Plugin) Name() string
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) Stop(ctx context.Context) error
  • func (p *Plugin) Tracer() *sdktrace.TracerProvider
  • func (p *Plugin) WorkerInterceptor() interceptor.WorkerInterceptor
• type Resource

Functions

func HTTPHandler

func HTTPHandler(next http.Handler, middleware httpMiddleware) http.Handler

func TemporalHandler

func TemporalHandler(interceptor temporalInterceptor) interceptor.WorkerInterceptor

Types

type Client

type Client string

type Config

type Config struct {
	// Resource describes an entity about which identifying information and metadata is exposed.
	Resource *Resource `mapstructure:"resource"`
	// Insecure endpoint (http)
	Insecure bool `mapstructure:"insecure"`
	// Compress - use gzip compression
	Compress bool `mapstructure:"compress"`
	// Exporter type, can be zipkin,stdout or otlp
	Exporter Exporter `mapstructure:"exporter"`
	// CustomURL to use to send spans, has effect only for the HTTP exporter
	CustomURL string `mapstructure:"custom_url"`
	// Client
	Client Client `mapstructure:"client"`
	// Endpoint to connect
	Endpoint string `mapstructure:"endpoint"`
	// ServiceName describes the service in the attributes
	ServiceName string `mapstructure:"service_name"`
	// ServiceVersion in semver format
	ServiceVersion string `mapstructure:"service_version"`
	// Headers for the otlp protocol
	Headers map[string]string `mapstructure:"headers"`
}

func (*Config) InitDefault

func (c *Config) InitDefault(log *zap.Logger)

type Configurer

type Configurer interface {
	// RRVersion returns running RR version
	RRVersion() string
	// UnmarshalKey takes a single key and unmarshal it into a Struct.
	UnmarshalKey(name string, out any) error
	// Has checks if a config section exists.
	Has(name string) bool
}

type Exporter

type Exporter string

type Logger

type Logger interface {
	NamedLogger(name string) *zap.Logger
}

type Plugin

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

func (*Plugin) Init

func (p *Plugin) Init(cfg Configurer, log Logger) error

func (*Plugin) Middleware

func (p *Plugin) Middleware(next http.Handler) http.Handler

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

func (*Plugin) Stop

func (p *Plugin) Stop(ctx context.Context) error

func (*Plugin) Tracer

func (p *Plugin) Tracer() *sdktrace.TracerProvider

func (*Plugin) WorkerInterceptor

func (p *Plugin) WorkerInterceptor() interceptor.WorkerInterceptor

type Resource

type Resource struct {
	ServiceNameKey       string `mapstructure:"service_name"`
	ServiceNamespaceKey  string `mapstructure:"service_namespace"`
	ServiceInstanceIDKey string `mapstructure:"service_instance_id"`
	ServiceVersionKey    string `mapstructure:"service_version"`
}

Resource describes an entity about which identifying information and metadata is exposed. Resource is an immutable object, equivalent to a map from key to unique value