alluxio

Class ProcessUtils

java.lang.Object

alluxio.ProcessUtils

public final class ProcessUtils
extends Object

Utility methods for Alluxio Processes.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<CommonUtils.ProcessType>	COLLECT_ON_EXIT
static java.time.format.DateTimeFormatter	DATETIME_FORMAT
static boolean	sInfoDumpOnExitCheck

Method Summary

Modifier and Type	Method and Description
static void	dumpInformationOnExit() Outputs process critical information like metrics and jstack before it exits.
static List<Future<Void>>	dumpInformationOnFailover(ExecutorService es) Outputs process critical information like metrics and jstack before the primary master fails over to standby.
static void	fatalError(org.slf4j.Logger logger, String format, Object... args) Logs a fatal error and then exits the system.
static void	fatalError(org.slf4j.Logger logger, Throwable t, String format, Object... args) Logs a fatal error and then exits the system.
static void	run(Process process) Runs the given Process.
static void	stopProcessOnShutdown(Process process) Adds a shutdown hook that will be invoked when a signal is sent to this process.

Methods inherited from class java.lang.Object

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

Field Detail

COLLECT_ON_EXIT

public static final Set<CommonUtils.ProcessType> COLLECT_ON_EXIT

sInfoDumpOnExitCheck

public static volatile boolean sInfoDumpOnExitCheck

DATETIME_FORMAT

public static final java.time.format.DateTimeFormatter DATETIME_FORMAT

Method Detail

run

public static void run(Process process)

Runs the given Process. This method should only be called from main() methods.

Parameters:

process - the Process to run

fatalError

public static void fatalError(org.slf4j.Logger logger,
                              String format,
                              Object... args)

Logs a fatal error and then exits the system.

Parameters:

logger - the logger to log to

format - the error message format string

args - args for the format string

fatalError

public static void fatalError(org.slf4j.Logger logger,
                              Throwable t,
                              String format,
                              Object... args)

Logs a fatal error and then exits the system.

Parameters:

logger - the logger to log to

t - the throwable causing the fatal error

format - the error message format string

args - args for the format string

stopProcessOnShutdown

public static void stopProcessOnShutdown(Process process)

Adds a shutdown hook that will be invoked when a signal is sent to this process. The process may be utilizing some resources, and this shutdown hook will be invoked by JVM when a SIGTERM is sent to the process by "kill" command. The shutdown hook calls Process.stop() method to cleanly release the resources and exit.

Parameters:

process - the data structure representing the process to terminate

dumpInformationOnExit

public static void dumpInformationOnExit()

Outputs process critical information like metrics and jstack before it exits. This is synchronous in order to capture as much information at the scene as possible. The information will be output to separate files in the log directory.

dumpInformationOnFailover

public static List<Future<Void>> dumpInformationOnFailover(ExecutorService es)

Outputs process critical information like metrics and jstack before the primary master fails over to standby. This is asynchronous in order not to block the failover. The information will be output to separate files in the log directory.

Parameters:

es - the thread pool to submit tasks to

Returns:

a list of futures for async info dumping jobs