Documentation
¶
Overview ¶
Package streambench holds the result schema, statistics helpers and the regression comparison used by the streaming benchmarks in internal/nzbfilesystem and by cmd/compare.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AnyRegressed ¶
func FormatTable ¶
Types ¶
type Delta ¶
type Delta struct {
Scenario string
Metric string
Unit string
Base, New float64
Pct float64
HigherIsBetter bool
Informational bool
Regressed bool
}
type Metric ¶
type Metric struct {
Name string `json:"name"`
Unit string `json:"unit"`
Value float64 `json:"value"`
HigherIsBetter bool `json:"higher_is_better"`
// Informational metrics are reported but never fail the regression gate:
// tail percentiles from small samples and counts that depend on timing.
Informational bool `json:"informational,omitempty"`
// Tolerance, when non-zero, replaces the global threshold for this metric.
// It records measured run-to-run noise so a naturally jittery number does
// not fail the gate on noise alone.
Tolerance float64 `json:"tolerance,omitempty"`
}
Metric is one measured value. HigherIsBetter drives the regression rule: throughput is better when higher, latency and byte waste when lower.
type Result ¶
Click to show internal directories.
Click to hide internal directories.