Skip to main content

Module metrics

Module metrics 

Source
Expand description

Metrics for recording information about execution

Structs§

BaselineMetrics
Helper for creating and tracking common “baseline” metrics for each operator
Count
A counter to record things such as number of input or output rows
ElapsedComputeFuture
Wraps any Future and accumulates the wall-clock time spent inside each Future::poll call into elapsed_compute. Everything that executes synchronously within a poll() scope is measured — including CPU-bound work, memory copies, and any blocking the future performs before returning. Time between polls (when the runtime has suspended the future waiting for I/O, a channel, or a waker) is not measured.
ExecutionPlanMetricsSet
A set of Metrics for an individual operator.
ExpressionEvaluatorMetrics
Tracks evaluation time for a sequence of expressions.
Gauge
A gauge is the simplest metrics type. It just returns a value. For example, you can easily expose current memory consumption with a gauge.
Label
name=value pairs identifying a metric. This concept is called various things in various different systems:
LabelValue
A label name or value.
Metric
Something that tracks a value of interest (metric) during execution.
MetricBuilder
Structure for constructing metrics, counters, timers, etc.
MetricsSet
A snapshot of the metrics for a particular execution plan.
PruningMetrics
Counters tracking pruning metrics
RatioMetrics
Counters tracking ratio metrics (e.g. matched vs total)
ScopedTimerGuard
RAAI structure that adds all time between its construction and destruction to the CPU time or the first call to stop whichever comes first
SpillMetrics
Helper for creating and tracking spill-related metrics for each operator
SplitMetrics
Metrics for tracking batch splitting activity
Time
Measure a potentially non contiguous duration of time
Timestamp
Stores a single timestamp, stored as the number of nanoseconds elapsed from Jan 1, 1970 UTC

Enums§

MetricCategory
Classifies a metric by what it measures.
MetricType
Categorizes metrics so the display layer can choose the desired verbosity.
MetricValue
Possible values for a super::Metric.
RatioMergeStrategy

Traits§

CustomMetricValue
A trait for implementing custom metric values.
ElapsedComputeFutureExt
Extension trait that wraps any Future with ElapsedComputeFuture.
RecordOutput
Trait for things that produce output rows as a result of execution.