Class BrokerAdminServiceImpl
- java.lang.Object
-
- io.camunda.zeebe.util.sched.Actor
-
- io.camunda.zeebe.broker.system.management.BrokerAdminServiceImpl
-
- All Implemented Interfaces:
BrokerAdminService,CloseableSilently,AsyncClosable,AutoCloseable
public class BrokerAdminServiceImpl extends Actor implements BrokerAdminService
A service that exposes interface to control some of the core functionalities of the broker such as * Pause stream processing * Force take a snapshotThis is intended to be used only by advanced users
-
-
Constructor Summary
Constructors Constructor Description BrokerAdminServiceImpl(List<ZeebePartition> partitions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<Integer,PartitionStatus>getPartitionStatus()ReturnsPartitionStatusof all partitions running on this broker.voidpauseExporting()Request a partition to pause exportingvoidpauseStreamProcessing()Request a partition to pause its StreamProcessorvoidprepareForUpgrade()Prepares for upgrade by pausing stream processors and triggering snapshots.voidresumeExporting()Request a partition to resume exportingvoidresumeStreamProcessing()Request a partition to resume its StreamProcessorvoidtakeSnapshot()Trigger a snapshot.-
Methods inherited from class io.camunda.zeebe.util.sched.Actor
buildActorName, buildActorName, close, closeAsync, getName, handleFailure, isActorClosed, onActorClosed, onActorCloseRequested, onActorClosing, onActorFailed, onActorStarted, onActorStarting, wrap
-
-
-
-
Constructor Detail
-
BrokerAdminServiceImpl
public BrokerAdminServiceImpl(List<ZeebePartition> partitions)
-
-
Method Detail
-
pauseStreamProcessing
public void pauseStreamProcessing()
Description copied from interface:BrokerAdminServiceRequest a partition to pause its StreamProcessor- Specified by:
pauseStreamProcessingin interfaceBrokerAdminService
-
resumeStreamProcessing
public void resumeStreamProcessing()
Description copied from interface:BrokerAdminServiceRequest a partition to resume its StreamProcessor- Specified by:
resumeStreamProcessingin interfaceBrokerAdminService
-
pauseExporting
public void pauseExporting()
Description copied from interface:BrokerAdminServiceRequest a partition to pause exporting- Specified by:
pauseExportingin interfaceBrokerAdminService
-
resumeExporting
public void resumeExporting()
Description copied from interface:BrokerAdminServiceRequest a partition to resume exporting- Specified by:
resumeExportingin interfaceBrokerAdminService
-
takeSnapshot
public void takeSnapshot()
Description copied from interface:BrokerAdminServiceTrigger a snapshot. Partition will attempt to take a snapshot instead of waiting for the snapshot interval.- Specified by:
takeSnapshotin interfaceBrokerAdminService
-
prepareForUpgrade
public void prepareForUpgrade()
Description copied from interface:BrokerAdminServicePrepares for upgrade by pausing stream processors and triggering snapshots. It is not normally required to call this before every upgrade. However, this is useful as an upgrade procedure to mitigate the effects of some known bugs.- Specified by:
prepareForUpgradein interfaceBrokerAdminService
-
getPartitionStatus
public Map<Integer,PartitionStatus> getPartitionStatus()
Description copied from interface:BrokerAdminServiceReturnsPartitionStatusof all partitions running on this broker.- Specified by:
getPartitionStatusin interfaceBrokerAdminService- Returns:
- a map of partition id and partition status
-
-