Skip to main content

ProcStatus

Struct ProcStatus 

Source
pub struct ProcStatus {
    pub state: ProcState,
    pub ready: Option<bool>,
    pub pid: Option<u32>,
    pub uptime_secs: Option<u64>,
    pub version: Option<String>,
    pub detail: Option<String>,
    pub endpoints: BTreeMap<String, String>,
    pub metrics: BTreeMap<String, f64>,
}
Expand description

A workload’s self-description. Only Self::state is required.

Field-for-field the same document yah-cloud’s proc_control client parses; the two types are separate only because neither side may force its dependencies on the other.

Fields§

§state: ProcState

Lifecycle state, in kamaji’s vocabulary.

§ready: Option<bool>

Redundant convenience mirror of state == running, accepted from producers that emit it. Never trusted over state — a document claiming {"state":"starting","ready":true} is a producer bug, and believing the optimistic half of it is how a supervisor reports a half-booted process as up.

§pid: Option<u32>

Process id. Stamped by ControlServer when the producer leaves it unset — the helper knows its own pid and cannot get it wrong.

§uptime_secs: Option<u64>

Seconds since the process considered itself started. Stamped by ControlServer (from when the control server was started) when the producer leaves it unset.

§version: Option<String>

Build/version string, for an operator staring at two of these.

§detail: Option<String>

One human line elaborating on state — “replaying WAL 3/7”, “waiting for GPU”. This is the field that replaces log-grepping.

§endpoints: BTreeMap<String, String>

Named addresses the process serves — {"http":"http://127.0.0.1:4325"}. A portless process may legitimately name a non-URL surface here.

§metrics: BTreeMap<String, f64>

Numeric gauges the process wants surfaced. Free-form on purpose: this is a status channel, not a metrics pipeline.

Implementations§

Source§

impl ProcStatus

Source

pub fn new(state: ProcState) -> Self

A document reporting state and nothing else.

Source

pub fn with_detail(self, detail: impl Into<String>) -> Self

The one human line that replaces log-grepping.

Source

pub fn with_version(self, version: impl Into<String>) -> Self

Build/version string. env!("CARGO_PKG_VERSION") is the usual argument.

Source

pub fn with_pid(self, pid: u32) -> Self

Override the pid the server would otherwise stamp — for a producer that supervises something other than itself.

Source

pub fn with_uptime_secs(self, secs: u64) -> Self

Override the uptime the server would otherwise stamp.

Source

pub fn with_endpoint( self, name: impl Into<String>, addr: impl Into<String>, ) -> Self

Name an address this process serves. A portless process may legitimately name a non-URL surface ("gui" -> "winit://main").

Source

pub fn with_metric(self, name: impl Into<String>, value: f64) -> Self

Surface a numeric gauge.

Source

pub fn is_ready(&self) -> bool

Ready iff the state says so. See Self::ready for why the producer-supplied boolean does not get a vote.

Source

pub fn summary(&self) -> String

One-line rendering for an operator-facing note or log line.

Trait Implementations§

Source§

impl Clone for ProcStatus

Source§

fn clone(&self) -> ProcStatus

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 ProcStatus

Source§

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

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

impl<'de> Deserialize<'de> for ProcStatus

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 PartialEq for ProcStatus

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ProcStatus

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

impl StructuralPartialEq for ProcStatus

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<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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.