tracer

Documentation

Overview

Package tracer provides an interface for distributed tracing

Package tracer provides an interface for distributed tracing

Index

• func NewContext(ctx context.Context, tracer Tracer) context.Context
• func NewSpanContext(ctx context.Context, span Span) context.Context
• type EventOption
• type EventOptions
• type Label
  • func Any(k string, v interface{}) Label
  • func Bool(k string, v bool) Label
  • func Float64(k string, v float64) Label
  • func Int(k string, v int) Label
  • func Int64(k string, v int64) Label
  • func String(k string, v string) Label
• type Option
  • func Logger(l logger.Logger) Option
  • func Name(n string) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Span
  • func SpanFromContext(ctx context.Context) Span
• type SpanOption
• type SpanOptions
• type Tracer
  • func FromContext(ctx context.Context) Tracer
  • func NewTracer(opts ...Option) Tracer

Functions

func NewContext

func NewContext(ctx context.Context, tracer Tracer) context.Context

NewContext saves the tracer in the context

func NewSpanContext

func NewSpanContext(ctx context.Context, span Span) context.Context

NewSpanContext saves the span in the context

Types

type EventOption

type EventOption func(o *EventOptions)

type EventOptions

type EventOptions struct{}

type Label

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

func Any

func Any(k string, v interface{}) Label

func Bool

func Bool(k string, v bool) Label

func Float64

func Float64(k string, v float64) Label

func Int

func Int(k string, v int) Label

func Int64

func Int64(k string, v int64) Label

func String

func String(k string, v string) Label

type Option

type Option func(o *Options)

Option func

func Logger

func Logger(l logger.Logger) Option

Logger sets the logger

func Name

func Name(n string) Option

Name sets the name

type Options

type Options struct {
	// Logger used for logging
	Logger logger.Logger
	// Name of the tracer
	Name string
}

Options struct

func NewOptions

func NewOptions(opts ...Option) Options

NewOptions returns default options

type Span

type Span interface {
	// Tracer return underlining tracer
	Tracer() Tracer
	// Finish complete and send span
	Finish(opts ...SpanOption)
	// AddEvent add event to span
	AddEvent(name string, opts ...EventOption)
	// Context return context with span
	Context() context.Context
	// SetName set the span name
	SetName(name string)
	// SetLabels set the span labels
	SetLabels(labels ...Label)
}

func SpanFromContext

func SpanFromContext(ctx context.Context) Span

SpanFromContext returns a span from context

type SpanOption

type SpanOption func(o *SpanOptions)

type SpanOptions

type SpanOptions struct{}

type Tracer

type Tracer interface {
	// Name return tracer name
	Name() string
	// Init tracer with options
	Init(...Option) error
	// Start a trace
	Start(ctx context.Context, name string, opts ...SpanOption) (context.Context, Span)
}

Tracer is an interface for distributed tracing

var DefaultTracer Tracer = NewTracer()

DefaultTracer is the global default tracer

func FromContext

func FromContext(ctx context.Context) Tracer

FromContext returns a tracer from context

func NewTracer

func NewTracer(opts ...Option) Tracer

NewTracer returns new memory tracer