Package org.apache.jackrabbit.oak.plugins.index

Interface IndexingReporter

All Known Implementing Classes:

ConsoleIndexingReporter

public interface IndexingReporter

Stores diagnostic and performance information about indexing operations for reporting at the end of the indexing job.

Field Summary

Fields

Modifier and Type	Field	Description
static IndexingReporter	NOOP

Method Summary

Modifier and Type	Method	Description
void	addConfig(java.lang.String key, java.lang.Object value)
void	addMetric(java.lang.String name, long value)
void	addMetricByteSize(java.lang.String name, long value)	Similar to addMetric(String, long) but size should be logged in a human-friendly format, that is, something like
void	addTiming(java.lang.String stage, java.lang.String time)
java.lang.String	generateReport()
void	setIndexNames(java.util.List<java.lang.String> indexes)

Field Detail

NOOP

static final IndexingReporter NOOP

Method Detail

setIndexNames

void setIndexNames(java.util.List<java.lang.String> indexes)

addConfig

void addConfig(java.lang.String key,
               java.lang.Object value)

addTiming

void addTiming(java.lang.String stage,
               java.lang.String time)

addMetric

void addMetric(java.lang.String name,
               long value)

addMetricByteSize

void addMetricByteSize(java.lang.String name,
                       long value)

Similar to addMetric(String, long) but size should be logged in a human-friendly format, that is, something like

    foo.bar    123456789 (123 MiB)
  

generateReport

java.lang.String generateReport()