MetricsObserver

Struct MetricsObserver 

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

Metrics observer that collects and reports pipeline processing metrics to Prometheus.

MetricsObserver implements the ProcessingObserver trait to receive processing events from the pipeline and update Prometheus metrics accordingly. It provides real-time metrics collection with minimal performance overhead.

§Features

§Real-Time Metrics Collection

  • Event-Driven: Responds to processing events in real-time
  • Atomic Updates: Thread-safe metric updates using atomic operations
  • Low Latency: Minimal delay between events and metric updates
  • Continuous Monitoring: Provides continuous visibility into processing

§Performance Tracking

  • Throughput Calculation: Real-time throughput calculation in MB/s
  • Duration Tracking: Tracks processing duration for chunks and overall processing
  • Progress Monitoring: Monitors processing progress and completion rates
  • Efficiency Metrics: Calculates processing efficiency and performance indicators

§Prometheus Integration

  • Metric Updates: Updates Prometheus metrics through MetricsService
  • Counter Increments: Increments counters for processed chunks and bytes
  • Histogram Recording: Records duration histograms for performance analysis
  • Gauge Updates: Updates gauge metrics for real-time values

§Usage Examples

§Basic Observer Creation

§Integration with Pipeline Processing

§Metric Tracking

The observer tracks several key metrics:

§Byte Tracking

  • Total Bytes: Total bytes to be processed (set at start)
  • Processed Bytes: Cumulative bytes processed (updated continuously)
  • Current Chunk Size: Size of currently processing chunk

§Performance Tracking

  • Start Time: Processing start timestamp for throughput calculation
  • Throughput: Real-time throughput calculation in MB/s
  • Duration: Processing duration for performance analysis

§Thread Safety

The observer is designed for concurrent use:

  • Atomic Counters: All counters use atomic operations
  • Immutable Service: Metrics service is shared through Arc
  • No Locks: Lock-free design for minimal contention
  • Safe Updates: Thread-safe metric updates

§Performance Characteristics

  • Low Overhead: Minimal impact on processing performance (~1-2% overhead)
  • Efficient Updates: Optimized atomic operations
  • Memory Efficient: Small memory footprint (~100 bytes)
  • Scalable: Performance scales with number of processing threads

Implementations§

Source§

impl MetricsObserver

Source

pub fn new(metrics_service: Arc<MetricsService>) -> Self

Creates a new metrics observer with the provided metrics // service.

Initializes the observer with the given metrics service and sets up internal tracking state for processing metrics. The observer is ready to receive processing events immediately after creation.

§Arguments
  • metrics_service - Arc-wrapped metrics service for reporting metrics
§Returns

A new MetricsObserver instance ready to collect processing metrics.

§Examples
§Initialization

The observer initializes with:

  • Current timestamp as start time
  • All byte counters set to zero
  • Ready to receive processing events

Trait Implementations§

Source§

impl ProcessingObserver for MetricsObserver

Source§

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

Called when processing starts
Source§

fn on_chunk_started<'life0, 'async_trait>( &'life0 self, chunk_id: u64, size: usize, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Called when a chunk starts processing
Source§

fn on_chunk_completed<'life0, 'async_trait>( &'life0 self, chunk_id: u64, duration: Duration, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Called when a chunk completes processing
Source§

fn on_progress_update<'life0, 'async_trait>( &'life0 self, bytes_processed: u64, _total_bytes: u64, throughput_mbps: f64, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Called periodically with progress updates
Source§

fn on_processing_completed<'life0, 'life1, 'async_trait>( &'life0 self, total_duration: Duration, final_metrics: Option<&'life1 ProcessingMetrics>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when processing completes

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
Source§

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