wireframe 0.3.0

Simplify building servers and clients for custom binary protocols.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//! Tracing span and event helpers for wireframe client operations.
//!
//! These helpers centralise span creation with dynamic level selection and
//! per-command timing emission, keeping the instrumentation logic out of the
//! hot-path client methods.

use std::time::Instant;

use tracing::{Level, Span};

use super::tracing_config::TracingConfig;

/// Create a tracing span at a dynamically selected level.
///
/// The level is matched against the five `tracing::Level` variants. Each
/// branch calls the corresponding `tracing::<level>_span!` macro, which
/// ensures the span metadata is statically known per branch while the
/// branch selection is dynamic.
macro_rules! dynamic_span {
    ($level:expr, $name:expr $(, $($field:tt)*)?) => {
        match $level {
            Level::ERROR => tracing::error_span!($name $(, $($field)*)?),
            Level::WARN  => tracing::warn_span!($name $(, $($field)*)?),
            Level::INFO  => tracing::info_span!($name $(, $($field)*)?),
            Level::DEBUG => tracing::debug_span!($name $(, $($field)*)?),
            Level::TRACE => tracing::trace_span!($name $(, $($field)*)?),
        }
    };
}

/// Create a span for the `connect` operation.
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion — five match arms are inherent"
)]
pub(crate) fn connect_span(config: &TracingConfig, peer_addr: &str) -> Span {
    dynamic_span!(
        config.connect_level,
        "client.connect",
        peer.addr = peer_addr
    )
}

/// Create a span for the `send` operation.
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion"
)]
pub(crate) fn send_span(config: &TracingConfig, frame_bytes: usize) -> Span {
    dynamic_span!(config.send_level, "client.send", frame.bytes = frame_bytes)
}

/// Create a span for the `receive` operation.
///
/// The `frame.bytes` and `result` fields are recorded after the frame arrives
/// using [`Span::record`].
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion"
)]
pub(crate) fn receive_span(config: &TracingConfig) -> Span {
    dynamic_span!(
        config.receive_level,
        "client.receive",
        frame.bytes = tracing::field::Empty,
        result = tracing::field::Empty
    )
}

/// Create a span for the `send_envelope` operation.
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion"
)]
pub(crate) fn send_envelope_span(
    config: &TracingConfig,
    correlation_id: u64,
    frame_bytes: usize,
) -> Span {
    dynamic_span!(
        config.send_level,
        "client.send_envelope",
        correlation_id = correlation_id,
        frame.bytes = frame_bytes
    )
}

/// Create a span for the `call` operation.
///
/// The `result` field is recorded when the call completes using
/// [`Span::record`].
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion"
)]
pub(crate) fn call_span(config: &TracingConfig) -> Span {
    dynamic_span!(
        config.call_level,
        "client.call",
        result = tracing::field::Empty
    )
}

/// Create a span for the `call_correlated` operation.
///
/// The `correlation_id` and `result` fields are recorded during the call
/// using [`Span::record`].
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion"
)]
pub(crate) fn call_correlated_span(config: &TracingConfig) -> Span {
    dynamic_span!(
        config.call_level,
        "client.call_correlated",
        correlation_id = tracing::field::Empty,
        result = tracing::field::Empty
    )
}

/// Create a span for the `call_streaming` operation.
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion"
)]
pub(crate) fn streaming_span(config: &TracingConfig, correlation_id: u64) -> Span {
    dynamic_span!(
        config.streaming_level,
        "client.call_streaming",
        correlation_id = correlation_id,
        frame.bytes = tracing::field::Empty
    )
}

/// Create a span for the `close` operation.
#[expect(
    clippy::cognitive_complexity,
    reason = "complexity from dynamic_span! macro expansion"
)]
pub(crate) fn close_span(config: &TracingConfig) -> Span {
    dynamic_span!(config.close_level, "client.close")
}

/// Record elapsed time if timing was enabled for this operation.
///
/// The `start` parameter is `None` when timing is disabled and
/// `Some(instant)` when enabled. When `Some`, an event is emitted with
/// the `elapsed_us` field at `DEBUG` level.
pub(crate) fn emit_timing_event(start: Option<Instant>) {
    if let Some(start) = start {
        let elapsed_us = start.elapsed().as_micros();
        tracing::debug!(elapsed_us = elapsed_us, "operation.timing");
    }
}