observability

Documentation

Overview

Package observability declares the optional GOWDK Trace compiler/runtime capability and re-exports dependency-free runtime trace helpers.

Index

• Constants
• func Addon() gowdk.Addon
• func AlwaysOff() gowdktrace.Sampler
• func AlwaysOn() gowdktrace.Sampler
• func RatioSampler(ratio float64) gowdktrace.Sampler
• func WithSink(sink gowdktrace.Sink) gowdktrace.TracerOption
• type Collector
  • func NewCollector(limit int) *Collector
• type Tracer
  • func NewTracer(options ...gowdktrace.TracerOption) *Tracer

Constants

const ImportPath = "github.com/cssbruno/gowdk/addons/observability"

ImportPath is the canonical Go import path for the observability addon.

Functions

func Addon

func Addon() gowdk.Addon

Addon enables generated app trace wiring.

func AlwaysOff

func AlwaysOff() gowdktrace.Sampler

AlwaysOff samples no spans.

func AlwaysOn

func AlwaysOn() gowdktrace.Sampler

AlwaysOn samples every span.

func RatioSampler

func RatioSampler(ratio float64) gowdktrace.Sampler

RatioSampler samples a deterministic fraction of traces.

func WithSink

func WithSink(sink gowdktrace.Sink) gowdktrace.TracerOption

WithSink configures the completed span sink.

Types

type Collector

type Collector = gowdktrace.Collector

Collector stores recent spans and serves the self-contained viewer.

func NewCollector

func NewCollector(limit int) *Collector

NewCollector creates a bounded in-memory trace collector.

type Tracer

type Tracer = gowdktrace.Tracer

Tracer records spans for generated app instrumentation.

func NewTracer

func NewTracer(options ...gowdktrace.TracerOption) *Tracer

NewTracer creates a dependency-free tracer.