fotel

Documentation

Index

• Constants
• Variables
• func FromCtx(ctx *fiber.Ctx) context.Context
• func New(config ...Config) fiber.Handler
• func SpanFromCtx(ctx *fiber.Ctx) trace.Span
• type Config
• type Filter
  • func FilterPathExact(paths ...string) Filter

Constants

const LocalsCtxKey = "otel-ctx"

Variables

var ConfigDefault = Config{
	SpanName:     "{{ .Method }} {{ .Path }}",
	LocalKeyName: LocalsCtxKey,
	TracerStartAttributes: []trace.SpanStartOption{
		trace.WithSpanKind(trace.SpanKindServer),
	},
	Propagator: propagation.NewCompositeTextMapPropagator(b3.New(b3.WithInjectEncoding(b3.B3MultipleHeader)), propagation.TraceContext{}, propagation.Baggage{}),
}

ConfigDefault is the default config

var Tracer = otel.Tracer("fiber-otel-router")

Functions

func FromCtx

func FromCtx(ctx *fiber.Ctx) context.Context

func New

func New(config ...Config) fiber.Handler

New creates a new middleware handler

func SpanFromCtx

func SpanFromCtx(ctx *fiber.Ctx) trace.Span

Types

type Config

type Config struct {
	Tracer                trace.Tracer
	TracerStartAttributes []trace.SpanStartOption
	// SpanName is a template for span naming.
	// The scope is fiber context.
	SpanName     string
	LocalKeyName string
	Filters      []Filter //Blacklist filter
	Propagator   propagation.TextMapPropagator
}

Config defines the config for middleware.

type Filter

type Filter func(c *fiber.Ctx) bool

func FilterPathExact

func FilterPathExact(paths ...string) Filter