Package org.apache.jackrabbit.oak.plugins.document

Class DocumentStoreStats

java.lang.Object

org.apache.jackrabbit.oak.plugins.document.DocumentStoreStats

All Implemented Interfaces:

DocumentStoreStatsCollector, DocumentStoreStatsMBean

public class DocumentStoreStats
extends Object
implements DocumentStoreStatsCollector, DocumentStoreStatsMBean

Document Store statistics helper class.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PERF_LOG_THRESHOLD

Fields inherited from interface org.apache.jackrabbit.oak.plugins.document.DocumentStoreStatsMBean

TYPE

Constructor Summary

Constructors

Constructor	Description
DocumentStoreStats(StatisticsProvider provider)

Method Summary

Modifier and Type	Method	Description
void	doneCreate(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids, boolean insertSuccess)	Called when a document is created in the given collection
void	doneCreateOrUpdate(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids)	Called when multiple document are either created or updated.
void	doneFindAndModify(long timeTakenNanos, Collection<? extends Document> collection, String key, boolean newEntry, boolean success, int retryCount)	Called when a update operation was completed which affected single document.
void	doneFindAndModify(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids, boolean success, int retryCount)	Called when a update operation was completed which could have affected multiple documents.
void	doneFindCached(Collection<? extends Document> collection, String key)	Called when a document with given key is found from the cache
void	doneFindUncached(long timeTakenNanos, Collection<? extends Document> collection, String key, boolean docFound, boolean isSlaveOk)	Called when a document with given key is read from remote store
void	donePrefetch(long timeTakenNanos, Collection<? extends Document> collection, List<String> ids)	Called when a prefetch operation for documents was completed.
void	doneQuery(long timeTakenNanos, Collection<? extends Document> collection, String fromKey, String toKey, boolean indexedProperty, int resultSize, long lockTime, boolean isSlaveOk)	Called when query with given parameters is performed
void	doneRemove(long timeTakenNanos, Collection<? extends Document> collection, int removeCount)	Called when a remove operation for documents was completed.
CompositeData	getCreateJournalHistory()
CompositeData	getCreateNodesHistory()
CompositeData	getFindCachedNodesHistory()
CompositeData	getFindNodesFromPrimaryHistory()
CompositeData	getFindNodesFromSlaveHistory()
CompositeData	getFindNodesMissingHistory()
CompositeData	getFindSplitNodesHistory()
long	getJournalCreateCount()
long	getJournalReadCount()
long	getNodesCreateCount()
long	getNodesFindCount()
long	getNodesFindMissingCount()
long	getNodesFindQueryCount()
long	getNodesPrefetchCount()
long	getNodesReadByQueryCount()
long	getNodesRemoveCount()
long	getNodesUpdateCount()
CompositeData	getPrefetchNodesHistory()
CompositeData	getQueryJournalHistory()
CompositeData	getQueryNodesFromPrimaryHistory()
CompositeData	getQueryNodesFromSlaveHistory()
CompositeData	getQueryNodesLockHistory()
CompositeData	getRemoveNodesHistory()
CompositeData	getUpdateNodesFailureHistory()
CompositeData	getUpdateNodesHistory()
CompositeData	getUpdateNodesRetryHistory()

Methods inherited from class java.lang.Object

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

Field Details

PERF_LOG_THRESHOLD

public static final int PERF_LOG_THRESHOLD

See Also:

• Constant Field Values

Constructor Details

DocumentStoreStats

public DocumentStoreStats(StatisticsProvider provider)

Method Details

doneFindCached

public void doneFindCached(Collection<? extends Document> collection,
 String key)

Description copied from interface: DocumentStoreStatsCollector

Called when a document with given key is found from the cache

Specified by:

doneFindCached in interface DocumentStoreStatsCollector

Parameters:

collection - the collection

key - collection key which is found

doneFindUncached

public void doneFindUncached(long timeTakenNanos,
 Collection<? extends Document> collection,
 String key,
 boolean docFound,
 boolean isSlaveOk)

Description copied from interface: DocumentStoreStatsCollector

Called when a document with given key is read from remote store

Specified by:

doneFindUncached in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

key - collection key

docFound - true if document is found

isSlaveOk - true if find was performed against a secondary instance

doneQuery

public void doneQuery(long timeTakenNanos,
 Collection<? extends Document> collection,
 String fromKey,
 String toKey,
 boolean indexedProperty,
 int resultSize,
 long lockTime,
 boolean isSlaveOk)

Description copied from interface: DocumentStoreStatsCollector

Called when query with given parameters is performed

Specified by:

doneQuery in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

fromKey - the start value (excluding)

toKey - the end value (excluding)

indexedProperty - true if indexedProperty was specified

resultSize - number of documents found for given query

lockTime - time in millis to acquire any lock (-1 if no lock was required)

isSlaveOk - true if find was performed against a secondary instance

doneCreate

public void doneCreate(long timeTakenNanos,
 Collection<? extends Document> collection,
 List<String> ids,
 boolean insertSuccess)

Description copied from interface: DocumentStoreStatsCollector

Called when a document is created in the given collection

Specified by:

doneCreate in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

ids - list of ids request to be created

insertSuccess - true if the insert was successful

doneCreateOrUpdate

public void doneCreateOrUpdate(long timeTakenNanos,
 Collection<? extends Document> collection,
 List<String> ids)

Description copied from interface: DocumentStoreStatsCollector

Called when multiple document are either created or updated.

Specified by:

doneCreateOrUpdate in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

ids - list of ids request to be created or updated

doneFindAndModify

public void doneFindAndModify(long timeTakenNanos,
 Collection<? extends Document> collection,
 String key,
 boolean newEntry,
 boolean success,
 int retryCount)

Description copied from interface: DocumentStoreStatsCollector

Called when a update operation was completed which affected single document.

Specified by:

doneFindAndModify in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

key - collection which got updated or inserted

newEntry - true if the document was newly created due to given operation

success - true if the update was success

retryCount - number of retries done to get the update

doneFindAndModify

public void doneFindAndModify(long timeTakenNanos,
 Collection<? extends Document> collection,
 List<String> ids,
 boolean success,
 int retryCount)

Description copied from interface: DocumentStoreStatsCollector

Called when a update operation was completed which could have affected multiple documents.

Specified by:

doneFindAndModify in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

ids - List of document ids which got updated

success - true if the update was success

retryCount - number of retries done to get the update

doneRemove

public void doneRemove(long timeTakenNanos,
 Collection<? extends Document> collection,
 int removeCount)

Description copied from interface: DocumentStoreStatsCollector

Called when a remove operation for documents was completed.

Specified by:

doneRemove in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

removeCount - the number of removed documents

donePrefetch

public void donePrefetch(long timeTakenNanos,
 Collection<? extends Document> collection,
 List<String> ids)

Description copied from interface: DocumentStoreStatsCollector

Called when a prefetch operation for documents was completed.

Specified by:

donePrefetch in interface DocumentStoreStatsCollector

Parameters:

timeTakenNanos - time taken

collection - the collection

ids - list of IDs to prefetch / read

getNodesFindCount

public long getNodesFindCount()

Specified by:

getNodesFindCount in interface DocumentStoreStatsMBean

getNodesFindQueryCount

public long getNodesFindQueryCount()

Specified by:

getNodesFindQueryCount in interface DocumentStoreStatsMBean

getNodesFindMissingCount

public long getNodesFindMissingCount()

Specified by:

getNodesFindMissingCount in interface DocumentStoreStatsMBean

getNodesReadByQueryCount

public long getNodesReadByQueryCount()

Specified by:

getNodesReadByQueryCount in interface DocumentStoreStatsMBean

getNodesCreateCount

public long getNodesCreateCount()

Specified by:

getNodesCreateCount in interface DocumentStoreStatsMBean

getNodesUpdateCount

public long getNodesUpdateCount()

Specified by:

getNodesUpdateCount in interface DocumentStoreStatsMBean

getNodesRemoveCount

public long getNodesRemoveCount()

Specified by:

getNodesRemoveCount in interface DocumentStoreStatsMBean

getJournalCreateCount

public long getJournalCreateCount()

Specified by:

getJournalCreateCount in interface DocumentStoreStatsMBean

getJournalReadCount

public long getJournalReadCount()

Specified by:

getJournalReadCount in interface DocumentStoreStatsMBean

getNodesPrefetchCount

public long getNodesPrefetchCount()

Specified by:

getNodesPrefetchCount in interface DocumentStoreStatsMBean

getFindCachedNodesHistory

public CompositeData getFindCachedNodesHistory()

Specified by:

getFindCachedNodesHistory in interface DocumentStoreStatsMBean

getFindSplitNodesHistory

public CompositeData getFindSplitNodesHistory()

Specified by:

getFindSplitNodesHistory in interface DocumentStoreStatsMBean

getFindNodesFromPrimaryHistory

public CompositeData getFindNodesFromPrimaryHistory()

Specified by:

getFindNodesFromPrimaryHistory in interface DocumentStoreStatsMBean

getFindNodesFromSlaveHistory

public CompositeData getFindNodesFromSlaveHistory()

Specified by:

getFindNodesFromSlaveHistory in interface DocumentStoreStatsMBean

getFindNodesMissingHistory

public CompositeData getFindNodesMissingHistory()

Specified by:

getFindNodesMissingHistory in interface DocumentStoreStatsMBean

getQueryNodesFromSlaveHistory

public CompositeData getQueryNodesFromSlaveHistory()

Specified by:

getQueryNodesFromSlaveHistory in interface DocumentStoreStatsMBean

getQueryNodesFromPrimaryHistory

public CompositeData getQueryNodesFromPrimaryHistory()

Specified by:

getQueryNodesFromPrimaryHistory in interface DocumentStoreStatsMBean

getQueryNodesLockHistory

public CompositeData getQueryNodesLockHistory()

Specified by:

getQueryNodesLockHistory in interface DocumentStoreStatsMBean

getQueryJournalHistory

public CompositeData getQueryJournalHistory()

Specified by:

getQueryJournalHistory in interface DocumentStoreStatsMBean

getCreateJournalHistory

public CompositeData getCreateJournalHistory()

Specified by:

getCreateJournalHistory in interface DocumentStoreStatsMBean

getCreateNodesHistory

public CompositeData getCreateNodesHistory()

Specified by:

getCreateNodesHistory in interface DocumentStoreStatsMBean

getUpdateNodesHistory

public CompositeData getUpdateNodesHistory()

Specified by:

getUpdateNodesHistory in interface DocumentStoreStatsMBean

getUpdateNodesRetryHistory

public CompositeData getUpdateNodesRetryHistory()

Specified by:

getUpdateNodesRetryHistory in interface DocumentStoreStatsMBean

getUpdateNodesFailureHistory

public CompositeData getUpdateNodesFailureHistory()

Specified by:

getUpdateNodesFailureHistory in interface DocumentStoreStatsMBean

getRemoveNodesHistory

public CompositeData getRemoveNodesHistory()

Specified by:

getRemoveNodesHistory in interface DocumentStoreStatsMBean

getPrefetchNodesHistory

public CompositeData getPrefetchNodesHistory()

Specified by:

getPrefetchNodesHistory in interface DocumentStoreStatsMBean