tracing-calltree 0.1.2

Always-on hierarchical profiling for Rust tracing spans with rolling latency statistics.
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

use crate::layer::CallTreeLayer;
use crate::snapshot::CallTreeSnapshot;
use crate::tree::CallTreeState;
use std::fmt;
use std::sync::Arc;
use tracing::Metadata;

pub(crate) const DEFAULT_WINDOW_SIZE: usize = 100;
pub(crate) const DEFAULT_MAX_NODES: usize = 10_000;
pub(crate) const DEFAULT_MAX_DEPTH: usize = 64;

type MetadataFilter = dyn for<'a> Fn(&Metadata<'a>) -> bool + Send + Sync + 'static;

pub(crate) struct Config {
    pub(crate) window_size: usize,
    pub(crate) max_nodes: usize,
    pub(crate) max_depth: usize,
    pub(crate) filter: Arc<MetadataFilter>,
}

pub(crate) struct CallTreeInner {
    pub(crate) config: Config,
    pub(crate) state: CallTreeState,
}

#[derive(Clone)]
pub struct CallTree {
    pub(crate) inner: Arc<CallTreeInner>,
}

impl CallTree {
    pub fn new() -> Self {
        Self::builder().build()
    }

    pub fn builder() -> CallTreeBuilder {
        CallTreeBuilder::default()
    }

    pub fn layer(&self) -> CallTreeLayer {
        CallTreeLayer::new(self.inner.clone())
    }

    pub fn snapshot(&self) -> CallTreeSnapshot {
        self.inner.state.snapshot()
    }

    pub fn internal_stats(&self) -> InternalStats {
        InternalStats {
            nodes: self.inner.state.node_count(),
            rejected_nodes: self.inner.state.rejected_nodes(),
            dropped_samples: self.inner.state.dropped_samples(),
        }
    }
}

impl Default for CallTree {
    fn default() -> Self {
        Self::new()
    }
}

pub struct CallTreeBuilder {
    window_size: usize,
    max_nodes: usize,
    max_depth: usize,
    filter: Arc<MetadataFilter>,
}

impl Default for CallTreeBuilder {
    fn default() -> Self {
        Self {
            window_size: DEFAULT_WINDOW_SIZE,
            max_nodes: DEFAULT_MAX_NODES,
            max_depth: DEFAULT_MAX_DEPTH,
            filter: Arc::new(|_| true),
        }
    }
}

impl fmt::Debug for CallTreeBuilder {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("CallTreeBuilder")
            .field("window_size", &self.window_size)
            .field("max_nodes", &self.max_nodes)
            .field("max_depth", &self.max_depth)
            .finish_non_exhaustive()
    }
}

impl CallTreeBuilder {
    pub fn window_size(mut self, window_size: usize) -> Self {
        self.window_size = window_size;
        self
    }

    pub fn max_nodes(mut self, max_nodes: usize) -> Self {
        self.max_nodes = max_nodes;
        self
    }

    pub fn max_depth(mut self, max_depth: usize) -> Self {
        self.max_depth = max_depth;
        self
    }

    pub fn filter<F>(mut self, filter: F) -> Self
    where
        F: for<'a> Fn(&Metadata<'a>) -> bool + Send + Sync + 'static,
    {
        self.filter = Arc::new(filter);
        self
    }

    pub fn build(self) -> CallTree {
        CallTree {
            inner: Arc::new(CallTreeInner {
                config: Config {
                    window_size: self.window_size,
                    max_nodes: self.max_nodes,
                    max_depth: self.max_depth,
                    filter: self.filter,
                },
                state: CallTreeState::default(),
            }),
        }
    }
}

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize))]
#[non_exhaustive]
pub struct InternalStats {
    pub nodes: usize,
    pub rejected_nodes: u64,
    pub dropped_samples: u64,
}