Skip to main content

MetricsRegistry

Struct MetricsRegistry 

Source
pub struct MetricsRegistry { /* private fields */ }
Expand description

Registry of all metrics in the game

Implementations§

Source§

impl MetricsRegistry

Source

pub fn new() -> Self

Create a new metrics registry

Source

pub fn with_config(config: MetricsConfig) -> Self

Create a registry with custom config

Source

pub fn config(&self) -> &MetricsConfig

Get the current configuration

Source

pub fn set_config(&mut self, config: MetricsConfig)

Set the configuration

Source

pub fn define(&mut self, definition: MetricDefinition)

Define a new metric

Source

pub fn record(&mut self, value: MetricValue) -> Result<(), String>

Record a metric value

Source

pub fn remove(&mut self, metric_id: &MetricId)

Remove a metric and all its values

Source

pub fn clear(&mut self)

Clear all metrics and values

Source

pub fn all_values( &self, ) -> impl Iterator<Item = (&MetricId, &VecDeque<MetricValue>)>

Get all values for all metrics (for snapshot creation)

Source

pub fn aggregate( &self, metric_id: &MetricId, aggregation: AggregationType, period_start: u64, period_end: u64, ) -> Option<AggregatedMetric>

Get aggregated metric for a specific period

Source

pub fn get_values(&self, metric_id: &MetricId) -> Option<&VecDeque<MetricValue>>

Get all values for a metric (within window)

Source

pub fn get_definition(&self, metric_id: &MetricId) -> Option<&MetricDefinition>

Get metric definition

Source

pub fn list_metrics(&self) -> Vec<&MetricDefinition>

List all defined metrics

Source

pub fn last_snapshot_time(&self) -> u64

Get last snapshot time

Source

pub fn set_last_snapshot_time(&mut self, time: u64)

Set last snapshot time

Source

pub fn last_report_time(&self) -> u64

Get last report time

Source

pub fn set_last_report_time(&mut self, time: u64)

Set last report time

Source

pub fn is_snapshot_due(&self, current_time: u64) -> bool

Check if snapshot is due

Source

pub fn is_report_due(&self, current_time: u64) -> bool

Check if report is due

Trait Implementations§

Source§

impl Clone for MetricsRegistry

Source§

fn clone(&self) -> MetricsRegistry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetricsRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MetricsRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for MetricsRegistry

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MetricsRegistry

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Component for T
where T: Send + Sync + 'static,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Item for T
where T: Clone + Send + Sync + 'static,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> RuntimeResourceEntry for T
where T: 'static + Send + Sync,

Source§

fn insert(self: Box<T>, ctx: &mut ResourceContext)

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V