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 DropSpansNamed(name string) gowdktrace.SamplerRule
• func KeepSpansNamed(name string) gowdktrace.SamplerRule
• func MatchLane(lane Lane) func(SamplingContext) bool
• func MatchSpanName(name string) func(SamplingContext) bool
• func MatchSpanNamePrefix(prefix string) func(SamplingContext) bool
• func MatchSurface(surface Surface) func(SamplingContext) bool
• func ParentBasedSampler(root gowdktrace.Sampler) gowdktrace.Sampler
• func RatioSampler(ratio float64) gowdktrace.Sampler
• func RuleSampler(base gowdktrace.Sampler, rules ...gowdktrace.SamplerRule) gowdktrace.Sampler
• func WithSink(sink gowdktrace.Sink) gowdktrace.TracerOption
• type Collector
  • func NewCollector(limit int, options ...CollectorOption) *Collector
• type CollectorOption
  • func WithCollectorIngestRate(limit int, window time.Duration) CollectorOption
  • func WithCollectorSSELimit(limit int) CollectorOption
• type Lane
• type SamplerRule
• type SamplingContext
• type Surface
• type Tracer
  • func NewTracer(options ...gowdktrace.TracerOption) *Tracer

Constants

const (
	SurfaceBackend  = gowdktrace.SurfaceBackend
	SurfaceFrontend = gowdktrace.SurfaceFrontend
	SurfaceWorker   = gowdktrace.SurfaceWorker
)

Surface values for use with MatchSurface.

const (
	LaneRoute    = gowdktrace.LaneRoute
	LaneGuard    = gowdktrace.LaneGuard
	LaneHandler  = gowdktrace.LaneHandler
	LaneSSR      = gowdktrace.LaneSSR
	LaneAction   = gowdktrace.LaneAction
	LaneAPI      = gowdktrace.LaneAPI
	LaneFragment = gowdktrace.LaneFragment
	LaneContract = gowdktrace.LaneContract
	LaneJob      = gowdktrace.LaneJob
	LaneIsland   = gowdktrace.LaneIsland
	LaneNav      = gowdktrace.LaneNav
	LaneUser     = gowdktrace.LaneUser
)

Lane values for use with MatchLane.

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 DropSpansNamed

func DropSpansNamed(name string) gowdktrace.SamplerRule

DropSpansNamed builds a rule that always drops spans with the exact name.

func KeepSpansNamed

func KeepSpansNamed(name string) gowdktrace.SamplerRule

KeepSpansNamed builds a rule that always keeps spans with the exact name.

func MatchLane

func MatchLane(lane Lane) func(SamplingContext) bool

MatchLane builds a matcher for spans on the given GOWDK lane.

func MatchSpanName

func MatchSpanName(name string) func(SamplingContext) bool

MatchSpanName builds a matcher for spans whose name equals name.

func MatchSpanNamePrefix

func MatchSpanNamePrefix(prefix string) func(SamplingContext) bool

MatchSpanNamePrefix builds a matcher for spans whose name starts with prefix.

func MatchSurface

func MatchSurface(surface Surface) func(SamplingContext) bool

MatchSurface builds a matcher for spans on the given GOWDK surface.

func ParentBasedSampler

func ParentBasedSampler(root gowdktrace.Sampler) gowdktrace.Sampler

ParentBasedSampler keeps a trace whole: it honors a propagated parent decision and samples roots with root. It is the production-safe default for distributed tracing.

func RatioSampler

func RatioSampler(ratio float64) gowdktrace.Sampler

RatioSampler samples a deterministic fraction of traces.

func RuleSampler

func RuleSampler(base gowdktrace.Sampler, rules ...gowdktrace.SamplerRule) gowdktrace.Sampler

RuleSampler applies per-span override rules (silence health checks, force high-value endpoints on) before falling back to base.

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, options ...CollectorOption) *Collector

NewCollector creates a bounded in-memory trace collector.

type CollectorOption

type CollectorOption = gowdktrace.CollectorOption

CollectorOption configures a Collector.

func WithCollectorIngestRate

func WithCollectorIngestRate(limit int, window time.Duration) CollectorOption

WithCollectorIngestRate configures the collector's per-client POST rate.

func WithCollectorSSELimit

func WithCollectorSSELimit(limit int) CollectorOption

WithCollectorSSELimit configures the collector's concurrent SSE stream cap.

type Lane

type Lane = gowdktrace.Lane

Lane identifies the GOWDK execution lane a span represents. Re-exported with its values so MatchLane rules can be written without importing runtime/trace directly.

type SamplerRule

type SamplerRule = gowdktrace.SamplerRule

SamplerRule overrides the sampling decision for matching spans.

type SamplingContext

type SamplingContext = gowdktrace.SamplingContext

SamplingContext is the per-span context a SamplerRule matcher inspects.

type Surface

type Surface = gowdktrace.Surface

Surface identifies where a span was produced. Re-exported with its values so MatchSurface rules can be written without importing runtime/trace directly.

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.