Struct Sample

pub struct Sample { /* private fields */ }

A collection of metrics taken from the benchmark for a given time window.

The sample contains the standard metrics (latency, IO, etc…) along with any errors, the worker ID and sample tag which can be used to group results.

Internally this uses HDR Histograms which can generate the min, max, stdev and varying percentile statistics of the benchmark.

Implementations

impl Sample

pub fn total_requests(&self) -> usize

The total number of requests within the sample including any errors.

pub fn total_successful_requests(&self) -> usize

The total number of requests within the sample that passed validation and did not error.

pub fn total_duration(&self) -> Duration

The total duration of requests within the sample.

pub fn total_latency_duration(&self) -> Duration

The total duration of requests within the sample from the latency of each request.

pub fn metadata(&self) -> SampleMetadata

The sample metadata.

pub fn latency(&self) -> &Histogram<u32>

The sample latency histogram

pub fn write_transfer(&self) -> &Histogram<u32>

The sample write transfer rate histogram

pub fn read_transfer(&self) -> &Histogram<u32>

The sample read transfer rate histogram

pub fn errors(&self) -> &[ValidationError]

The errors that occurred during the sample

pub fn tag(&self) -> usize

The current sample batch tag.

Trait Implementations

impl Add for Sample

type Output = Sample

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Sample

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.