Struct StreamMetrics 

pub struct StreamMetrics {
    end_time: Timestamp,
    mem_used: Gauge,
    output_rows: Count,
    poll_elapsed: Time,
    await_elapsed: Time,
}

This metrics struct is used to record and hold metrics like memory usage of result batch in crate::table::scan::StreamWithMetricWrapper during query execution.

Fields

end_time: Timestamp

Timestamp when the stream finished

mem_used: Gauge

Used memory in bytes

output_rows: Count

Number of rows in output

poll_elapsed: Time

Elapsed time used to poll the stream

await_elapsed: Time

Elapsed time used to .awaiting the stream

Implementations

impl StreamMetrics

pub fn new(metrics: &ExecutionPlanMetricsSet, partition: usize) -> Self

Create a new MemoryUsageMetrics structure, and set start_time to now

pub fn record_mem_usage(&self, mem_used: usize)

pub fn record_output(&self, num_rows: usize)

pub fn try_done(&self)

Record the end time of the query

pub fn poll_timer(&self) -> ScopedTimerGuard<'_>

Return a timer guard that records the time elapsed in poll

pub fn record_await_duration(&self, duration: Duration)

Trait Implementations

impl Clone for StreamMetrics

fn clone(&self) -> StreamMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMetrics

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

Formats the value using the given formatter.

impl Drop for StreamMetrics

fn drop(&mut self)

Executes the destructor for this type.