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, org.apache.jackrabbit.oak.spi.gc.GCMonitor

public class FileStoreGCMonitor
extends org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean
implements org.apache.jackrabbit.oak.spi.gc.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

org.apache.jackrabbit.oak.spi.gc.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(org.apache.jackrabbit.oak.stats.Clock clock)

Method Summary

Methods

Modifier and Type	Method and Description
void	cleaned(long reclaimed, long current)
void	compacted(long[] segmentCounts, long[] recordCounts, long[] compactionMapWeights)
void	error(String message, Exception exception)
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)
void	run()
void	skipped(String reason, Object... arguments)
void	warn(String message, Object... arguments)

Methods inherited from class org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

getDescription, getDescription, getDescription, getDescription, getImpact, getParameterName

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStoreGCMonitor

public FileStoreGCMonitor(@Nonnull
                  org.apache.jackrabbit.oak.stats.Clock clock)

Method Detail

run

public void run()

Specified by:

run in interface Runnable

info

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

Specified by:

info in interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

warn

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

Specified by:

warn in interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

error

public void error(String message,
         Exception exception)

Specified by:

error in interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

skipped

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

Specified by:

skipped in interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

compacted

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

Specified by:

compacted in interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

cleaned

public void cleaned(long reclaimed,
           long current)

Specified by:

cleaned in interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

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

@Nonnull
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

@Nonnull
public CompositeData getRepositorySize()

Specified by:

getRepositorySize in interface GCMonitorMBean

Returns:

time series of the repository size

getReclaimedSize

@Nonnull
public CompositeData getReclaimedSize()

Specified by:

getReclaimedSize in interface GCMonitorMBean

Returns:

time series of the reclaimed space