Struct RootEntry 

pub struct RootEntry<M: InflectableEntry> { /* private fields */ }

“Roots” an InflectableEntry to turn it into an Entry that can be passed to an EntrySink.

The names in an InflectableEntry such as the struct created by closing over a metrics value can be inflected at compile time, for example by adding a prefix. To send the metrics to an entry sink, the metrics need to be rooted by using a RootEntry.

When using append_and_close, the metrics are rooted for you, but it is also possible to root a metric entry in your own code.

Example

use metrique::{CloseValue, ServiceMetrics, RootEntry};
use metrique::unit_of_work::metrics;
use metrique::writer::{EntrySink, GlobalEntrySink};

#[metrics]
struct MyMetrics {
    operation: &'static str,
}

let metrics = MyMetrics {
    operation: "example",
};
// same as calling `drop(metrics.append_on_drop(ServiceMetrics::sink()));`
ServiceMetrics::sink().append(RootEntry::new(metrics.close()));

Implementations

impl<M: InflectableEntry> RootEntry<M>

pub fn new(metric: M) -> Self

create a new RootEntry

Trait Implementations

impl<M: InflectableEntry> Entry for RootEntry<M>

fn write<'a>(&'a self, w: &mut impl EntryWriter<'a>)

Write the metric values contained in this entry to the format-provided EntryWriter. The writer corresponds to an atomic entry written to the metrics consumer, like CloudWatch.

fn sample_group(&self) -> impl Iterator<Item = SampleGroupElement>

The key used to group “similar” entries when sampling. Defaults to the empty group.

fn merge<E>(self, other: E) -> Merged<Self, E>

where Self: Sized,

Create a new entry that writes all the contents of this entry and then all of the contents of other.

fn merge_by_ref<'a, E>(&'a self, other: &'a E) -> MergedRef<'a, Self, E>

where E: 'a + Entry,

Like Entry::merge, but does so by reference.

fn boxed(self) -> BoxEntry

where Self: Sized + Send + 'static,

Move the entry to the heap and rely on dynamic dispatch.