Skip to main content

StatsExporter

Struct StatsExporter 

Source
pub struct StatsExporter<Cap: HttpClientCapability + SleepCapability, Con: FlushableConcentrator = SpanConcentrator> { /* private fields */ }
Expand description

An exporter that concentrates and sends stats to the agent.

Cap is the capabilities bundle (HTTP + sleep). Leaf crates pin it to a concrete type (NativeCapabilities or WasmCapabilities).

Implementations§

Source§

impl<Cap: HttpClientCapability + SleepCapability, Con: FlushableConcentrator> StatsExporter<Cap, Con>

Source

pub fn new( flush_interval: Duration, concentrator: Arc<Mutex<Con>>, meta: StatsMetadata, endpoint: Endpoint, capabilities: Cap, ) -> Self

Return a new StatsExporter

  • flush_interval the interval on which the concentrator is flushed
  • concentrator an impl of FlushableConcentrator storing the stats to be sent to the agent
  • meta metadata used in ClientStatsPayload and as headers to send stats to the agent
  • endpoint the Endpoint used to send stats to the agent
Source

pub async fn send(&self, force_flush: bool) -> Result<bool>

Flush the stats stored in the concentrator and send them

If the stats flushed from the concentrator contain at least one time bucket the stats are sent to self.endpoint. The stats are serialized as msgpack.

§Errors

The function will return an error in the following case:

  • The endpoint failed to build
  • The stats payload cannot be serialized as a valid http body
  • The http client failed while sending the request
  • The http status of the response is not 2xx
§Panic

Will panic if another thread panicked while holding the concentrator lock in which case stats cannot be flushed since the concentrator might be corrupted. Returns Ok(true) if stats were sent, Ok(false) if the concentrator had nothing to send.

Trait Implementations§

Source§

impl<Cap: Debug + HttpClientCapability + SleepCapability, Con: Debug + FlushableConcentrator> Debug for StatsExporter<Cap, Con>

Source§

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

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

impl<Cap: HttpClientCapability + SleepCapability + MaybeSend + Sync + 'static, Con: FlushableConcentrator + Send + Debug> Worker for StatsExporter<Cap, Con>

Source§

fn run<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Flush and send stats on every trigger.

Source§

fn trigger<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Function called between each run to wait for the next run. This function should be cancellation safe as it can be cancelled at any yield point.
Source§

fn shutdown<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Hook called when the app is shutting down. Can be used to flush remaining data.
Source§

fn initial_trigger<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: Send + 'async_trait,

Alternative trigger called on start to provide custom behavior. Defaults to trigger behavior.
Source§

fn reset(&mut self)

Reset the worker state. Called in the child after a fork to cleanup parent state.

Auto Trait Implementations§

§

impl<Cap, Con = SpanConcentrator> !Freeze for StatsExporter<Cap, Con>

§

impl<Cap, Con> RefUnwindSafe for StatsExporter<Cap, Con>
where Cap: RefUnwindSafe,

§

impl<Cap, Con> Send for StatsExporter<Cap, Con>
where Cap: Send, Con: Send,

§

impl<Cap, Con> Sync for StatsExporter<Cap, Con>
where Cap: Sync, Con: Send,

§

impl<Cap, Con> Unpin for StatsExporter<Cap, Con>
where Cap: Unpin,

§

impl<Cap, Con> UnsafeUnpin for StatsExporter<Cap, Con>
where Cap: UnsafeUnpin,

§

impl<Cap, Con> UnwindSafe for StatsExporter<Cap, Con>
where Cap: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> MaybeSend for T
where T: Send,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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