Skip to main content

PrometheusObserver

Struct PrometheusObserver 

Source
pub struct PrometheusObserver { /* private fields */ }
Available on crate feature metrics only.
Expand description

Prometheus-backed Observer. Construct it, register it on the engine builder, and expose its registry on your /metrics endpoint.

use arcly_stream::observability::PrometheusObserver;
use arcly_stream::prelude::*;

let metrics = PrometheusObserver::new().expect("register metrics");
let registry = metrics.registry().clone();
let engine = Engine::builder()
    .application(AppSpec::new("live"))
    .observer(metrics)
    .build();
assert!(!registry.gather().is_empty());

Implementations§

Source§

impl PrometheusObserver

Source

pub fn new() -> Result<Self>

Create an observer with a fresh registry.

Source

pub fn with_registry(registry: Registry) -> Result<Self>

Create an observer registering into an existing registry (e.g. the process-wide default).

Source

pub fn registry(&self) -> &Registry

The registry to gather and expose on /metrics.

Trait Implementations§

Source§

impl Observer for PrometheusObserver

Source§

fn on_publish_started(&self, app: &str)

A publish session started in application app.
Source§

fn on_publish_ended(&self, app: &str)

A publish session ended in application app.
Source§

fn on_frame(&self, key: &StreamKey, _frame: &MediaFrame)

A frame was published. Hot-path hook — keep it cheap. The default is a no-op so the branch is trivially predicted away when no observer is installed.
Source§

fn on_subscriber_lagged(&self, key: &StreamKey, skipped: u64)

A subscriber fell behind the broadcast buffer and skipped frames were dropped from its view before it could read them. This is the canonical slow-consumer signal: alert on it. Fired by StreamHandle::subscribe_resilient.
Source§

fn on_event(&self, _event: &StreamEvent)

A stream lifecycle event was emitted.
Source§

fn on_subscriber_evicted(&self, _key: &StreamKey)

A chronically slow subscriber crossed its max_lag budget and was shed. Fired by Subscription::recv.
Source§

fn on_rate_limited(&self, _key: &StreamKey)

An ingress rate limit was exceeded for key; the protocol handler should drop or backpressure the connection. Handlers call this from their ingest loop (e.g. when IngestRateLimit returns false).
Source§

fn on_stream_reaped(&self, _key: &StreamKey)

A publish session was reaped for exceeding the engine’s idle timeout.

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