Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Doc comments for metrics in provisioner #5967

Merged
merged 3 commits into from
Sep 5, 2022
Merged

Doc comments for metrics in provisioner #5967

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bfa7229
Doc comments for metrics in provisioner
tdimitrov Sep 5, 2022
086a139
Rename metrics
tdimitrov Sep 5, 2022
bc6713d
Spelling
tdimitrov Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions node/core/provisioner/src/metrics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ use polkadot_node_subsystem_util::metrics::{self, prometheus};

#[derive(Clone)]
struct MetricsInner {
/// Tracks successful/unsuccessful inherent data requests
inherent_data_requests: prometheus::CounterVec<prometheus::U64>,
request_inherent_data: prometheus::Histogram,
provisionable_data: prometheus::Histogram,
/// How much time the `RequestInherentData` processing takes
request_inherent_data_duration: prometheus::Histogram,
/// How much time `ProvisionableData` processing takes
provisionable_data_duration: prometheus::Histogram,
/// Bitfields array length in `ProvisionerInherentData` (the result for `RequestInherentData`)
inherent_data_response_bitfields: prometheus::Histogram,

/// The following metrics track how many disputes/votes the runtime will have to process. These will count
Expand Down Expand Up @@ -54,14 +58,16 @@ impl Metrics {
pub(crate) fn time_request_inherent_data(
&self,
) -> Option<metrics::prometheus::prometheus::HistogramTimer> {
self.0.as_ref().map(|metrics| metrics.request_inherent_data.start_timer())
self.0
.as_ref()
.map(|metrics| metrics.request_inherent_data_duration.start_timer())
}

/// Provide a timer for `provisionable_data` which observes on drop.
pub(crate) fn time_provisionable_data(
&self,
) -> Option<metrics::prometheus::prometheus::HistogramTimer> {
self.0.as_ref().map(|metrics| metrics.provisionable_data.start_timer())
self.0.as_ref().map(|metrics| metrics.provisionable_data_duration.start_timer())
}

pub(crate) fn observe_inherent_data_bitfields_count(&self, bitfields_count: usize) {
Expand Down Expand Up @@ -110,14 +116,14 @@ impl metrics::Metrics for Metrics {
)?,
registry,
)?,
request_inherent_data: prometheus::register(
request_inherent_data_duration: prometheus::register(
prometheus::Histogram::with_opts(prometheus::HistogramOpts::new(
"polkadot_parachain_provisioner_request_inherent_data_time",
"Time spent within `provisioner::request_inherent_data`",
))?,
registry,
)?,
provisionable_data: prometheus::register(
provisionable_data_duration: prometheus::register(
prometheus::Histogram::with_opts(prometheus::HistogramOpts::new(
"polkadot_parachain_provisioner_provisionable_data_time",
"Time spent within `provisioner::provisionable_data`",
Expand Down