Package com.attivio.sysstate

Interface MetricsCollector

public interface MetricsCollector

An interface describing generic metrics collection at the component level.

Implementations must be thread safe.

Method Summary

Modifier and Type	Method	Description
void	clearCollectedMetrics()	Call this method when when you would like the clear the contents of the metrics collected.
BaseTypesMap<java.lang.String,java.lang.Object>	getCollectedMetrics()	Call this method when the Metrics collection is ready to be consumed.
void	startProcessingDocument(PlatformMessage msg, IngestDocument doc)	Call this method when this MetricsCollector's component starts processing a document.
void	stopProcessingDocument(PlatformMessage msg, IngestDocument doc, long timeSpentProcessingDocument)	Call this method when this MetricsCollector's component stops processing a document.

Method Detail

startProcessingDocument

void startProcessingDocument(PlatformMessage msg,
                             IngestDocument doc)

Call this method when this MetricsCollector's component starts processing a document.

stopProcessingDocument

void stopProcessingDocument(PlatformMessage msg,
                            IngestDocument doc,
                            long timeSpentProcessingDocument)

Call this method when this MetricsCollector's component stops processing a document.

getCollectedMetrics

BaseTypesMap<java.lang.String,java.lang.Object> getCollectedMetrics()

Call this method when the Metrics collection is ready to be consumed. The return value is generic enough to be adapted for a variety of data structures.

clearCollectedMetrics

void clearCollectedMetrics()

Call this method when when you would like the clear the contents of the metrics collected.