Struct Rate 

pub struct Rate { /* private fields */ }

The rate of the given quantity. By default this is the total observed over a set of samples from a sampled statistic divided by the elapsed time over the sample windows. Alternative SampledStat implementations can be provided, however, to record the rate of occurrences (e.g. the count of values measured over the time interval) or other such values.

Implementations

impl Rate

pub fn new() -> Self

Create a Rate over seconds backed by a WindowedSum.

pub fn with_unit(unit: TimeUnit) -> Self

Create a Rate with the given unit backed by a WindowedSum.

Arguments

• unit - the time unit of the rate

pub fn with_stat(stat: Arc<SampledStat>) -> Self

Create a Rate over seconds backed by the given sampled stat.

Arguments

• stat - the sampled stat whose total the rate divides

pub fn with_unit_stat(unit: TimeUnit, stat: Arc<SampledStat>) -> Self

Create a Rate with the given unit and sampled stat.

Arguments

• unit - the time unit of the rate
• stat - the sampled stat whose total the rate divides

pub fn with_unit_stat_window( unit: TimeUnit, stat: Arc<SampledStat>, window: i64, ) -> Self

Create a Rate with the given unit, sampled stat and explicit window.

Arguments

• unit - the time unit of the rate and of window
• stat - the sampled stat whose total the rate divides
• window - when positive, the stat’s own time window, in unit

pub fn unit_name(&self) -> String

Returns the lower-cased name of the rate’s unit with the trailing “s” stripped, e.g. SECONDS -> second.

pub fn window_size(&self, config: &MetricConfig, now: i64) -> i64

Compute the window size in milliseconds used for the rate calculation.

Arguments

• config - the metric’s configuration
• now - the current POSIX time in milliseconds

Returns

The window size in milliseconds.

Trait Implementations

impl Debug for Rate

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

Formats the value using the given formatter.

impl Default for Rate

fn default() -> Self

Returns the “default value” for a type.

impl Display for Rate

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

Java’s toString(), which SimpleRate inherits.

impl Measurable for Rate

fn measure(&self, config: &MetricConfig, now: i64) -> f64

Measure this quantity and return the result as a double.

fn type_name(&self) -> Option<&'static str>

Returns the provider’s type name, as KafkaMetric’s Display reports it, or None for a provider that is a closure.

impl Stat for Rate

fn record(&self, config: &MetricConfig, value: f64, time_ms: i64)

Record the given value.