pub struct TimingDistributionMetric { /* private fields */ }
Expand description

A timing distribution metric.

Timing distributions are used to accumulate and store time measurement, for analyzing distributions of the timing data.

Implementations§

Creates a new timing distribution metric.

Starts tracking time for the provided metric.

This records an error if it’s already tracking time (i.e. set_start was already called with no corresponding set_stop_and_accumulate): in that case the original start time will be preserved.

Arguments
  • start_time - Timestamp in nanoseconds.
Returns

A unique TimerId for the new timer.

Stops tracking time for the provided metric and associated timer id.

Adds a count to the corresponding bucket in the timing distribution. This will record an error if no set_start was called.

Arguments
  • id - The TimerId to associate with this timing. This allows for concurrent timing of events associated with different ids to the same timespan metric.
  • stop_time - Timestamp in nanoseconds.

Aborts a previous start call.

No error is recorded if no start was called.

Arguments
  • id - The TimerId to associate with this timing. This allows for concurrent timing of events associated with different ids to the same timing distribution metric.

Accumulates the provided signed samples in the metric.

This is required so that the platform-specific code can provide us with 64 bit signed integers if no u64 comparable type is available. This will take care of filtering and reporting errors for any provided negative sample.

Please note that this assumes that the provided samples are already in the “unit” declared by the instance of the metric type (e.g. if the instance this method was called on is using TimeUnit::Second, then samples are assumed to be in that unit).

Arguments
  • samples - The vector holding the samples to be recorded by the metric.
Notes

Discards any negative value in samples and report an ErrorType::InvalidValue for each of them. Reports an ErrorType::InvalidOverflow error for samples that are longer than MAX_SAMPLE_TIME.

Accumulates precisely one signed sample and appends it to the metric.

Precludes the need for a collection in the most common use case.

Sign is required so that the platform-specific code can provide us with a 64 bit signed integer if no u64 comparable type is available. This will take care of filtering and reporting errors for any provided negative sample.

Please note that this assumes that the provided sample is already in the “unit” declared by the instance of the metric type (e.g. if the instance this method was called on is using crate::TimeUnit::Second, then sample is assumed to be in that unit).

Arguments
  • sample - The singular sample to be recorded by the metric.
Notes

Discards any negative value and reports an ErrorType::InvalidValue. Reports an ErrorType::InvalidOverflow error if the sample is longer than MAX_SAMPLE_TIME.

Accumulates the provided samples in the metric.

Arguments
  • samples - A list of samples recorded by the metric. Samples must be in nanoseconds.
Notes

Reports an ErrorType::InvalidOverflow error for samples that are longer than MAX_SAMPLE_TIME.

Test-only API (exported for FFI purposes).

Gets the currently stored value as an integer.

This doesn’t clear the stored value.

Arguments
  • ping_name - the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.
Returns

The stored value or None if nothing stored.

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments
  • error - The type of error
Returns

The number of errors reported.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Access the stored metadata
Create a new metric from this with a new name.
Create a new metric from this with a specific label.
Whether this metric should currently be recorded Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Create a new handle for an Arc value Read more
Clone a handle Read more
Consume a handle, getting back the initial Arc<>
Get a clone of the Arc<> using a “borrowed” handle. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.