Skip to main content

ClusterInfoSnapshot

Struct ClusterInfoSnapshot 

Source
pub struct ClusterInfoSnapshot {
    pub build: Section,
    pub config: Section,
    pub ring: Section,
    pub peers: RowSection,
    pub queues: Section,
    pub gossip: Section,
    pub recent_events: RowSection,
    pub memory: Section,
    pub fds: Section,
}
Expand description

Owned snapshot ready to be rendered.

Sections are stored in the canonical render order: build, config, ring, peers, queues, gossip, recent_events, memory, fds. Producers should fill every section even when the underlying data is unavailable; the formatter happily emits empty sections so the resulting text has a stable shape across releases.

§Examples

use dynomite::admin::cluster_info::ClusterInfoSnapshot;
let snap = ClusterInfoSnapshot::synthetic();
assert_eq!(snap.build.name(), "build");

Fields§

§build: Section

Build identity: version, git sha, build profile.

§config: Section

Sanitized configuration view.

§ring: Section

Ring distribution / vnode counts.

§peers: RowSection

Per-peer rows.

§queues: Section

Queue-depth gauges.

§gossip: Section

Gossip churn metrics.

§recent_events: RowSection

Bounded ring of lifecycle events.

§memory: Section

Memory accounting block.

§fds: Section

Open file-descriptor accounting block.

Implementations§

Source§

impl ClusterInfoSnapshot

Source

pub fn synthetic() -> Self

Hand-built snapshot useful for unit tests and the doc example. Every section is populated with a single representative entry.

§Examples
use dynomite::admin::cluster_info::{format_text, ClusterInfoSnapshot};
let snap = ClusterInfoSnapshot::synthetic();
let mut out = Vec::new();
format_text(&snap, &mut out).unwrap();
let text = String::from_utf8(out).unwrap();
assert!(text.contains("=== build ==="));

Trait Implementations§

Source§

impl Clone for ClusterInfoSnapshot

Source§

fn clone(&self) -> ClusterInfoSnapshot

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 ClusterInfoSnapshot

Source§

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

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

impl Default for ClusterInfoSnapshot

Source§

fn default() -> ClusterInfoSnapshot

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

impl Eq for ClusterInfoSnapshot

Source§

impl PartialEq for ClusterInfoSnapshot

Source§

fn eq(&self, other: &ClusterInfoSnapshot) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ClusterInfoSnapshot

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
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