alluxio.master.journal

Class AbstractJournalProgressLogger

java.lang.Object

alluxio.master.journal.AbstractJournalProgressLogger

Direct Known Subclasses:

RaftJournalProgressLogger, UfsJournalProgressLogger

public abstract class AbstractJournalProgressLogger
extends Object

Class to abstract out progress logging for journal replay.

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_LOG_INTERVAL_MS Max time to wait before actually logging.

Constructor Summary

Constructors

Constructor and Description
AbstractJournalProgressLogger(OptionalLong endComitIdx) Creates a new instance of AbstractJournalProgressLogger.

Method Summary

Modifier and Type	Method and Description
abstract String	getJournalName()
abstract long	getLastAppliedIndex()
boolean	logProgress() Logs the progress of journal replay.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_LOG_INTERVAL_MS

public static final long MAX_LOG_INTERVAL_MS

Max time to wait before actually logging.

See Also:

Constant Field Values

Constructor Detail

AbstractJournalProgressLogger

public AbstractJournalProgressLogger(OptionalLong endComitIdx)

Creates a new instance of AbstractJournalProgressLogger.

Parameters:

endComitIdx - the final commit index in the journal. Used to estimate completion time

Method Detail

getLastAppliedIndex

public abstract long getLastAppliedIndex()

Returns:

the last applied commit index to a journal

getJournalName

public abstract String getJournalName()

Returns:

the name of the journal

logProgress

public boolean logProgress()

Logs the progress of journal replay. This method rate limits itself on when it actually calculates and logs the message. If it is called too frequently, then it will essentially be a no-op. The return value indicates whether a message was logged or not as a result of calling the method.

Returns:

true is a message is logged, false otherwise