tracer

Documentation

Index

• Constants
• Variables
• func TestTracer(t *testing.T, tracer Tracer)
• type Context
• type Span
• type Tracer
  • func NewNullTracer() Tracer

Constants

const (
	PackageName = "go-tracing"
)

const (
	Version = "v1.1.4"
)

Variables

var NullSpan = nullSpan{}

NullSpan is a null tracing span.

var NullSpanContext = nullSpanCotext{}

NullSpanContext is a null tracing span context.

var NullTracer = &nullTacer{}

NullTracer is a null tracing tracer.

Functions

func TestTracer

func TestTracer(t *testing.T, tracer Tracer)

Types

type Context

type Context interface {
	// Span returns the current top tracer span on the tracer span stack.
	Span() Span
	// StartSpan starts a new child tracer span and pushes it onto the tracer span stack.
	StartSpan(name string) bool
	// FinishSpan ends the current top tracer span and pops it from the tracer span stack.
	FinishSpan() bool
}

Context represents a span context.

type Span

type Span interface {
	// SetTag sets a tag on the span.
	SetTag(key string, value any)
	// Finish marks the end of the span.
	Finish()
	// Context returns the span's context.
	Context() context.Context
	// StartSpan starts a new child span.
	StartSpan(name string) Context
}

type Tracer

type Tracer interface {
	// SetPackageName sets a package name.
	SetPackageName(name string)
	// SetServiceName sets a service name.
	SetServiceName(name string)
	// SetEndpoint sets an endpoint.
	SetEndpoint(endpoint string)
	// PackageName returns the package name.
	PackageName() string
	// ServiceName returns the service name.
	ServiceName() string
	// Endpoint returns the endpoint.
	Endpoint() string
	// StartSpan starts a new span.
	StartSpan(name string) Context
	// Start starts a tracer.
	Start() error
	// Stop stops a tracer.
	Stop() error
}

func NewNullTracer

func NewNullTracer() Tracer

NewNullTracer returns a new null tracing tracer.