reth_provider/providers/database/
metrics.rs

1use metrics::Histogram;
2use reth_metrics::Metrics;
3use std::time::{Duration, Instant};
4
5#[derive(Debug)]
6pub(crate) struct DurationsRecorder {
7    start: Instant,
8    current_metrics: DatabaseProviderMetrics,
9    pub(crate) actions: Vec<(Action, Duration)>,
10    latest: Option<Duration>,
11}
12
13impl Default for DurationsRecorder {
14    fn default() -> Self {
15        Self {
16            start: Instant::now(),
17            actions: Vec::new(),
18            latest: None,
19            current_metrics: DatabaseProviderMetrics::default(),
20        }
21    }
22}
23
24impl DurationsRecorder {
25    /// Records the duration since last record, saves it for future logging and instantly reports as
26    /// a metric with `action` label.
27    pub(crate) fn record_relative(&mut self, action: Action) {
28        let elapsed = self.start.elapsed();
29        let duration = elapsed - self.latest.unwrap_or_default();
30
31        self.actions.push((action, duration));
32        self.current_metrics.record_duration(action, duration);
33        self.latest = Some(elapsed);
34    }
35}
36
37#[derive(Debug, Copy, Clone)]
38pub(crate) enum Action {
39    InsertBlock,
40    InsertState,
41    InsertHashes,
42    InsertHistoryIndices,
43    UpdatePipelineStages,
44    InsertCanonicalHeaders,
45    InsertHeaders,
46    InsertHeaderNumbers,
47    InsertHeaderTerminalDifficulties,
48    InsertBlockBodyIndices,
49    InsertTransactionBlocks,
50    GetNextTxNum,
51    GetParentTD,
52}
53
54/// Database provider metrics
55#[derive(Metrics)]
56#[metrics(scope = "storage.providers.database")]
57struct DatabaseProviderMetrics {
58    /// Duration of insert block
59    insert_block: Histogram,
60    /// Duration of insert state
61    insert_state: Histogram,
62    /// Duration of insert hashes
63    insert_hashes: Histogram,
64    /// Duration of insert history indices
65    insert_history_indices: Histogram,
66    /// Duration of update pipeline stages
67    update_pipeline_stages: Histogram,
68    /// Duration of insert canonical headers
69    insert_canonical_headers: Histogram,
70    /// Duration of insert headers
71    insert_headers: Histogram,
72    /// Duration of insert header numbers
73    insert_header_numbers: Histogram,
74    /// Duration of insert header TD
75    insert_header_td: Histogram,
76    /// Duration of insert block body indices
77    insert_block_body_indices: Histogram,
78    /// Duration of insert transaction blocks
79    insert_tx_blocks: Histogram,
80    /// Duration of get next tx num
81    get_next_tx_num: Histogram,
82    /// Duration of get parent TD
83    get_parent_td: Histogram,
84}
85
86impl DatabaseProviderMetrics {
87    /// Records the duration for the given action.
88    pub(crate) fn record_duration(&self, action: Action, duration: Duration) {
89        match action {
90            Action::InsertBlock => self.insert_block.record(duration),
91            Action::InsertState => self.insert_state.record(duration),
92            Action::InsertHashes => self.insert_hashes.record(duration),
93            Action::InsertHistoryIndices => self.insert_history_indices.record(duration),
94            Action::UpdatePipelineStages => self.update_pipeline_stages.record(duration),
95            Action::InsertCanonicalHeaders => self.insert_canonical_headers.record(duration),
96            Action::InsertHeaders => self.insert_headers.record(duration),
97            Action::InsertHeaderNumbers => self.insert_header_numbers.record(duration),
98            Action::InsertHeaderTerminalDifficulties => self.insert_header_td.record(duration),
99            Action::InsertBlockBodyIndices => self.insert_block_body_indices.record(duration),
100            Action::InsertTransactionBlocks => self.insert_tx_blocks.record(duration),
101            Action::GetNextTxNum => self.get_next_tx_num.record(duration),
102            Action::GetParentTD => self.get_parent_td.record(duration),
103        }
104    }
105}