Struct MetricsSet 

pub struct MetricsSet { /* private fields */ }

A snapshot of the metrics for a particular execution plan.

Implementations

impl MetricsSet

pub fn new() -> Self

Create a new container of metrics

pub fn push(&mut self, metric: Arc<Metric>)

Add the specified metric

pub fn iter(&self) -> impl Iterator<Item = &Arc<Metric>>

Returns an iterator across all metrics

pub fn output_rows(&self) -> Option<usize>

Convenience: return the number of rows produced, aggregated across partitions or None if no metric is present

pub fn spill_count(&self) -> Option<usize>

Convenience: return the count of spills, aggregated across partitions or None if no metric is present

pub fn spilled_bytes(&self) -> Option<usize>

Convenience: return the total byte size of spills, aggregated across partitions or None if no metric is present

pub fn spilled_rows(&self) -> Option<usize>

Convenience: return the total rows of spills, aggregated across partitions or None if no metric is present

pub fn elapsed_compute(&self) -> Option<usize>

Convenience: return the amount of elapsed CPU time spent, aggregated across partitions or None if no metric is present

pub fn sum<F>(&self, f: F) -> Option<MetricValue>

where F: FnMut(&Metric) -> bool,

Sums the values for metrics for which f(metric) returns true, and returns the value. Returns None if no metrics match the predicate.

pub fn sum_by_name(&self, metric_name: &str) -> Option<MetricValue>

Returns the sum of all the metrics with the specified name in the returned set.

pub fn aggregate_by_name(&self) -> Self

Returns a new derived MetricsSet where all metrics that had the same name have been aggregated together. The resulting MetricsSet has all metrics with Partition=None

pub fn sorted_for_display(self) -> Self

Sort the order of metrics so the “most useful” show up first

pub fn timestamps_removed(self) -> Self

Remove all timestamp metrics (for more compact display)

pub fn filter_by_metric_types(self, allowed: &[MetricType]) -> Self

Returns a new derived MetricsSet containing only metrics whose MetricType appears in allowed.

pub fn filter_by_categories(self, allowed: &[MetricCategory]) -> Self

Returns a new MetricsSet filtered by MetricCategory.

• Metrics that declared a category are kept only when that category appears in allowed.
• Metrics with no declared category are treated as Uncategorized for filtering.
• An empty allowed slice means “plan only”: all metrics are removed.

Trait Implementations

impl Clone for MetricsSet

fn clone(&self) -> MetricsSet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricsSet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MetricsSet

fn default() -> MetricsSet

Returns the “default value” for a type.

impl Display for MetricsSet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Format the MetricsSet as a single string

impl Extend<Arc<Metric>> for MetricsSet

fn extend<I: IntoIterator<Item = Arc<Metric>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<MetricsSet> for ExecutionPlanMetricsSet

fn from(metrics: MetricsSet) -> Self

Converts to this type from the input type.

impl FromIterator<Arc<Metric>> for MetricsSet

fn from_iter<T: IntoIterator<Item = Arc<Metric>>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a MetricsSet

type Item = &'a Arc<Metric>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Arc<Metric>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for MetricsSet

type Item = Arc<Metric>

The type of the elements being iterated over.

type IntoIter = IntoIter<<MetricsSet as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.