org.apache.hadoop.fs.azurebfs.services

Interface AbfsInputStreamStatistics

All Superinterfaces:

org.apache.hadoop.fs.statistics.IOStatisticsSource

All Known Implementing Classes:

AbfsInputStreamStatisticsImpl

@InterfaceStability.Unstable
public interface AbfsInputStreamStatistics
extends org.apache.hadoop.fs.statistics.IOStatisticsSource

Interface for statistics for the AbfsInputStream.

Method Summary

Modifier and Type	Method and Description
void	bytesRead(long bytes) Increment the bytes read counter by the number of bytes; no-op if the argument is negative.
void	bytesReadFromBuffer(long bytes) Record the total bytes read from buffer.
org.apache.hadoop.fs.statistics.IOStatistics	getIOStatistics() Get the IOStatisticsStore instance from AbfsInputStreamStatistics.
void	readAheadBytesRead(long bytes) Records the bytes read from readAhead buffer.
void	readOperationStarted() A read(byte[] buf, int off, int len) operation has started.
void	remoteBytesRead(long bytes) Records bytes read remotely after nothing from readAheadBuffer was read.
void	remoteReadOperation() Records a successful remote read operation.
void	seek(long seekTo, long currentPos) Record a forward or backward seek, adding a seek operation, a forward or a backward seek operation, and number of bytes skipped.
void	seekBackwards(long negativeOffset) Seek backwards, incrementing the seek and backward seek counters.
void	seekForwards(long skipped) Record a forward seek, adding a seek operation, a forward seek operation, and any bytes skipped.
void	seekInBuffer() Records the total number of seeks done in the buffer.
String	toString() Makes the string of all the AbfsInputStream statistics.

Method Detail

seekBackwards

void seekBackwards(long negativeOffset)

Seek backwards, incrementing the seek and backward seek counters.

Parameters:

negativeOffset - how far was the seek? This is expected to be negative.

seekForwards

void seekForwards(long skipped)

Record a forward seek, adding a seek operation, a forward seek operation, and any bytes skipped.

Parameters:

skipped - number of bytes skipped by reading from the stream. If the seek was implemented by a close + reopen, set this to zero.

seek

void seek(long seekTo,
          long currentPos)

Record a forward or backward seek, adding a seek operation, a forward or a backward seek operation, and number of bytes skipped.

Parameters:

seekTo - seek to the position.

currentPos - current position.

bytesRead

void bytesRead(long bytes)

Increment the bytes read counter by the number of bytes; no-op if the argument is negative.

Parameters:

bytes - number of bytes read.

bytesReadFromBuffer

void bytesReadFromBuffer(long bytes)

Record the total bytes read from buffer.

Parameters:

bytes - number of bytes that are read from buffer.

seekInBuffer

void seekInBuffer()

Records the total number of seeks done in the buffer.

readOperationStarted

void readOperationStarted()

A read(byte[] buf, int off, int len) operation has started.

remoteReadOperation

void remoteReadOperation()

Records a successful remote read operation.

readAheadBytesRead

void readAheadBytesRead(long bytes)

Records the bytes read from readAhead buffer.

Parameters:

bytes - the bytes to be incremented.

remoteBytesRead

void remoteBytesRead(long bytes)

Records bytes read remotely after nothing from readAheadBuffer was read.

Parameters:

bytes - the bytes to be incremented.

getIOStatistics

org.apache.hadoop.fs.statistics.IOStatistics getIOStatistics()

Get the IOStatisticsStore instance from AbfsInputStreamStatistics.

Specified by:

getIOStatistics in interface org.apache.hadoop.fs.statistics.IOStatisticsSource

Returns:

instance of IOStatisticsStore which extends IOStatistics.

toString

String toString()

Makes the string of all the AbfsInputStream statistics.

Overrides:

toString in class Object

Returns:

the string with all the statistics.