Module metrics

Module metrics 

Source
Expand description

Metrics for recording information about execution

Modules§

baseline 🔒
Metrics common for almost all operators
builder 🔒
Builder for creating arbitrary metrics
custom 🔒
Custom metric value type.
value 🔒
Value representation of metrics

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
ExecutionPlanMetricsSet
A set of Metrics for an individual “operator” (e.g. &dyn ExecutionPlan).
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:
Metric
Something that tracks a value of interest (metric) of a DataFusion ExecutionPlan execution.
MetricBuilder
Structure for constructing metrics, counters, timers, etc.
MetricsSet
A snapshot of the metrics for a particular (ExecutionPlan).
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 crate::stream::BatchSplitStream 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§

MetricType
Categorizes metrics so the display layer can choose the desired verbosity.
MetricValue
Possible values for a super::Metric.

Traits§

CustomMetricValue
A trait for implementing custom metric values.
RecordOutput
Trait for things that produce output rows as a result of execution.