Struct MetricConfig 

pub struct MetricConfig { /* private fields */ }

Configuration values for metrics.

Implementations

impl MetricConfig

pub const DEFAULT_NUM_SAMPLES: i32 = 2

Default number of samples for a windowed stat.

pub fn new() -> Self

Create a MetricConfig with default values.

pub fn quota(&self) -> Option<&Quota>

Returns the configured quota, None when there is none.

pub fn set_quota(self, quota: Quota) -> Self

Sets the quota.

Arguments

• quota - the quota a sensor using this config enforces

Returns

This config, for chaining.

pub fn event_window(&self) -> i64

Returns the number of events in an event window.

pub fn set_event_window(self, window: i64) -> Self

Sets the event window.

Arguments

• window - the number of events in a sample window

Returns

This config, for chaining.

pub fn time_window_ms(&self) -> i64

Returns the time window in milliseconds.

pub fn set_time_window(self, window: i64, unit: TimeUnit) -> Self

Sets the time window, expressed in the given unit.

Arguments

• window - the length of a sample window, in unit
• unit - the unit of window

Returns

This config, for chaining.

pub fn tags(&self) -> &BTreeMap<String, String>

Returns the default tags for metrics using this config.

pub fn set_tags(self, tags: BTreeMap<String, String>) -> Self

Sets the default tags.

Arguments

• tags - the default tags for metrics using this config

Returns

This config, for chaining.

pub fn samples(&self) -> i32

Returns the number of samples for windowed stats.

pub fn set_samples(self, samples: i32) -> Self

Sets the number of samples.

Arguments

• samples - the number of samples for windowed stats, at least 1

Returns

This config, for chaining.

Panics

If samples < 1, with the message of Java’s IllegalArgumentException: a broken argument precondition. The client configs reject metrics.num.samples below 1 before it reaches here.

pub fn record_level(&self) -> RecordingLevel

Returns the recording level.

pub fn set_record_level(self, recording_level: RecordingLevel) -> Self

Sets the recording level.

Arguments

• recording_level - the level at which sensors using this config record

Returns

This config, for chaining.

Trait Implementations

impl Clone for MetricConfig

fn clone(&self) -> MetricConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricConfig

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

Formats the value using the given formatter.

impl Default for MetricConfig

fn default() -> Self

Returns the “default value” for a type.