Collector

Struct Collector 

Source
pub struct Collector {
    pub config: Config,
    /* private fields */
}
Expand description

Embedded CloudWatch Metrics Collector + Emitter

Use Builder to construct

§Example

let metrics = metrics_cloudwatch_embedded::Builder::new()
     .cloudwatch_namespace("MyApplication")
     .init()
     .unwrap();

 metrics::counter!("requests", "Method" => "Default").increment(1);

 metrics
     .set_property("RequestId", "ABC123")
     .flush(std::io::stdout());

Fields§

§config: Config

Implementations§

Source§

impl Collector

Source

pub fn new(config: Config, lambda_cold_start_span: Option<Span>) -> Self

Source

pub fn set_property( &self, name: impl Into<SharedString>, value: impl Into<Value>, ) -> &Self

Set a property to emit with the metrics

  • Properites persist accross flush calls
  • Setting a property with same name multiple times will overwrite the previous value
Source

pub fn remove_property<'a>(&'a self, name: impl Into<&'a str>) -> &'a Self

Removes a property to emit with the metrics

Source

pub fn flush(&self, writer: impl Write) -> Result<()>

Flush the current counter values to an implementation of std::io::Write

Source

pub fn write_single( &self, name: impl Into<SharedString>, unit: Option<Unit>, value: impl Into<Value>, writer: impl Write, ) -> Result<()>

Write a single metric to an implementation of std::io::Write, avoids the overhead of going through the metrics recorder

Source

pub fn take_cold_start_span(&self) -> Option<Span>

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> 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, 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,