Skip to main content

IpfrsMetrics

Struct IpfrsMetrics 

Source
pub struct IpfrsMetrics {
Show 21 fields pub registry: Registry, pub blocks_added: Counter, pub blocks_fetched: Counter, pub blocks_deleted: Counter, pub block_add_bytes: Counter, pub block_fetch_latency: Histogram, pub cache_hit_rate: Gauge, pub dht_provide_calls: Counter, pub dht_find_providers_calls: Counter, pub dht_provider_records: Gauge, pub inference_sessions_started: Counter, pub inference_sessions_completed: Counter, pub inference_session_latency: Histogram, pub proof_tree_depth: Histogram, pub gossipsub_messages_sent: Counter, pub gossipsub_messages_received: Counter, pub gossipsub_mesh_peers: Gauge, pub storage_bytes_total: Gauge, pub storage_blocks_total: Gauge, pub gc_runs: Counter, pub gc_blocks_collected: Counter,
}
Expand description

Global metrics registry for IPFRS.

Each field is a Prometheus primitive registered in a private registry so that multiple instances (e.g., in tests) do not conflict with each other.

use ipfrs_interface::metrics::IpfrsMetrics;

let m = IpfrsMetrics::new().expect("failed to create metrics registry");
m.blocks_added.inc();
let text = m.render();
assert!(text.contains("ipfrs_blocks_added_total"));

Fields§

§registry: Registry

Private registry — metrics exported via render().

§blocks_added: Counter

Total blocks added to local storage.

§blocks_fetched: Counter

Total blocks fetched from local storage or network.

§blocks_deleted: Counter

Total blocks deleted.

§block_add_bytes: Counter

Total bytes written via add_bytes / add_file.

§block_fetch_latency: Histogram

Latency (seconds) for block fetch operations.

§cache_hit_rate: Gauge

Rolling cache hit-rate (0.0 – 1.0).

§dht_provide_calls: Counter

Number of DHT provide calls.

§dht_find_providers_calls: Counter

Number of DHT find_providers calls.

§dht_provider_records: Gauge

Current number of provider records held by this node.

§inference_sessions_started: Counter

Inference sessions started.

§inference_sessions_completed: Counter

Inference sessions completed successfully.

§inference_session_latency: Histogram

End-to-end latency (seconds) for completed inference sessions.

§proof_tree_depth: Histogram

Depth of proof trees emitted during inference.

§gossipsub_messages_sent: Counter

Messages published to GossipSub topics.

§gossipsub_messages_received: Counter

Messages received from GossipSub topics.

§gossipsub_mesh_peers: Gauge

Current number of mesh peers across all topics.

§storage_bytes_total: Gauge

Total bytes currently stored on disk (updated periodically).

§storage_blocks_total: Gauge

Total number of blocks currently stored on disk.

§gc_runs: Counter

Number of GC runs completed.

§gc_blocks_collected: Counter

Total blocks collected (deleted) across all GC runs.

Implementations§

Source§

impl IpfrsMetrics

Source

pub fn new() -> Result<Self, Error>

Create a new metrics registry with all counters, gauges, and histograms initialised to zero.

§Errors

Returns a prometheus::Error if any metric registration fails (which should only happen if two metrics share the same name).

Source

pub fn render(&self) -> String

Render all registered metrics in Prometheus text exposition format.

Returns an empty string if encoding fails.

Trait Implementations§

Source§

impl Default for IpfrsMetrics

Source§

fn default() -> Self

Returns the “default value” for a type. 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
Source§

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

Source§

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

Source§

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

Source§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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