package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
GetOpenmetricsLabelMap creates a map of label keys and values It takes roachtest parameters and create relevant labels.
GetOpenmetricsLabelString creates a string that follows the openmetrics labels format.
NewClusterStatStreamer returns an implementation of StatsStreamer.
NewStatsCollector returns an implementation of the StatCollector interface.
SetupCollectorPromClient instantiates a prometheus client for the given configuration.
TrimTaggedSeries returns a map of labeled time series values that have equal start times, end times, and length.
# Structs
AggQuery represents a two tier query, that (1) provides a query generating multiple labeled timeseries results (AggQuery.Stat) and (2) a method to aggregate the multiple time series in (1).
ClusterStat represents a filtered query by the given LabelName.
ClusterStatRun holds the summary value for a test run as well as per stat information collected during the run.
Interval represents a start and end time.
StatEvent represents a prometheus statistic point-in-time result, for a query.
StatPoint represents a cluster metric value at a point in time.
StatSummary holds the timeseries of some cluster aggregate statistic.
# Interfaces
StatCollector provides a wrapper over PromQL, to query and return interval and point in time statistics.
StatExporter defines an interface to export statistics to roachperf.
StatStreamer collects registered point-in-time stats at an interval and reports them for processing.
# Type aliases
AggregateFn processes a map of labeled series', aggregating into a single series.
ProcessStatEventFn processes a collection of stat events.
StatSeries is a collection of StatPoints, sorted in ascending order by StatPoint.Time.