Skip to main content

MetricGroups

Struct MetricGroups 

Source
pub struct MetricGroups {
Show 14 fields pub default: MetricLevel, pub consensus: MetricLevel, pub execution: MetricLevel, pub checkpoints: MetricLevel, pub transactions: MetricLevel, pub authority: MetricLevel, pub traffic_control: MetricLevel, pub network: MetricLevel, pub p2p: MetricLevel, pub storage: MetricLevel, pub rpc: MetricLevel, pub epoch: MetricLevel, pub runtime: MetricLevel, pub hardware: MetricLevel,
}
Expand description

Per-group verbosity levels for the node’s predefined Prometheus metric groups.

Fields§

§default: MetricLevel

Exposure threshold for metrics whose module belongs to no group.

§consensus: MetricLevel

Consensus and block production.

Modules: starfish_core, iota_core::consensus_adapter, iota_core::consensus_manager, iota_core::consensus_validator, iota_core::epoch::consensus_store_pruner.

§execution: MetricLevel

Transaction execution and caching, including the Move bytecode verifier and execution-limit meters.

Modules: iota_core::execution_cache, iota_core::global_state_hasher, iota_core::module_cache_metrics, iota_types::metrics.

§checkpoints: MetricLevel

Checkpoint building, certification, and execution.

Modules: iota_core::checkpoints.

§transactions: MetricLevel

Transaction submission and finality.

Modules: iota_core::quorum_driver, iota_core::transaction_driver, iota_core::transaction_orchestrator, iota_core::validator_tx_finalizer.

§authority: MetricLevel

Authority request handling and validation.

Modules: iota_core::authority (incl. the authority store and pruner), iota_core::safe_client, iota_core::signature_verifier, iota_core::validator_client_monitor. Also the authority_grpc_* transport metrics of the validator gRPC server, matched by name prefix because their module (iota_node::metrics) is shared with the epoch group’s protocol-version gauges.

The iota_core::authority directive is a module-path prefix, so it also covers the sibling modules iota_core::authority_aggregator, iota_core::authority_client, and iota_core::authority_server.

§traffic_control: MetricLevel

Spam/abuse traffic control, including the transaction-deny config gauges.

Modules: iota_core::traffic_controller, iota_config::node_config_metrics.

§network: MetricLevel

Peer-to-peer networking and state sync.

Modules: iota_network::discovery, iota_network::randomness, iota_network::state_sync.

§p2p: MetricLevel

The anemo P2P transport underneath the network group’s subsystems. Kept separate from network because most of these are per-peer (connection/RTT/packet-loss gauges) and therefore high-cardinality, so they can be silenced independently.

Modules: iota_metrics::metrics_network.

§storage: MetricLevel

Persistent storage, including archive writes/reads and state snapshot uploads. The authority object store is part of the authority group, not this one.

Modules: typed_store, iota_storage, iota_core::db_checkpoint_handler, iota_snapshot.

§rpc: MetricLevel

API servers and RPC-facing indexes.

Modules: iota_json_rpc, iota_grpc_server, iota_graphql_rpc, iota_core::jsonrpc_index, iota_core::subscription_handler.

§epoch: MetricLevel

Epoch reconfiguration and protocol versioning.

Modules: iota_core::epoch::epoch_metrics. Also the iota_current/binary/configured_max_protocol_version gauges, matched by name because their module (iota_node::metrics) is shared with the authority group’s gRPC transport metrics.

§runtime: MetricLevel

Async-runtime and process health: monitored tokio tasks, channels, and scopes, thread stalls, invariant violations, and tracing span latencies.

Modules: iota_metrics (except the hardware and p2p group submodules), telemetry_subscribers.

§hardware: MetricLevel

Host hardware metrics (CPU / memory / disk). Registered as a collector, so individual metrics cannot be level-filtered: off skips the whole group and every other level registers it, at startup only.

Rendered as an iota_metrics::hardware_metrics directive, the module where the collector is registered.

Implementations§

Source§

impl MetricGroups

Source

pub fn modules_for_group(group: &str) -> Option<&'static [&'static str]>

Returns the filter patterns a group covers — keyed by the group’s config key. None for unknown groups.

Source

pub fn to_filter_string(&self) -> String

Renders the levels into a METRICS_FILTER-style directive string: the default threshold as the leading catch-all directive, then one directive per group module (including the hardware group’s). Later directives win, so the group levels override the catch-all for their modules.

Trait Implementations§

Source§

impl Clone for MetricGroups

Source§

fn clone(&self) -> MetricGroups

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MetricGroups

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for MetricGroups

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for MetricGroups

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MetricGroups

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a Request
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,