Newer
Older
use serde::Serialize;
use tracing::Level;
#[derive(Debug)]
/// Wrapper over [`tracing::Span`] to trace individual method calls, notifications and similar.
pub struct RpcTracing(tracing::Span);
impl RpcTracing {
/// Create a `method_call` tracing target.
///
/// To enable this you need to call `RpcTracing::method_call("some_method").span().enable()`.
pub fn method_call(method: &str) -> Self {
Self(tracing::span!(tracing::Level::DEBUG, "method_call", %method))
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
}
/// Create a `notification` tracing target.
///
/// To enable this you need to call `RpcTracing::notification("some_method").span().enable()`.
pub fn notification(method: &str) -> Self {
Self(tracing::span!(tracing::Level::DEBUG, "notification", %method))
}
/// Create a `batch` tracing target.
///
/// To enable this you need to call `RpcTracing::batch().span().enable()`.
pub fn batch() -> Self {
Self(tracing::span!(tracing::Level::DEBUG, "batch"))
}
/// Get the inner span.
pub fn span(&self) -> &tracing::Span {
&self.0
}
}
/// Helper for writing trace logs from str.
pub fn tx_log_from_str(s: impl AsRef<str>, max: u32) {
if tracing::enabled!(Level::TRACE) {
let msg = truncate_at_char_boundary(s.as_ref(), max as usize);
tracing::trace!(send = msg);
}
}
/// Helper for writing trace logs from JSON.
pub fn tx_log_from_json(s: &impl Serialize, max: u32) {
if tracing::enabled!(Level::TRACE) {
let json = serde_json::to_string(s).unwrap_or_default();
let msg = truncate_at_char_boundary(&json, max as usize);
tracing::trace!(send = msg);
}
}
/// Helper for writing trace logs from str.
pub fn rx_log_from_str(s: impl AsRef<str>, max: u32) {
if tracing::enabled!(Level::TRACE) {
let msg = truncate_at_char_boundary(s.as_ref(), max as usize);
tracing::trace!(recv = msg);
}
}
/// Helper for writing trace logs from JSON.
pub fn rx_log_from_json(s: &impl Serialize, max: u32) {
if tracing::enabled!(Level::TRACE) {
let res = serde_json::to_string(s).unwrap_or_default();
let msg = truncate_at_char_boundary(res.as_str(), max as usize);
tracing::trace!(recv = msg);
}
}
/// Helper for writing trace logs from bytes.
pub fn rx_log_from_bytes(bytes: &[u8], max: u32) {
if tracing::enabled!(Level::TRACE) {
let res = serde_json::from_slice::<serde_json::Value>(bytes).unwrap_or_default();
rx_log_from_json(&res, max);
}
}
/// Find the next char boundary to truncate at.
fn truncate_at_char_boundary(s: &str, max: usize) -> &str {
if s.len() < max {
return s;
}
match s.char_indices().nth(max as usize) {
None => s,
Some((idx, _)) => &s[..idx],
}
}
#[cfg(test)]
mod tests {
use super::truncate_at_char_boundary;
#[test]
fn truncate_at_char_boundary_works() {
assert_eq!(truncate_at_char_boundary("ボルテックス", 0), "");
assert_eq!(truncate_at_char_boundary("ボルテックス", 4), "ボルテッ");
assert_eq!(truncate_at_char_boundary("ボルテックス", 100), "ボルテックス");
assert_eq!(truncate_at_char_boundary("hola-hola", 4), "hola");
}
}