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    InsertHeaderNumbers,
45    InsertBlockBodyIndices,
46    InsertTransactionBlocks,
47    GetNextTxNum,
48    InsertTransactionSenders,
49    InsertTransactionHashNumbers,
50}
51
52/// Database provider metrics
53#[derive(Metrics)]
54#[metrics(scope = "storage.providers.database")]
55struct DatabaseProviderMetrics {
56    /// Duration of insert block
57    insert_block: Histogram,
58    /// Duration of insert state
59    insert_state: Histogram,
60    /// Duration of insert hashes
61    insert_hashes: Histogram,
62    /// Duration of insert history indices
63    insert_history_indices: Histogram,
64    /// Duration of update pipeline stages
65    update_pipeline_stages: Histogram,
66    /// Duration of insert canonical headers
67    /// Duration of insert header numbers
68    insert_header_numbers: Histogram,
69    /// Duration of insert block body indices
70    insert_block_body_indices: Histogram,
71    /// Duration of insert transaction blocks
72    insert_tx_blocks: Histogram,
73    /// Duration of get next tx num
74    get_next_tx_num: Histogram,
75    /// Duration of insert transaction senders
76    insert_transaction_senders: Histogram,
77    /// Duration of insert transaction hash numbers
78    insert_transaction_hash_numbers: Histogram,
79}
80
81impl DatabaseProviderMetrics {
82    /// Records the duration for the given action.
83    pub(crate) fn record_duration(&self, action: Action, duration: Duration) {
84        match action {
85            Action::InsertBlock => self.insert_block.record(duration),
86            Action::InsertState => self.insert_state.record(duration),
87            Action::InsertHashes => self.insert_hashes.record(duration),
88            Action::InsertHistoryIndices => self.insert_history_indices.record(duration),
89            Action::UpdatePipelineStages => self.update_pipeline_stages.record(duration),
90            Action::InsertHeaderNumbers => self.insert_header_numbers.record(duration),
91            Action::InsertBlockBodyIndices => self.insert_block_body_indices.record(duration),
92            Action::InsertTransactionBlocks => self.insert_tx_blocks.record(duration),
93            Action::GetNextTxNum => self.get_next_tx_num.record(duration),
94            Action::InsertTransactionSenders => self.insert_transaction_senders.record(duration),
95            Action::InsertTransactionHashNumbers => {
96                self.insert_transaction_hash_numbers.record(duration)
97            }
98        }
99    }
100}