Struct MetricsCollector 

pub struct MetricsCollector { /* private fields */ }

Metrics collector for the simulator.

Provides comprehensive metrics collection including:

• Request/response counters and timings
• Device and connection tracking
• System resource monitoring (CPU, memory)
• Protocol-specific metrics

Implementations

impl MetricsCollector

pub fn new() -> MetricsCollector

Create a new metrics collector with a fresh registry.

pub fn global() -> &'static MetricsCollector

Get the global metrics collector instance.

This returns a shared instance that uses the global registry. Use this when you want all metrics to be collected in one place.

pub fn with_registry(registry: Registry) -> MetricsCollector

Create a metrics collector with a custom registry.

pub fn registry(&self) -> &Registry

Get the Prometheus registry.

pub fn record_request(&self, protocol: &str, operation: &str)

Record a request by protocol and operation.

This is the primary method for tracking request counts and should be used in conjunction with record_request_duration or time_request.

pub fn record_request_duration( &self, protocol: &str, operation: &str, duration: Duration, )

Record a request duration.

pub fn time_request(&self, protocol: &str, operation: &str) -> RequestTimer

Create a request timer for automatic duration recording.

The timer automatically records the duration when dropped.

Example

let _timer = metrics.time_request("modbus", "read");
// ... do work ...
// duration is automatically recorded when _timer goes out of scope

pub fn record_message(&self, protocol: &str, direction: &str)

Record a message (for protocol-level message tracking).

pub fn record_read(&self, protocol: &str, success: bool, duration: Duration)

Record a read operation with timing and status.

pub fn record_write(&self, protocol: &str, success: bool, duration: Duration)

Record a write operation with timing and status.

pub fn record_error(&self, protocol: &str, error_type: &str)

Record an error by protocol and error type.

pub fn record_tick(&self, duration: Duration)

Record an engine tick with duration.

pub fn record_latency(&self, protocol: &str, latency: Duration)

Record message latency.

pub fn record_event(&self, event_type: &str)

Record an event by type.

pub fn set_devices_active(&self, count: i64)

Set the number of active devices.

pub fn set_connections_active(&self, protocol: &str, count: i64)

Set active connections for a protocol.

pub fn inc_connections(&self, protocol: &str)

Increment active connections for a protocol.

pub fn dec_connections(&self, protocol: &str)

Decrement active connections for a protocol.

pub fn set_points_total(&self, count: i64)

Set total data points.

pub fn set_device_points(&self, protocol: &str, device_id: &str, count: i64)

Set data points for a specific device.

pub fn remove_device_points(&self, protocol: &str, device_id: &str)

Remove device points metrics (when device is removed).

pub fn set_memory_bytes(&self, bytes: i64)

Set memory usage in bytes.

pub fn set_cpu_percent(&self, percent: f64)

Set CPU usage percentage (0-100).

pub fn update_system_metrics(&self, memory_bytes: i64, cpu_percent: f64)

Update system metrics (memory and CPU).

This is a convenience method that updates both memory and CPU metrics.

pub fn uptime(&self) -> Duration

Get uptime since the metrics collector was created.

pub fn tick_rate(&self) -> f64

Get the current tick rate (ticks per second).

pub fn snapshot(&self) -> MetricsSnapshot

Get a snapshot of current metrics.

pub fn detailed_snapshot(&self) -> DetailedMetricsSnapshot

Get a detailed snapshot with additional information.

pub fn export_prometheus(&self) -> String

Export metrics in Prometheus text format.

pub fn export_global_prometheus() -> String

Export metrics from the global registry.

Trait Implementations

impl Clone for MetricsCollector

fn clone(&self) -> MetricsCollector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MetricsCollector

fn default() -> MetricsCollector

Returns the “default value” for a type.