Skip to main content

Supervisor

Struct Supervisor 

Source
pub struct Supervisor { /* private fields */ }
Expand description

Process supervisor for subc-owned singleton modules.

Implementations§

Source§

impl Supervisor

Source

pub fn new(registry: Arc<Registry>, restart_policy: RestartPolicy) -> Self

Source

pub fn with_drain_timeout(self, drain_timeout: Duration) -> Self

Source

pub fn with_process_liveness( self, process_liveness: Arc<SupervisorProcessLiveness>, ) -> Self

Source

pub fn with_connection_file_path( self, connection_file_path: impl Into<PathBuf>, ) -> Self

Source

pub fn with_capture_logs_dir(self, logs_dir: impl Into<PathBuf>) -> Self

Enables daemon-owned capture files for supervised stdout and stderr.

Source

pub fn with_daemon_incarnation(self, daemon_incarnation: String) -> Self

Names this daemon lifetime in spawn events, independently of whether a terminal journal is configured.

Source

pub fn with_terminal_journal( self, path: PathBuf, daemon_incarnation: String, ) -> Self

Enables best-effort history shared by every supervised module. Without it, terminal history is kept only in each module’s in-memory ring.

Source

pub fn with_forwarding(self, forwarding: Arc<ForwardingTable>) -> Self

Source

pub fn with_handle(self, supervisor_handle: SupervisorHandle) -> Self

Source

pub fn with_health_config(self, health: HealthConfig) -> Self

Source

pub fn with_live_children_record(self, path: impl Into<PathBuf>) -> Self

Keeps a record of every live child at path, rewritten on each spawn and reap, for the orphan sweep a later daemon runs at boot. Without it no record is kept.

Source

pub fn with_cgroup_placement(self, cgroup_placement: Option<Placement>) -> Self

Source

pub fn spawn( &self, spec: ModuleSpec, ) -> Result<SupervisedModule, SuperviseError>

Spawn spec.program and start monitoring it.

The child is expected to parse --subc <connection-file-path>, read the TCP+key connection file, authenticate to the already-running listener, and register with channel-0 HELLO using spec.module_id as its manifest id.

Source

pub fn supervise_configured( &self, spec: ModuleSpec, enabled: bool, ) -> Result<SupervisedModule, SuperviseError>

Start supervising a module declared in daemon configuration.

Unlike Self::spawn, this records disabled modules and immediate spawn failures in the supervisor handle so operator-facing supervisor.list reflects every configured module while daemon startup continues.

Source

pub fn supervise_configured_with_health( &self, spec: ModuleSpec, enabled: bool, health: HealthConfig, drain_timeout_ms: Option<u64>, restart_policy: RestartPolicy, ) -> Result<SupervisedModule, SuperviseError>

Supervise a configured module with its own health, drain, and crash budget. The restart policy is per-module because the config file is: modules.<id>.restart resolves to a full policy at parse time, and a module that is expensive to restart should not be forced onto the same budget as one that is cheap.

Trait Implementations§

Source§

impl Clone for Supervisor

Source§

fn clone(&self) -> Self

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 Supervisor

Source§

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

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

impl Default for Supervisor

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

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.
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