trace

Documentation

Overview

Package trace provides an interface for distributed tracing

Index

• Constants
• func Finish(span *Span) error
• func FromContext(ctx context.Context) (string, string, bool)
• func ToContext(ctx context.Context, traceID, parentSpanID string) context.Context
• type Option
• type Options
  • func DefaultOptions() Options
• type ReadOption
  • func ReadTrace(t string) ReadOption
• type ReadOptions
• type Span
  • func Read(opts ...ReadOption) ([]*Span, error)
  • func Start(ctx context.Context, name string) (context.Context, *Span)
• type SpanType
• type Tracer

Constants

const (
	// DefaultSize of the buffer
	DefaultSize = 64
)

Functions

func Finish

func Finish(span *Span) error

func FromContext

func FromContext(ctx context.Context) (string, string, bool)

FromContext returns a span from context

func ToContext

func ToContext(ctx context.Context, traceID, parentSpanID string) context.Context

ToContext saves the trace and span ids in the context

Types

type Option

type Option func(o *Options)

type Options

type Options struct {
	// Size is the size of ring buffer
	Size int
}

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns default options

type ReadOption

type ReadOption func(o *ReadOptions)

func ReadTrace

func ReadTrace(t string) ReadOption

ReadTrace Reads the given trace

type ReadOptions

type ReadOptions struct {
	// Trace id
	Trace string
}

type Span

type Span struct {
	// Id of the trace
	Trace string
	// name of the span
	Name string
	// id of the span
	Id string
	// parent span id
	Parent string
	// Start time
	Started time.Time
	// Duration in nano seconds
	Duration time.Duration
	// associated data
	Metadata map[string]string
	// Type
	Type SpanType
}

Span is used to record an entry

func Read

func Read(opts ...ReadOption) ([]*Span, error)

func Start

func Start(ctx context.Context, name string) (context.Context, *Span)

type SpanType

type SpanType int

SpanType describe the nature of the trace span

const (
	// SpanTypeRequestInbound is a span created when serving a request
	SpanTypeRequestInbound SpanType = iota
	// SpanTypeRequestOutbound is a span created when making a service call
	SpanTypeRequestOutbound
)

type Tracer

type Tracer interface {
	// Start a trace
	Start(ctx context.Context, name string) (context.Context, *Span)
	// Finish the trace
	Finish(*Span) error
	// Read the traces
	Read(...ReadOption) ([]*Span, error)
}

Tracer is an interface for distributed tracing

var (
	DefaultTracer Tracer = new(noop)

	Flag = pflag.NewFlagSet("trace", pflag.ExitOnError)
)