otel

Documentation

Overview

Package otel provides otel support.

Index

• func AddSpan(ctx context.Context, spanName string, keyValues ...attribute.KeyValue) (context.Context, trace.Span)
• func AddTraceToRequest(ctx context.Context, r *http.Request)
• func GetTraceID(ctx context.Context) string
• func InitTracing(log *logger.Logger, cfg Config) (trace.TracerProvider, func(ctx context.Context), error)
• func InjectTracing(ctx context.Context, tracer trace.Tracer) context.Context
• type Config

Functions

func AddSpan

func AddSpan(ctx context.Context, spanName string, keyValues ...attribute.KeyValue) (context.Context, trace.Span)

AddSpan adds an otel span to the existing trace.

func AddTraceToRequest

func AddTraceToRequest(ctx context.Context, r *http.Request)

AddTraceToRequest adds the current trace id to the request so it can be delivered to the service being called.

func GetTraceID

func GetTraceID(ctx context.Context) string

GetTraceID returns the trace id from the context.

func InitTracing

func InitTracing(log *logger.Logger, cfg Config) (trace.TracerProvider, func(ctx context.Context), error)

InitTracing configures open telemetry to be used with the service.

func InjectTracing

func InjectTracing(ctx context.Context, tracer trace.Tracer) context.Context

InjectTracing initializes the request for tracing by writing otel related information into the response and saving the tracer and trace id in the context for later use.

Types

type Config

type Config struct {
	ServiceName    string
	Host           string
	ExcludedRoutes map[string]struct{}
	Probability    float64
}

Config defines the information needed to init tracing.