otelfiber

Documentation

Index

• Variables
• func New(config ...Config) fiber.Handler
• type Config

Variables

var ConfigDefault = Config{
	SpanName:       "http/request",
	LocalKeyName:   "otel-fiber",
	TracerProvider: otel.GetTracerProvider(),
	Propagators:    otel.GetTextMapPropagator(),
	TracerStartAttributes: []trace.SpanStartOption{
		trace.WithSpanKind(trace.SpanKindServer),
		trace.WithNewRoot(),
	},
}

ConfigDefault is the default config

Functions

func New

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

New creates a new middleware handler

Types

type Config

type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *fiber.Ctx) bool

	// LocalKeyName
	// Optional. Default: "otel-fiber".
	LocalKeyName string

	// SpanName is a template for span naming.
	// The scope is fiber context.
	SpanName string

	// TracerProvider
	// Optional. Default: otel.GetTracerProvider().
	TracerProvider trace.TracerProvider

	// Propagators
	// Optional. Default: otel.GetTextMapPropagator().
	Propagators propagation.TextMapPropagator

	// TracerStartAttributes
	//
	// Optional. Default: []trace.SpanStartOption{
	// 	trace.WithSpanKind(trace.SpanKindServer),
	// 	trace.WithNewRoot(),
	// }
	TracerStartAttributes []trace.SpanStartOption
}

Config defines the config for middleware.