ramqp 0.6.6

Async AMQP 1.0 client for Rust on tokio — connects to RabbitMQ 4.x, ActiveMQ Artemis, and other AMQP 1.0 brokers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! The pluggable [`Metrics`] trait (WP-0.4).
//!
//! All methods have no-op defaults, so a custom collector overrides only the
//! signals it cares about. The runtime holds a [`SharedMetrics`] and calls these
//! at the emission points wired up in [`crate::observe::wiring`].

use std::sync::Arc;
use std::time::Duration;

/// A sink for runtime metrics. Cheap, infallible, called on the hot path — keep
/// implementations lock-light (atomics / sharded counters).
///
/// # Example
/// ```
/// use std::sync::atomic::{AtomicU64, Ordering};
/// use ramqp::observe::Metrics;
///
/// #[derive(Default)]
/// struct Counters {
///     frames_out: AtomicU64,
/// }
///
/// impl Metrics for Counters {
///     fn on_frame_sent(&self, _bytes: usize) {
///         self.frames_out.fetch_add(1, Ordering::Relaxed);
///     }
/// }
///
/// let c = Counters::default();
/// c.on_frame_sent(128);
/// assert_eq!(c.frames_out.load(Ordering::Relaxed), 1);
/// ```
pub trait Metrics: Send + Sync + 'static {
    /// A frame of `bytes` bytes was written to the transport.
    fn on_frame_sent(&self, bytes: usize) {
        let _ = bytes;
    }
    /// A frame of `bytes` bytes was read from the transport.
    fn on_frame_received(&self, bytes: usize) {
        let _ = bytes;
    }
    /// An outbound transfer (message) was sent.
    fn on_transfer_sent(&self) {}
    /// An inbound transfer (message) was received.
    fn on_transfer_received(&self) {}
    /// A delivery reached a settled state.
    fn on_settlement(&self) {}
    /// The credit gauge for a link changed to `credit`.
    fn on_credit(&self, handle: u32, credit: u32) {
        let _ = (handle, credit);
    }
    /// The in-flight (unsettled) delivery count changed by `delta`.
    fn on_inflight(&self, delta: i64) {
        let _ = delta;
    }
    /// A reconnect attempt began (1-based `attempt`).
    fn on_reconnect(&self, attempt: u32) {
        let _ = attempt;
    }
    /// A send-to-settle latency sample.
    fn on_send_to_settle(&self, latency: Duration) {
        let _ = latency;
    }
}

/// The default no-op metrics sink.
#[derive(Debug, Default, Clone, Copy)]
pub struct NoopMetrics;

impl Metrics for NoopMetrics {}

/// A shared, type-erased metrics handle held throughout the runtime.
pub type SharedMetrics = Arc<dyn Metrics>;

/// A [`SharedMetrics`] that discards everything.
pub fn noop_metrics() -> SharedMetrics {
    Arc::new(NoopMetrics)
}