io.aeron.cluster

Class ClusterTool

java.lang.Object

io.aeron.cluster.ClusterTool

public class ClusterTool
extends Object

Tool for investigating the state of a cluster node.

 Usage: ClusterTool <cluster-dir> <command> [options]
                    describe: prints out all descriptors in the file.
                         pid: prints PID of cluster component.
               recovery-plan: [service count] prints recovery plan of cluster component.
               recording-log: prints recording log of cluster component.
                      errors: prints Aeron and cluster component error logs.
                list-members: print leader memberId, active members list, and passive members list.
               remove-member: [memberId] requests removal of a member specified in memberId.
              remove-passive: [memberId] requests removal of passive member specified in memberId.
                backup-query: [delay] get time of next backup query or set time of next backup query.
  invalidate-latest-snapshot: Mark the latest snapshot as invalid so previous is loaded.
                    snapshot: Trigger a snapshot on the leader.
                     suspend: Suspend reading from the ingress channel.
                      resume: Resume reading from the ingress channel.
                    shutdown: Do an orderly stop of the cluster with a snapshot.
                       abort: Stop the cluster without a snapshot.
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	AERON_CLUSTER_TOOL_DELAY_PROP_NAME Delay in nanoseconds to be applied to an operation such as when the new cluster backup query will occur.
static String	AERON_CLUSTER_TOOL_TIMEOUT_PROP_NAME Timeout in nanoseconds for the tool to wait while trying to perform an operation.

Constructor Summary

Constructors

Constructor and Description
ClusterTool()

Method Summary

Modifier and Type	Method and Description
static boolean	abort(File clusterDir, PrintStream out)
static void	describe(PrintStream out, ClusterMarkFile[] serviceMarkFiles)
static void	describe(PrintStream out, File clusterDir)
static void	errors(PrintStream out, ClusterMarkFile[] serviceMarkFiles)
static void	errors(PrintStream out, File clusterDir)
static boolean	invalidateLatestSnapshot(PrintStream out, File clusterDir)
static boolean	listMembers(ClusterMembership clusterMembership, File clusterDir, long timeoutMs)
static void	listMembers(PrintStream out, File clusterDir)
static void	main(String[] args) Main method for launching the process.
static boolean	markFileExists(File clusterDir)
static void	nextBackupQuery(PrintStream out, File clusterDir, long delayMs)
static long	nextBackupQueryDeadlineMs(ClusterMarkFile markFile)
static boolean	nextBackupQueryDeadlineMs(ClusterMarkFile markFile, long timeMs)
static long	nextBackupQueryDeadlineMs(File clusterDir)
static boolean	nextBackupQueryDeadlineMs(File clusterDir, long timeMs)
static void	pid(PrintStream out, File clusterDir)
static void	printNextBackupQuery(PrintStream out, File clusterDir)
static boolean	queryClusterMembers(ClusterMarkFile markFile, long timeoutMs, ClusterMembership clusterMembership)
static boolean	queryClusterMembers(ClusterNodeControlProperties controlProperties, long timeoutMs, ClusterMembership clusterMembership)
static void	recordingLog(PrintStream out, File clusterDir)
static void	recoveryPlan(PrintStream out, File clusterDir, int serviceCount)
static boolean	removeMember(ClusterMarkFile markFile, int memberId, boolean isPassive)
static boolean	removeMember(File clusterDir, int memberId, boolean isPassive)
static void	removeMember(PrintStream out, File clusterDir, int memberId, boolean isPassive)
static boolean	resume(File clusterDir, PrintStream out)
static boolean	shutdown(File clusterDir, PrintStream out)
static boolean	snapshot(File clusterDir, PrintStream out)
static boolean	suspend(File clusterDir, PrintStream out)
static boolean	toggleClusterState(PrintStream out, File clusterDir, ConsensusModule.State expectedState, ClusterControl.ToggleState toggleState, boolean waitForToggleToComplete, long defaultTimeoutMs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AERON_CLUSTER_TOOL_TIMEOUT_PROP_NAME

public static final String AERON_CLUSTER_TOOL_TIMEOUT_PROP_NAME

Timeout in nanoseconds for the tool to wait while trying to perform an operation.

See Also:

Constant Field Values

AERON_CLUSTER_TOOL_DELAY_PROP_NAME

public static final String AERON_CLUSTER_TOOL_DELAY_PROP_NAME

Delay in nanoseconds to be applied to an operation such as when the new cluster backup query will occur.

See Also:

Constant Field Values

Constructor Detail

ClusterTool

public ClusterTool()

Method Detail

main

public static void main(String[] args)

Main method for launching the process.

Parameters:

args - passed to the process.

describe

public static void describe(PrintStream out,
                            File clusterDir)

pid

public static void pid(PrintStream out,
                       File clusterDir)

recoveryPlan

public static void recoveryPlan(PrintStream out,
                                File clusterDir,
                                int serviceCount)

recordingLog

public static void recordingLog(PrintStream out,
                                File clusterDir)

errors

public static void errors(PrintStream out,
                          File clusterDir)

listMembers

public static void listMembers(PrintStream out,
                               File clusterDir)

removeMember

public static void removeMember(PrintStream out,
                                File clusterDir,
                                int memberId,
                                boolean isPassive)

printNextBackupQuery

public static void printNextBackupQuery(PrintStream out,
                                        File clusterDir)

nextBackupQuery

public static void nextBackupQuery(PrintStream out,
                                   File clusterDir,
                                   long delayMs)

describe

public static void describe(PrintStream out,
                            ClusterMarkFile[] serviceMarkFiles)

errors

public static void errors(PrintStream out,
                          ClusterMarkFile[] serviceMarkFiles)

markFileExists

public static boolean markFileExists(File clusterDir)

listMembers

public static boolean listMembers(ClusterMembership clusterMembership,
                                  File clusterDir,
                                  long timeoutMs)

queryClusterMembers

public static boolean queryClusterMembers(ClusterMarkFile markFile,
                                          long timeoutMs,
                                          ClusterMembership clusterMembership)

queryClusterMembers

public static boolean queryClusterMembers(ClusterNodeControlProperties controlProperties,
                                          long timeoutMs,
                                          ClusterMembership clusterMembership)

removeMember

public static boolean removeMember(File clusterDir,
                                   int memberId,
                                   boolean isPassive)

removeMember

public static boolean removeMember(ClusterMarkFile markFile,
                                   int memberId,
                                   boolean isPassive)

nextBackupQueryDeadlineMs

public static long nextBackupQueryDeadlineMs(File clusterDir)

nextBackupQueryDeadlineMs

public static long nextBackupQueryDeadlineMs(ClusterMarkFile markFile)

nextBackupQueryDeadlineMs

public static boolean nextBackupQueryDeadlineMs(File clusterDir,
                                                long timeMs)

nextBackupQueryDeadlineMs

public static boolean nextBackupQueryDeadlineMs(ClusterMarkFile markFile,
                                                long timeMs)

invalidateLatestSnapshot

public static boolean invalidateLatestSnapshot(PrintStream out,
                                               File clusterDir)

snapshot

public static boolean snapshot(File clusterDir,
                               PrintStream out)

suspend

public static boolean suspend(File clusterDir,
                              PrintStream out)

resume

public static boolean resume(File clusterDir,
                             PrintStream out)

shutdown

public static boolean shutdown(File clusterDir,
                               PrintStream out)

abort

public static boolean abort(File clusterDir,
                            PrintStream out)

toggleClusterState

public static boolean toggleClusterState(PrintStream out,
                                         File clusterDir,
                                         ConsensusModule.State expectedState,
                                         ClusterControl.ToggleState toggleState,
                                         boolean waitForToggleToComplete,
                                         long defaultTimeoutMs)