Package org.apache.jackrabbit.oak.spi.blob.stats

Interface BlobStatsCollector

All Known Subinterfaces:

ExtendedBlobStatsCollector

All Known Implementing Classes:

BlobStoreStats

@ConsumerType
public interface BlobStatsCollector

BlobStoreStatsCollector receives callback when blobs are written and read from BlobStore

Field Summary

Fields

Modifier and Type	Field	Description
static BlobStatsCollector	NOOP

Method Summary

Modifier and Type	Method	Description
void	addRecordCompleted(String blobId)	Called when a call to DataStore.addRecord(InputStream) is completed.
void	addRecordFailed()	Called when a call to DataStore.addRecord(InputStream) fails.
void	deleteAllOlderThanCompleted(int deletedCount)	Called when DataStore.deleteAllOlderThan(long) is completed.
void	deleteAllOlderThanFailed(long min)	Called when DataStore.deleteAllOlderThan(long) fails.
void	deleteCompleted(String blobId)	Called when deletion of a binary is completed.
void	deleted(String blobId, long timeTaken, TimeUnit unit)	Called when a binary is deleted from the BlobStore
void	deletedAllOlderThan(long timeTaken, TimeUnit unit, long min)	Called when deleting binaries older than a specified date, via DataStore.deleteAllOlderThan(long).
void	deleteFailed()	Called when deletion of a binary fails.
void	downloadCompleted(String blobId)	Invoked when download for a binary file get completed.
void	downloaded(String blobId, long timeTaken, TimeUnit unit, long size)	Called when a binary content is read from BlobStore
void	downloadFailed(String blobId)	Called when an attempt to download a binary file fails.
void	getAllIdentifiersCalled(long timeTaken, TimeUnit unit)	Called when DataStore.getAllIdentifiers() is called.
void	getAllIdentifiersCompleted()	Called when DataStore.getAllIdentifiers() is completed.
void	getAllIdentifiersFailed()	Called when DataStore.getAllIdentifiers() fails.
void	getRecordCalled(long timeTaken, TimeUnit unit, long size)	Called when a DataRecord is retrieved via DataStore.getRecord(DataIdentifier).
void	getRecordCompleted(String blobId)	Called when a call to DataStore.getRecord(DataIdentifier) is completed.
void	getRecordFailed(String blobId)	Called when a call to DataStore.getRecord(DataIdentifier) fails.
void	getRecordFromReferenceCalled(long timeTaken, TimeUnit unit, long size)	Called when a DataRecord is retrieved via DataStore.getRecordFromReference(String).
void	getRecordFromReferenceCompleted(String reference)	Called when a call to DataStore.getRecordFromReference(String) is completed.
void	getRecordFromReferenceFailed(String reference)	Called when a call to DataStore.getRecordFromReference(String) fails.
void	getRecordIfStoredCalled(long timeTaken, TimeUnit unit, long size)	Called when a DataRecord is retrieved via DataStore.getRecordIfStored(DataIdentifier).
void	getRecordIfStoredCompleted(String blobId)	Called when a call to DataStore.getRecordIfStored(DataIdentifier) is completed.
void	getRecordIfStoredFailed(String blobId)	Called when a call to DataStore.getRecordIfStored(DataIdentifier) fails.
void	recordAdded(long timeTaken, TimeUnit unit, long size)	Called when a binary is added via DataStore.addRecord(InputStream).
void	uploadCompleted(String blobId)	Invoked when upload for a binary file get completed.
void	uploaded(long timeTaken, TimeUnit unit, long size)	Called when a binary content is written to BlobStore
void	uploadFailed()	Invoked when an upload of a binary fails.

Field Detail

NOOP

static final BlobStatsCollector NOOP

Method Detail

uploaded

void uploaded(long timeTaken,
              TimeUnit unit,
              long size)

Called when a binary content is written to BlobStore

Parameters:

timeTaken - time taken to perform the operation

unit - unit of time taken

size - size of binary content being written

uploadCompleted

void uploadCompleted(String blobId)

Invoked when upload for a binary file get completed. In case of chunked BlobStore this invoked when all the chunks have been uploaded

Parameters:

blobId - id of the blob which got uploaded. Even in case of chunked blobStores its the id of main blob

uploadFailed

void uploadFailed()

Invoked when an upload of a binary fails.

downloaded

void downloaded(String blobId,
                long timeTaken,
                TimeUnit unit,
                long size)

Called when a binary content is read from BlobStore

Parameters:

blobId - id of blob whose content are being read. For BlobStore which break up file in chunks it would be chunkId

timeTaken - time taken to perform the operation

unit - unit of time taken

size - size of binary content being read

downloadCompleted

void downloadCompleted(String blobId)

Invoked when download for a binary file get completed. In case of chunked BlobStore this invoked when all the chunks have been downloaded

Parameters:

blobId - id of the blob which got downloaded. Even in case of chunked blobStores its the id of main blob

downloadFailed

void downloadFailed(String blobId)

Called when an attempt to download a binary file fails.

Parameters:

blobId - id of the blob for which the download failed

deleted

void deleted(String blobId,
             long timeTaken,
             TimeUnit unit)

Called when a binary is deleted from the BlobStore

Parameters:

blobId - id of blob being deleted

timeTaken - time taken to perform the delete

unit - unit of time taken

deleteCompleted

void deleteCompleted(String blobId)

Called when deletion of a binary is completed.

Parameters:

blobId - id of the blob which was deleted

deleteFailed

void deleteFailed()

Called when deletion of a binary fails.

deletedAllOlderThan

void deletedAllOlderThan(long timeTaken,
                         TimeUnit unit,
                         long min)

Called when deleting binaries older than a specified date, via DataStore.deleteAllOlderThan(long).

Parameters:

timeTaken - time taken to perform the deletion

unit - unit of time taken

min - time used for determining what to delete - older than this time gets deleted

deleteAllOlderThanCompleted

void deleteAllOlderThanCompleted(int deletedCount)

Called when DataStore.deleteAllOlderThan(long) is completed.

Parameters:

deletedCount - count of records deleted

deleteAllOlderThanFailed

void deleteAllOlderThanFailed(long min)

Called when DataStore.deleteAllOlderThan(long) fails.

Parameters:

min - time used for determining what to delete

recordAdded

void recordAdded(long timeTaken,
                 TimeUnit unit,
                 long size)

Called when a binary is added via DataStore.addRecord(InputStream).

Parameters:

timeTaken - time taken to perform the operation

unit - unit of time taken

size - size of binary content being read

addRecordCompleted

void addRecordCompleted(String blobId)

Called when a call to DataStore.addRecord(InputStream) is completed.

Parameters:

blobId - id of the record which was added

addRecordFailed

void addRecordFailed()

Called when a call to DataStore.addRecord(InputStream) fails.

getRecordCalled

void getRecordCalled(long timeTaken,
                     TimeUnit unit,
                     long size)

Called when a DataRecord is retrieved via DataStore.getRecord(DataIdentifier).

Parameters:

timeTaken - time taken to perform the operation

unit - unit of time taken

size - size of the binary

getRecordCompleted

void getRecordCompleted(String blobId)

Called when a call to DataStore.getRecord(DataIdentifier) is completed.

Parameters:

blobId - id of the record retrieved

getRecordFailed

void getRecordFailed(String blobId)

Called when a call to DataStore.getRecord(DataIdentifier) fails.

Parameters:

blobId - id of the record

getRecordIfStoredCalled

void getRecordIfStoredCalled(long timeTaken,
                             TimeUnit unit,
                             long size)

Called when a DataRecord is retrieved via DataStore.getRecordIfStored(DataIdentifier).

Parameters:

timeTaken - time taken to perform the operation

unit - unit of time taken

size - size of the binary

getRecordIfStoredCompleted

void getRecordIfStoredCompleted(String blobId)

Called when a call to DataStore.getRecordIfStored(DataIdentifier) is completed.

Parameters:

blobId - id of the record retrieved

getRecordIfStoredFailed

void getRecordIfStoredFailed(String blobId)

Called when a call to DataStore.getRecordIfStored(DataIdentifier) fails.

Parameters:

blobId - id of the record

getRecordFromReferenceCalled

void getRecordFromReferenceCalled(long timeTaken,
                                  TimeUnit unit,
                                  long size)

Called when a DataRecord is retrieved via DataStore.getRecordFromReference(String).

Parameters:

timeTaken - time taken to perform the operation

unit - unit of time taken

size - size of the binary

getRecordFromReferenceCompleted

void getRecordFromReferenceCompleted(String reference)

Called when a call to DataStore.getRecordFromReference(String) is completed.

Parameters:

reference - reference of the record retrieved

getRecordFromReferenceFailed

void getRecordFromReferenceFailed(String reference)

Called when a call to DataStore.getRecordFromReference(String) fails.

Parameters:

reference - reference of the record

getAllIdentifiersCalled

void getAllIdentifiersCalled(long timeTaken,
                             TimeUnit unit)

Called when DataStore.getAllIdentifiers() is called.

Parameters:

timeTaken - time taken to perform the operation

unit - unit of time taken

getAllIdentifiersCompleted

void getAllIdentifiersCompleted()

Called when DataStore.getAllIdentifiers() is completed.

getAllIdentifiersFailed

void getAllIdentifiersFailed()

Called when DataStore.getAllIdentifiers() fails.