Skip to main content

MetricsFileSink

Struct MetricsFileSink 

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

Writer for one metrics output file.

JSONL output appends one object per event. Prometheus output atomically replaces the file with the latest encoded snapshot on each write.

Implementations§

Source§

impl MetricsFileSink

Source

pub fn new(path: impl Into<PathBuf>, format: MetricsFileFormat) -> Result<Self>

Create a sink with the default Prometheus metric prefix.

Source

pub fn with_prefix( path: impl Into<PathBuf>, format: MetricsFileFormat, metric_prefix: impl Into<String>, ) -> Result<Self>

Create a sink with a custom Prometheus metric prefix.

Source

pub fn with_prefix_and_labels<I, K, V>( path: impl Into<PathBuf>, format: MetricsFileFormat, metric_prefix: impl Into<String>, labels: I, ) -> Result<Self>
where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Create a sink with a custom Prometheus metric prefix and labels.

Labels are applied only to Prometheus text exposition output. JSONL output carries structured metric fields and its own schema version.

Source

pub fn path(&self) -> &Path

Return the output path this sink writes.

Source

pub fn format(&self) -> MetricsFileFormat

Return the configured output format.

Source

pub fn write_event(&self, event: &MetricEvent) -> Result<()>

Write one metrics stream event.

Source

pub fn write_interval(&self, metrics: &Metrics) -> Result<()>

Write one immediate interval sample.

Source

pub fn write_window(&self, metrics: &WindowMetrics) -> Result<()>

Write one aggregated window summary.

Trait Implementations§

Source§

impl Clone for MetricsFileSink

Source§

fn clone(&self) -> MetricsFileSink

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetricsFileSink

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more