mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-08 03:08:06 +00:00
Bernhard Schuster
ac338b6c28
* add jemalloc memory statistics tracking * chore: move Metronome in a separate file * add meta flag spellcheck * adjust metrics names * account for new metrics in test
79 lines
2.6 KiB
Rust
79 lines
2.6 KiB
Rust
// Copyright 2017-2020 Parity Technologies (UK) Ltd.
|
|
// This file is part of Polkadot.
|
|
|
|
// Polkadot is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// Polkadot is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Metrics helpers
|
|
//!
|
|
//! Collects a bunch of metrics providers and related features such as
|
|
//! `Metronome` for usage with metrics collections.
|
|
//!
|
|
//! This crate also reexports Prometheus metric types which are expected to be implemented by subsystems.
|
|
|
|
#![deny(missing_docs)]
|
|
#![deny(unused_imports)]
|
|
|
|
pub use metered_channel as metered;
|
|
|
|
/// Memory allocation stats tracking.
|
|
#[cfg(feature = "memory-stats")]
|
|
pub mod memory_stats;
|
|
|
|
#[cfg(feature = "memory-stats")]
|
|
pub use self::memory_stats::{MemoryAllocationSnapshot, MemoryAllocationTracker};
|
|
|
|
/// Cyclic metric collection support.
|
|
pub mod metronome;
|
|
pub use self::metronome::Metronome;
|
|
|
|
/// This module reexports Prometheus types and defines the [`Metrics`] trait.
|
|
pub mod metrics {
|
|
/// Reexport Substrate Prometheus types.
|
|
pub use substrate_prometheus_endpoint as prometheus;
|
|
|
|
/// Subsystem- or job-specific Prometheus metrics.
|
|
///
|
|
/// Usually implemented as a wrapper for `Option<ActualMetrics>`
|
|
/// to ensure `Default` bounds or as a dummy type ().
|
|
/// Prometheus metrics internally hold an `Arc` reference, so cloning them is fine.
|
|
pub trait Metrics: Default + Clone {
|
|
/// Try to register metrics in the Prometheus registry.
|
|
fn try_register(
|
|
registry: &prometheus::Registry,
|
|
) -> Result<Self, prometheus::PrometheusError>;
|
|
|
|
/// Convenience method to register metrics in the optional Prometheus registry.
|
|
///
|
|
/// If no registry is provided, returns `Default::default()`. Otherwise, returns the same
|
|
/// thing that `try_register` does.
|
|
fn register(
|
|
registry: Option<&prometheus::Registry>,
|
|
) -> Result<Self, prometheus::PrometheusError> {
|
|
match registry {
|
|
None => Ok(Self::default()),
|
|
Some(registry) => Self::try_register(registry),
|
|
}
|
|
}
|
|
}
|
|
|
|
// dummy impl
|
|
impl Metrics for () {
|
|
fn try_register(
|
|
_registry: &prometheus::Registry,
|
|
) -> Result<(), prometheus::PrometheusError> {
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|