tracing

Documentation

Index

• func SetClientSpan(ctx context.Context, span trace.Span, m interface{})
• func SetServerSpan(ctx context.Context, span trace.Span, m interface{})
• type Metadata
  • func (b Metadata) Extract(parent context.Context, carrier propagation.TextMapCarrier) context.Context
  • func (b Metadata) Fields() []string
  • func (b Metadata) Inject(ctx context.Context, carrier propagation.TextMapCarrier)
• type Option
  • func WithGlobalPropagator() Option
  • func WithGlobalTracerProvider() Option
  • func WithPropagator(propagator propagation.TextMapPropagator) Option
  • func WithTracerName(tracerName string) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option
• type Tracer
  • func NewTracer(kind trace.SpanKind, spanName string, opts ...Option) *Tracer
  • func (t *Tracer) End(_ context.Context, span trace.Span, err error, attrs ...attribute.KeyValue)
  • func (t *Tracer) Inject(ctx context.Context, carrier propagation.TextMapCarrier)
  • func (t *Tracer) Start(ctx context.Context, operation string, carrier propagation.TextMapCarrier, ...) (context.Context, trace.Span)

Functions

func SetClientSpan

func SetClientSpan(ctx context.Context, span trace.Span, m interface{})

func SetServerSpan

func SetServerSpan(ctx context.Context, span trace.Span, m interface{})

Types

type Metadata

type Metadata struct{}

Metadata is tracing metadata propagator

func (Metadata) Extract

func (b Metadata) Extract(parent context.Context, carrier propagation.TextMapCarrier) context.Context

Extract returns a copy of parent with the metadata from the carrier added.

func (Metadata) Fields

func (b Metadata) Fields() []string

Fields returns the keys who's values are set with Inject.

func (Metadata) Inject

func (b Metadata) Inject(ctx context.Context, carrier propagation.TextMapCarrier)

Inject sets metadata key-values from ctx into the carrier.

type Option

type Option func(*options)

Option is tracing option.

func WithGlobalPropagator

func WithGlobalPropagator() Option

WithGlobalPropagator set the global TextMapPropagator

func WithGlobalTracerProvider

func WithGlobalTracerProvider() Option

WithGlobalTracerProvider set the registered global trace provider

func WithPropagator

func WithPropagator(propagator propagation.TextMapPropagator) Option

WithPropagator with tracer propagator.

func WithTracerName

func WithTracerName(tracerName string) Option

WithTracerName with tracer name

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider with tracer provider. By default, it uses the global provider that is set by otel.SetTracerProvider(provider).

type Tracer

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

Tracer is otel span tracer

func NewTracer

func NewTracer(kind trace.SpanKind, spanName string, opts ...Option) *Tracer

NewTracer create tracer instance

func (*Tracer) End

func (t *Tracer) End(_ context.Context, span trace.Span, err error, attrs ...attribute.KeyValue)

End finish tracing span

func (*Tracer) Inject

func (t *Tracer) Inject(ctx context.Context, carrier propagation.TextMapCarrier)

Inject set cross-cutting concerns from the Context into the carrier.

func (*Tracer) Start

func (t *Tracer) Start(ctx context.Context, operation string, carrier propagation.TextMapCarrier, attrs ...attribute.KeyValue) (context.Context, trace.Span)

Start starts tracing span