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

Class ConsoleIndexingReporter

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.ConsoleIndexingReporter

All Implemented Interfaces:

IndexingReporter

public class ConsoleIndexingReporter
extends Object
implements IndexingReporter

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.plugins.index.IndexingReporter

NOOP

Constructor Summary

Constructors

Constructor	Description
ConsoleIndexingReporter()
ConsoleIndexingReporter(@NotNull List<String> envVariablesToLog)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleIndexingReporter

public ConsoleIndexingReporter()

ConsoleIndexingReporter

public ConsoleIndexingReporter(@NotNull
                               @NotNull List<String> envVariablesToLog)

Parameters:

envVariablesToLog - These environment variables and their values will be included in the final report.

Method Detail

setIndexNames

public void setIndexNames(@NotNull
                          @NotNull List<String> indexes)

Specified by:

setIndexNames in interface IndexingReporter

addConfig

public void addConfig(String key,
                      Object value)

Specified by:

addConfig in interface IndexingReporter

addTiming

public void addTiming(String stage,
                      String time)

Specified by:

addTiming in interface IndexingReporter

addMetric

public void addMetric(String name,
                      long value)

Specified by:

addMetric in interface IndexingReporter

addInformation

public void addInformation(String value)

Specified by:

addInformation in interface IndexingReporter

addMetricByteSize

public void addMetricByteSize(String name,
                              long value)

Description copied from interface: IndexingReporter

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

    foo.bar    123456789 (123 MiB)
  

Specified by:

addMetricByteSize in interface IndexingReporter

generateReport

public String generateReport()

Specified by:

generateReport in interface IndexingReporter