Struct RegionSupervisor 

pub struct RegionSupervisor {
    failure_detector: RegionFailureDetector,
    failover_counts: HashMap<DetectingRegion, u32>,
    receiver: Receiver<Event>,
    selector_context: SelectorContext,
    selector: RegionSupervisorSelector,
    region_migration_manager: RegionMigrationManagerRef,
    runtime_switch_manager: RuntimeSwitchManagerRef,
    peer_resolver: PeerResolverRef,
    kv_backend: KvBackendRef,
    state: Option<StateRef>,
}

The RegionSupervisor is used to detect Region failures and initiate Region failover upon detection, ensuring uninterrupted region service.

Fields

failure_detector: RegionFailureDetector

Used to detect the failure of regions.

failover_counts: HashMap<DetectingRegion, u32>

Tracks the number of failovers for each region.

receiver: Receiver<Event>

Receives Events.

selector_context: SelectorContext

The context of SelectorRef

selector: RegionSupervisorSelector

Candidate node selector.

region_migration_manager: RegionMigrationManagerRef

Region migration manager.

runtime_switch_manager: RuntimeSwitchManagerRef

The maintenance mode manager.

peer_resolver: PeerResolverRef

Peer resolver

kv_backend: KvBackendRef

The kv backend.

state: Option<StateRef>

The meta state, used to check if the current metasrv is the leader.

Implementations

impl RegionSupervisor

pub(crate) fn channel() -> (Sender<Event>, Receiver<Event>)

Returns a mpsc channel with a buffer capacity of 1024 for sending and receiving Event messages.

pub(crate) fn new( event_receiver: Receiver<Event>, options: PhiAccrualFailureDetectorOptions, selector_context: SelectorContext, selector: RegionSupervisorSelector, region_migration_manager: RegionMigrationManagerRef, runtime_switch_manager: RuntimeSwitchManagerRef, peer_resolver: PeerResolverRef, kv_backend: KvBackendRef, ) -> Self

pub(crate) fn with_state(self, state: StateRef) -> Self

Sets the meta state.

pub(crate) async fn run(&mut self)

Runs the main loop.

async fn initialize_all(&self) -> Result<()>

async fn register_failure_detectors( &self, detecting_regions: Vec<DetectingRegion>, )

async fn deregister_failure_detectors( &mut self, detecting_regions: Vec<DetectingRegion>, )

async fn handle_region_failures(&mut self, regions: Vec<(DatanodeId, RegionId)>)

pub(crate) async fn is_maintenance_mode_enabled(&self) -> Result<bool>

async fn select_peers( &self, from_peer_id: DatanodeId, regions: &[RegionId], failure_datanodes: &[DatanodeId], ) -> Result<Vec<(RegionId, Peer)>>

async fn generate_failover_tasks( &mut self, from_peer_id: DatanodeId, regions: &[RegionId], failed_datanodes: &[DatanodeId], ) -> Result<Vec<(RegionMigrationProcedureTask, u32)>>

async fn do_failover_tasks( &mut self, task: RegionMigrationTaskBatch, ) -> Result<()>

async fn handle_submit_region_migration_task_result( &mut self, from_peer_id: DatanodeId, to_peer_id: DatanodeId, timeout: Duration, trigger_reason: RegionMigrationTriggerReason, result: SubmitRegionMigrationTaskResult, ) -> Result<()>

fn detect_region_failure(&self) -> Vec<(DatanodeId, RegionId)>

Detects the failure of regions.

fn regions(&self) -> HashSet<RegionId>

Returns all regions that registered in the failure detector.

fn on_heartbeat_arrived(&self, heartbeat: DatanodeHeartbeat)

Updates the state of corresponding failure detectors.

fn clear(&self)