fraiseql-wire 2.2.1

Streaming JSON query engine for Postgres 17
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

//! Gauge metrics for fraiseql-wire
//!
//! Gauges track instantaneous values that can increase or decrease:
//! - Current chunk size in bytes
//! - Stream buffered items count
//! - Real-time monitoring of stream health

use crate::metrics::labels;
use metrics::gauge;

/// Record current chunk size
///
/// Called after chunk size adjustments to reflect the current size
/// used for buffering rows from Postgres.
pub fn current_chunk_size(entity: &str, bytes: usize) {
    gauge!(
        "fraiseql_chunk_size_bytes",
        labels::ENTITY => entity.to_string(),
    )
    .set(bytes as f64);
}

/// Record stream buffered items count
///
/// Tracks how many rows are currently buffered in the async channel.
/// High values indicate consumer is slow relative to producer.
pub fn stream_buffered_items(entity: &str, count: usize) {
    gauge!(
        "fraiseql_stream_buffered_items",
        labels::ENTITY => entity.to_string(),
    )
    .set(count as f64);
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_current_chunk_size() {
        current_chunk_size("test_entity", 256);
        current_chunk_size("test_entity", 512);
        current_chunk_size("test_entity", 128);
    }

    #[test]
    fn test_stream_buffered_items() {
        stream_buffered_items("test_entity", 0);
        stream_buffered_items("test_entity", 50);
        stream_buffered_items("test_entity", 256);
    }
}