Package org.apache.jackrabbit.oak.segment.file

Class MetricsIOMonitor

java.lang.Object

org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitorAdapter

org.apache.jackrabbit.oak.segment.file.MetricsIOMonitor

All Implemented Interfaces:

IOMonitor

public class MetricsIOMonitor
extends IOMonitorAdapter

This IOMonitor implementations registers the following monitoring endpoints with the Metrics library if available:

• OAK_SEGMENT_SEGMENT_READ_BYTES: a meter metrics for the number of bytes read from tar files
• OAK_SEGMENT_SEGMENT_WRITE_BYTES: a meter metrics for the number of bytes written to tar files
• OAK_SEGMENT_SEGMENT_READ_TIME: a timer metrics for the time spent reading from tar files
• OAK_SEGMENT_SEGMENT_WRITE_TIME: a timer metrics for the time spent writing to tar files

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OAK_SEGMENT_SEGMENT_READ_BYTES
static final String	OAK_SEGMENT_SEGMENT_READ_TIME
static final String	OAK_SEGMENT_SEGMENT_WRITE_BYTES
static final String	OAK_SEGMENT_SEGMENT_WRITE_TIME

Constructor Summary

Constructors

Constructor	Description
MetricsIOMonitor(@NotNull StatisticsProvider statisticsProvider)

Method Summary

Modifier and Type	Method	Description
void	afterSegmentRead(File file, long msb, long lsb, int length, long elapsed)	Called after a segment is read from the file system.
void	afterSegmentWrite(File file, long msb, long lsb, int length, long elapsed)	Called after a segment is written to the file system.

Methods inherited from class org.apache.jackrabbit.oak.segment.spi.monitor.IOMonitorAdapter

beforeSegmentRead, beforeSegmentWrite

Methods inherited from class java.lang.Object

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

Field Details

OAK_SEGMENT_SEGMENT_READ_BYTES

public static final String OAK_SEGMENT_SEGMENT_READ_BYTES

See Also:

• Constant Field Values

OAK_SEGMENT_SEGMENT_WRITE_BYTES

public static final String OAK_SEGMENT_SEGMENT_WRITE_BYTES

See Also:

• Constant Field Values

OAK_SEGMENT_SEGMENT_READ_TIME

public static final String OAK_SEGMENT_SEGMENT_READ_TIME

See Also:

• Constant Field Values

OAK_SEGMENT_SEGMENT_WRITE_TIME

public static final String OAK_SEGMENT_SEGMENT_WRITE_TIME

See Also:

• Constant Field Values

Constructor Details

MetricsIOMonitor

public MetricsIOMonitor(@NotNull
 @NotNull StatisticsProvider statisticsProvider)

Method Details

afterSegmentRead

public void afterSegmentRead(File file,
 long msb,
 long lsb,
 int length,
 long elapsed)

Description copied from interface: IOMonitor

Called after a segment is read from the file system. This is called only in case of successful operations.

Specified by:

afterSegmentRead in interface IOMonitor

Overrides:

afterSegmentRead in class IOMonitorAdapter

Parameters:

file - File containing the segment.

msb - Most significant bits of the segment ID.

lsb - Least significant bits of the segment ID.

length - Size of the segment.

elapsed - Time spent by the read operation, in nanoseconds.

afterSegmentWrite

public void afterSegmentWrite(File file,
 long msb,
 long lsb,
 int length,
 long elapsed)

Description copied from interface: IOMonitor

Called after a segment is written to the file system. This is called only in case of successful operations.

Specified by:

afterSegmentWrite in interface IOMonitor

Overrides:

afterSegmentWrite in class IOMonitorAdapter

Parameters:

file - File containing the segment.

msb - Most significant bits of the segment ID.

lsb - Least significant bits of the segment ID.

length - Size of the segment.

elapsed - Time spent by the write operation, in nanoseconds.