latency

package

v0.6.1 Latest Latest Go to latest Published: Sep 21, 2026 License: MIT Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/RandomCodeSpace/otelcontext

Links

Open Source Insights

Documentation ¶

Overview ¶

Package latency defines the shared provenance vocabulary for percentile values. Percentile algorithms remain with the packages that own the data.

Constants ¶

View Source

const (
	MethodPercentileDisc           = "percentile_disc"
	MethodOrderedRank              = "ordered_rank"
	MethodDDSketch                 = "ddsketch"
	MethodNearestRank              = "nearest_rank"
	MethodRetainedPrefix           = "retained_prefix"
	MethodAverageMultiplier        = "average_multiplier"
	MethodRollingObservationWindow = "rolling_observation_window"
)

View Source

const (
	ReasonNoObservations           = "no_observations"
	ReasonPercentileNotRecorded    = "percentile_not_recorded"
	ReasonInvalidDistribution      = "invalid_source_distribution"
	ReasonSketchCollapsed          = "sketch_collapsed"
	ReasonSketchSaturated          = "sketch_saturated"
	ReasonSketchCollapsedSaturated = "sketch_collapsed_and_saturated"
)

View Source

const LowSampleThreshold uint64 = 100

LowSampleThreshold is descriptive, not suppressive. Empirical percentiles below this population remain visible with LowSample set.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Percentile ¶

type Percentile struct {
	Status             Status  `json:"status"`
	Method             string  `json:"method"`
	SampleCount        uint64  `json:"sample_count"`
	PopulationCount    uint64  `json:"population_count,omitempty"`
	SampleLimit        uint64  `json:"sample_limit,omitempty"`
	LowSample          bool    `json:"low_sample,omitempty"`
	SketchScale        uint8   `json:"sketch_scale,omitempty"`
	RelativeErrorBound float64 `json:"relative_error_bound,omitempty"`
	Degraded           bool    `json:"degraded,omitempty"`
	Collapsed          bool    `json:"collapsed,omitempty"`
	Saturations        uint64  `json:"saturations,omitempty"`
	EstimateFactor     float64 `json:"estimate_factor,omitempty"`
	Reason             string  `json:"reason,omitempty"`
}

Percentile describes how one numeric percentile was produced.

type Provenance ¶

type Provenance struct {
	P50 *Percentile `json:"p50,omitempty"`
	P95 *Percentile `json:"p95,omitempty"`
	P99 *Percentile `json:"p99,omitempty"`
}

Provenance carries the claim independently for each percentile.

type Status ¶

type Status string

Status says what kind of claim a percentile value can support.

const (
	StatusMeasured    Status = "measured"
	StatusApproximate Status = "approximate"
	StatusEstimated   Status = "estimated"
	StatusBounded     Status = "bounded"
	StatusUnavailable Status = "unavailable"
)

Source Files ¶

View all Source files

provenance.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL