Skip to main content

ClusterSupervisor

Struct ClusterSupervisor 

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

The cluster supervisor: health scoring + automatic range failover planning.

Holds only the HealthPolicy; all live state is read through ClusterSignals at scan time, so one supervisor instance serves the whole cluster lifetime.

Implementations§

Source§

impl ClusterSupervisor

Source

pub fn new(policy: HealthPolicy) -> ClusterSupervisor

A supervisor with the given health policy.

Source

pub fn policy(&self) -> &HealthPolicy

Source

pub fn assess(&self, signals: &MemberSignals) -> HealthScore

Score a single member’s health under the policy. The building block of degraded-member detection: an operator surface calls this for every authorized member to render a health view.

Source

pub fn assess_members( &self, membership: &MembershipCatalog, signals: &impl ClusterSignals, ) -> BTreeMap<NodeIdentity, HealthScore>

Score every authorized member of membership, in stable identity order. Includes healthy, degraded, and failed members alike — the input to a cluster health dashboard.

Source

pub fn plan_failovers( &self, membership: &MembershipCatalog, ownership: &ShardOwnershipCatalog, signals: &impl ClusterSignals, ) -> FailoverPlan

Plan automatic failovers across the whole ownership catalog without mutating it. For each range whose owner is failover-eligible (Failed and past the grace period), pick the safest caught-up replica candidate and produce a PlannedPromotion; if no replica is safe, record a BlockedFailover. Owners that are healthy, merely degraded, or still inside their grace period produce nothing.

Source

pub fn run_failovers( &self, membership: &MembershipCatalog, ownership: &mut ShardOwnershipCatalog, signals: &impl ClusterSignals, ) -> (Vec<Result<TransitionOutcome, TransitionError>>, FailoverPlan)

Plan failovers and immediately run the safe promotions through the ownership transition machine, fencing each failed owner via the epoch bump. Returns the activated TransitionOutcomes and the surviving FailoverPlan (whose blocked entries still need attention; its promotions are the requests that were run).

Each promotion is an independent catalog entry, so running them in sequence never invalidates another’s CAS. A promotion whose CAS lost a race (the catalog moved between planning and activation) surfaces as a TransitionError in the returned vector rather than aborting the rest.

Trait Implementations§

Source§

impl Clone for ClusterSupervisor

Source§

fn clone(&self) -> ClusterSupervisor

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 ClusterSupervisor

Source§

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

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

impl Default for ClusterSupervisor

Source§

fn default() -> ClusterSupervisor

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<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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> 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