Skip to content

status

Structs

  • ComponentStatus - Snapshot of one component’s runtime state.
  • StackStatus - Aggregate stack snapshot returned by [status_components].

Functions

  • status_components - Probe each named component in order without acquiring process ownership.

firma_process_orchestrator::status::ComponentStatus

Section titled “firma_process_orchestrator::status::ComponentStatus”

Struct

Snapshot of one component’s runtime state.

Fields:

  • name: String - Logical component name (authority / sidecar).
  • pid: Option<firma_runtime_state::UserProcessId> - PID read from <state_dir>/<name>.pid, when present.
  • state: State - Coarse-grained state. See [State].
  • listen: Option<crate::ComponentEndpoint> - Listen address read from <state_dir>/<name>.listen (written at spawn
  • uptime_secs: Option<u64> - Seconds since the pidfile was written, used as a proxy for process

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> ComponentStatus
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>

firma_process_orchestrator::status::StackStatus

Section titled “firma_process_orchestrator::status::StackStatus”

Struct

Aggregate stack snapshot returned by [status_components].

Fields:

  • components: Vec<ComponentStatus> - One entry per known component (authority first, then sidecar).

Trait Implementations:

  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Clone
    • fn clone(self: &Self) -> StackStatus
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_process_orchestrator::status::status_components

Section titled “firma_process_orchestrator::status::status_components”

Function

Probe each named component in order without acquiring process ownership.

The component names are caller-supplied data supplied in startup order; this loop is agnostic to which components the stack contains.

Returns errors propagated by [probe].

fn status_components(state_dir: &std::path::Path, topology: &crate::StackTopology) -> Result<StackStatus, crate::error::OrchestratorError>