org.apache.jackrabbit.oak.plugins.segment.file

Class FileStoreGCMonitor

java.lang.Object

javax.management.StandardMBean

org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

org.apache.jackrabbit.oak.plugins.segment.file.FileStoreGCMonitor

All Implemented Interfaces:

Runnable, DynamicMBean, MBeanRegistration, GCMonitorMBean, GCMonitor

public class FileStoreGCMonitor
extends AnnotatedStandardMBean
implements GCMonitor, GCMonitorMBean, Runnable

GCMonitor implementation providing the file store gc status as GCMonitorMBean.

Users of this class need to schedule a call to run() once per second to ensure the various time series maintained by this implementation are correctly aggregated.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

GCMonitor.Empty

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

EMPTY

Fields inherited from interface org.apache.jackrabbit.oak.plugins.segment.file.GCMonitorMBean

TYPE

Constructor Summary

Constructors

Constructor and Description
FileStoreGCMonitor(Clock clock)

Method Summary

Modifier and Type	Method and Description
void	cleaned(long reclaimed, long current) The cleanup phase of the garbage collection process terminated successfully.
void	compacted(long[] segmentCounts, long[] recordCounts, long[] compactionMapWeights) The compaction phase of the garbage collection process terminated successfully.
void	error(String message, Exception exception) An error caused the garbage collection process to terminate prematurely.
String	getCompactionMapStats() Statistics about the compaction map.
String	getLastCleanup()
String	getLastCompaction()
String	getLastError()
CompositeData	getReclaimedSize()
CompositeData	getRepositorySize()
String	getStatus()
void	info(String message, Object... arguments) Informal notification on the progress of garbage collection.
void	run()
void	skipped(String reason, Object... arguments) A garbage collection cycle is skipped for a specific reason.
void	warn(String message, Object... arguments) Warning about a condition that might have advert effects on the overall garbage collection process but does not prevent the process from running.

Methods inherited from class javax.management.StandardMBean

getAttribute, getAttributes, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStoreGCMonitor

public FileStoreGCMonitor(Clock clock)

Method Detail

run

public void run()

Specified by:

run in interface Runnable

info

public void info(String message,
                 Object... arguments)

Description copied from interface: GCMonitor

Informal notification on the progress of garbage collection.

Specified by:

info in interface GCMonitor

Parameters:

message - The message with {} place holders for the arguments

warn

public void warn(String message,
                 Object... arguments)

Description copied from interface: GCMonitor

Warning about a condition that might have advert effects on the overall garbage collection process but does not prevent the process from running.

Specified by:

warn in interface GCMonitor

Parameters:

message - The message with {} place holders for the arguments

error

public void error(String message,
                  Exception exception)

Description copied from interface: GCMonitor

An error caused the garbage collection process to terminate prematurely.

Specified by:

error in interface GCMonitor

skipped

public void skipped(String reason,
                    Object... arguments)

Description copied from interface: GCMonitor

A garbage collection cycle is skipped for a specific reason.

Specified by:

skipped in interface GCMonitor

Parameters:

reason - The reason with {} place holders for the arguments

compacted

public void compacted(long[] segmentCounts,
                      long[] recordCounts,
                      long[] compactionMapWeights)

Description copied from interface: GCMonitor

The compaction phase of the garbage collection process terminated successfully.

Specified by:

compacted in interface GCMonitor

Parameters:

segmentCounts - number of segments in the individual generations of the map

recordCounts - number of records in the individual generations of the map

compactionMapWeights - weights of the individual generations of the map

See Also:

PartialCompactionMap

cleaned

public void cleaned(long reclaimed,
                    long current)

Description copied from interface: GCMonitor

The cleanup phase of the garbage collection process terminated successfully.

Specified by:

cleaned in interface GCMonitor

Parameters:

reclaimed - number of bytes reclaimed

current - number of bytes after garbage collection

getLastCompaction

public String getLastCompaction()

Specified by:

getLastCompaction in interface GCMonitorMBean

Returns:

timestamp of the last compaction or null if none.

getLastCleanup

public String getLastCleanup()

Specified by:

getLastCleanup in interface GCMonitorMBean

Returns:

timestamp of the last cleanup or null if none.

getLastError

public String getLastError()

Specified by:

getLastError in interface GCMonitorMBean

Returns:

last error or null if none.

getStatus

public String getStatus()

Specified by:

getStatus in interface GCMonitorMBean

Returns:

current status.

getCompactionMapStats

public String getCompactionMapStats()

Description copied from interface: GCMonitorMBean

Statistics about the compaction map.

Specified by:

getCompactionMapStats in interface GCMonitorMBean

getRepositorySize

public CompositeData getRepositorySize()

Specified by:

getRepositorySize in interface GCMonitorMBean

Returns:

time series of the repository size

getReclaimedSize

public CompositeData getReclaimedSize()

Specified by:

getReclaimedSize in interface GCMonitorMBean

Returns:

time series of the reclaimed space