ringline 0.0.2

io_uring-native async I/O runtime for Linux
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! ringline runtime metrics.
//!
//! Per-worker counters for connections, bytes, ring utilization, and pool
//! exhaustion. Automatically exposed via Prometheus when registered with
//! the admin server.

use crate::counter::{Counter, CounterGroup};
use metriken::{Gauge, metric};

// Counter groups (sharded storage — one shard per worker, no false sharing).
static CONN: CounterGroup = CounterGroup::new();
static BYTES: CounterGroup = CounterGroup::new();
static RING: CounterGroup = CounterGroup::new();
static POOL: CounterGroup = CounterGroup::new();
static UDP: CounterGroup = CounterGroup::new();

/// Counter slot indices for connection metrics.
pub mod conn {
    pub const ACCEPTED: usize = 0;
    pub const CLOSED: usize = 1;
}

/// Counter slot indices for byte metrics.
pub mod bytes {
    pub const RECEIVED: usize = 0;
    pub const SENT: usize = 1;
}

/// Counter slot indices for ring utilization metrics.
pub mod ring {
    pub const CQE_PROCESSED: usize = 0;
    pub const SQE_SUBMIT_FAILURES: usize = 1;
}

/// Counter slot indices for pool exhaustion metrics.
pub mod pool {
    pub const SEND_EXHAUSTED: usize = 0;
    pub const TIMER_EXHAUSTED: usize = 1;
    pub const BUFFER_RING_EMPTY: usize = 2;
}

/// Counter slot indices for UDP metrics.
pub mod udp {
    pub const DATAGRAMS_RECEIVED: usize = 0;
    pub const DATAGRAMS_SENT: usize = 1;
}

// ── Connection lifecycle ─────────────────────────────────────────

#[metric(
    name = "ringline/connections/accepted",
    description = "Total connections accepted"
)]
pub static CONNECTIONS_ACCEPTED: Counter = Counter::new(&CONN, conn::ACCEPTED);

#[metric(
    name = "ringline/connections/closed",
    description = "Total connections closed"
)]
pub static CONNECTIONS_CLOSED: Counter = Counter::new(&CONN, conn::CLOSED);

#[metric(
    name = "ringline/connections/active",
    description = "Currently active connections"
)]
pub static CONNECTIONS_ACTIVE: Gauge = Gauge::new();

// ── Bytes ────────────────────────────────────────────────────────

#[metric(name = "ringline/bytes/received", description = "Total bytes received")]
pub static BYTES_RECEIVED: Counter = Counter::new(&BYTES, bytes::RECEIVED);

#[metric(name = "ringline/bytes/sent", description = "Total bytes sent")]
pub static BYTES_SENT: Counter = Counter::new(&BYTES, bytes::SENT);

// ── Ring utilization ─────────────────────────────────────────────

#[metric(name = "ringline/cqe/processed", description = "Total CQEs processed")]
pub static CQE_PROCESSED: Counter = Counter::new(&RING, ring::CQE_PROCESSED);

#[metric(
    name = "ringline/sqe/submit_failures",
    description = "SQE submission failures"
)]
pub static SQE_SUBMIT_FAILURES: Counter = Counter::new(&RING, ring::SQE_SUBMIT_FAILURES);

// ── Pool exhaustion ──────────────────────────────────────────────

#[metric(
    name = "ringline/pool/send_exhausted",
    description = "Send copy pool exhaustion events"
)]
pub static SEND_POOL_EXHAUSTED: Counter = Counter::new(&POOL, pool::SEND_EXHAUSTED);

#[metric(
    name = "ringline/pool/timer_exhausted",
    description = "Timer pool exhaustion events"
)]
pub static TIMER_POOL_EXHAUSTED: Counter = Counter::new(&POOL, pool::TIMER_EXHAUSTED);

#[metric(
    name = "ringline/pool/buffer_ring_empty",
    description = "Recv buffer ring empty events"
)]
pub static BUFFER_RING_EMPTY: Counter = Counter::new(&POOL, pool::BUFFER_RING_EMPTY);

// ── UDP ──────────────────────────────────────────────────────────

#[metric(
    name = "ringline/udp/datagrams_received",
    description = "Total UDP datagrams received"
)]
pub static UDP_DATAGRAMS_RECEIVED: Counter = Counter::new(&UDP, udp::DATAGRAMS_RECEIVED);

#[metric(
    name = "ringline/udp/datagrams_sent",
    description = "Total UDP datagrams sent"
)]
pub static UDP_DATAGRAMS_SENT: Counter = Counter::new(&UDP, udp::DATAGRAMS_SENT);