org.apache.jackrabbit.oak.api.jmx

Interface IndexStatsMBean

@ProviderType
public interface IndexStatsMBean

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STATUS_DONE
static java.lang.String	STATUS_FAILING
static java.lang.String	STATUS_INIT
static java.lang.String	STATUS_INTERRUPTED
static java.lang.String	STATUS_RUNNING
static java.lang.String	TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	abortAndPause()
long	getConsecutiveFailedExecutions()
javax.management.openmbean.CompositeData	getConsolidatedExecutionStats() Returns the consolidated execution stats since last reset
java.lang.String	getDone()
javax.management.openmbean.CompositeData	getExecutionCount() Returns the number of executions as a org.apache.jackrabbit.api.stats.TimeSeries.
javax.management.openmbean.CompositeData	getExecutionTime() Deprecated.
javax.management.openmbean.TabularData	getFailingIndexStats()
java.lang.String	getFailingSince()
javax.management.openmbean.CompositeData	getIndexedNodesCount() Returns the number of indexed nodes as a org.apache.jackrabbit.api.stats.TimeSeries.
java.lang.String	getLastIndexedTime()
java.lang.String	getLatestError()
java.lang.String	getLatestErrorTime()
java.lang.String	getName() Name of the async indexing lane
long	getNodesReadCount() Returns the number of which have been read so far.
java.lang.String	getProcessedCheckpoint() Returns the processed checkpoint used by the async indexer.
java.lang.String	getReferenceCheckpoint() Returns the current reference checkpoint used by the async indexer
java.lang.String	getStart()
java.lang.String	getStatus() Returns the current status of the indexing job
java.lang.String	getTemporaryCheckpoints() Temporary checkpoints represent old checkpoints that have been processed but the cleanup was not successful of did not happen at all (like in the event the system was forcibly stopped).
long	getTotalExecutionCount() Returns the number of executions.
long	getUpdates() Returns the number of updates from the current run cycle.
boolean	isFailing()
boolean	isPaused() Returns the value of the 'paused' flag
void	pause() Pauses the background indexing process.
void	registerAsyncIndexer(java.lang.String name, long delayInSeconds) Starts a new background indexing task and registers the JMX MBeans for it
void	resetConsolidatedExecutionStats() Deprecated.
void	resume() Resumes the indexing process.
void	splitIndexingTask(java.lang.String paths, java.lang.String newIndexTaskName) Splits the current indexing tasks into 2, indexes that are passed in as an input will have their 'async' property updated to newIndexTaskName.

Field Detail

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

STATUS_INIT

static final java.lang.String STATUS_INIT

See Also:

Constant Field Values

STATUS_RUNNING

static final java.lang.String STATUS_RUNNING

See Also:

Constant Field Values

STATUS_DONE

static final java.lang.String STATUS_DONE

See Also:

Constant Field Values

STATUS_FAILING

static final java.lang.String STATUS_FAILING

See Also:

Constant Field Values

STATUS_INTERRUPTED

static final java.lang.String STATUS_INTERRUPTED

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Name of the async indexing lane

getStart

java.lang.String getStart()

Returns:

The time the indexing job stared at, or "" if it is not currently running.

getDone

java.lang.String getDone()

Returns:

The time the indexing job finished at, or "" if it is still running.

getStatus

java.lang.String getStatus()

Returns the current status of the indexing job

Returns:

the current status of the indexing job: "init", "running" or "done"

getLastIndexedTime

java.lang.String getLastIndexedTime()

Returns:

the last upto which the repository was indexed

pause

void pause()

Pauses the background indexing process. Future changes are not indexed until the resume() method is called. The pause call will take effect on the next run cycle and will affect all indexes marked as 'async'. Note: this is experimental and should only be used for debugging/diagnosis purposes!

abortAndPause

@Description(value="Aborts any running indexing cycle and pauses the indexer. Invoke \'resume\' once you are read to resume indexing again")
java.lang.String abortAndPause()

resume

void resume()

Resumes the indexing process. All changes from the previous indexed state will be indexed.

See Also:

pause()

isPaused

boolean isPaused()

Returns the value of the 'paused' flag

Returns:

true if the indexing job is paused

getUpdates

long getUpdates()

Returns the number of updates from the current run cycle. This value is kept until the next cycle begins.

Returns:

the number of updates from the current run cycle. This value is kept until the next cycle begins.

getNodesReadCount

long getNodesReadCount()

Returns the number of which have been read so far. This value is kept until the next cycle begins.

Returns:

the number of node read from the current run cycle. This value is kept until the next cycle begins.

getReferenceCheckpoint

java.lang.String getReferenceCheckpoint()

Returns the current reference checkpoint used by the async indexer

Returns:

the reference checkpoint

getProcessedCheckpoint

java.lang.String getProcessedCheckpoint()

Returns the processed checkpoint used by the async indexer. If this index round finishes successfully, the processed checkpoint will become the reference checkpoint, and the old reference checkpoint wil be released.

Returns:

the processed checkpoint

getTemporaryCheckpoints

java.lang.String getTemporaryCheckpoints()

Temporary checkpoints represent old checkpoints that have been processed but the cleanup was not successful of did not happen at all (like in the event the system was forcibly stopped).

Returns:

the already processed checkpoints

getTotalExecutionCount

long getTotalExecutionCount()

Returns the number of executions.

Returns:

the execution count

getExecutionCount

javax.management.openmbean.CompositeData getExecutionCount()

Returns the number of executions as a org.apache.jackrabbit.api.stats.TimeSeries.

Returns:

the execution count time series

getExecutionTime

@Deprecated
javax.management.openmbean.CompositeData getExecutionTime()

Deprecated.

Returns the execution time as a org.apache.jackrabbit.api.stats.TimeSeries.

Returns:

the execution times time series

getIndexedNodesCount

javax.management.openmbean.CompositeData getIndexedNodesCount()

Returns the number of indexed nodes as a org.apache.jackrabbit.api.stats.TimeSeries.

Returns:

the indexed nodes time series

getConsolidatedExecutionStats

javax.management.openmbean.CompositeData getConsolidatedExecutionStats()

Returns the consolidated execution stats since last reset

Returns:

consolidated execution stats

resetConsolidatedExecutionStats

@Deprecated
void resetConsolidatedExecutionStats()

Deprecated.

Resets the consolidated stats.

splitIndexingTask

void splitIndexingTask(@Name(value="paths") @Description(value="Comma separated list of paths of the index definitions")
                       java.lang.String paths,
                       @Name(value="newIndexTaskName") @Description(value="The indexing task name set on the async property")
                       java.lang.String newIndexTaskName)

Splits the current indexing tasks into 2, indexes that are passed in as an input will have their 'async' property updated to newIndexTaskName. Note that this call will *not* bootstrap a new indexing task for the given name.

registerAsyncIndexer

void registerAsyncIndexer(@Name(value="name")
                          java.lang.String name,
                          @Name(value="delayInSeconds")
                          long delayInSeconds)

Starts a new background indexing task and registers the JMX MBeans for it

isFailing

boolean isFailing()

Returns:

true if the indexing job is failing

getFailingSince

java.lang.String getFailingSince()

Returns:

The time the indexing job stared failing, or "" if the job is not currently failing.

getConsecutiveFailedExecutions

long getConsecutiveFailedExecutions()

Returns:

the number of consecutive failed executions or 0 if the job is not currently failing.

getLatestError

java.lang.String getLatestError()

Returns:

the latest indexing error seen, will not be reset once the job starts working again

getLatestErrorTime

java.lang.String getLatestErrorTime()

Returns:

the time when the latest indexing error has been seen, will not be reset once the job starts working again

getFailingIndexStats

javax.management.openmbean.TabularData getFailingIndexStats()