micro/tracer/tracer.go

// Package tracer provides an interface for distributed tracing
package tracer // import "go.unistack.org/micro/v4/tracer"

import (
	"context"

	"go.unistack.org/micro/v4/options"
)

// DefaultTracer is the global default tracer
var DefaultTracer = NewTracer()

// Tracer is an interface for distributed tracing
type Tracer interface {
	// Name return tracer name
	Name() string
	// Init tracer with options
	Init(...options.Option) error
	// Start a trace
	Start(ctx context.Context, name string, opts ...options.Option) (context.Context, Span)
	// Flush flushes spans
	Flush(ctx context.Context) error
}

type Span interface {
	// Tracer return underlining tracer
	Tracer() Tracer
	// Finish complete and send span
	Finish(opts ...options.Option)
	// AddEvent add event to span
	AddEvent(name string, opts ...options.Option)
	// Context return context with span
	Context() context.Context
	// SetName set the span name
	SetName(name string)
	// SetStatus set the span status code and msg
	SetStatus(status SpanStatus, msg string)
	// Status returns span status and msg
	Status() (SpanStatus, string)
	// SetLabels set the span labels
	SetLabels(labels ...interface{})
	// AddLabels append the span labels
	AddLabels(labels ...interface{})
	// Kind returns span kind
	Kind() SpanKind
}