org.apache.hadoop.fs.s3a

Class S3AInstrumentation.InputStreamStatistics

java.lang.Object

org.apache.hadoop.fs.s3a.S3AInstrumentation.InputStreamStatistics

All Implemented Interfaces:

AutoCloseable

Enclosing class:

S3AInstrumentation

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public final class S3AInstrumentation.InputStreamStatistics
extends Object
implements AutoCloseable

Statistics updated by an input stream during its actual operation. These counters not thread-safe and are for use in a single instance of a stream.

Field Summary

Fields

Modifier and Type	Field and Description
long	aborted
long	backwardSeekOperations
long	bytesBackwardsOnSeek
long	bytesDiscardedInAbort
long	bytesRead
long	bytesReadInClose
long	bytesSkippedOnSeek
long	closed
long	closeOperations
long	forwardSeekOperations
long	inputPolicy
long	openOperations
long	policySetCount
long	readExceptions
long	readFullyOperations
long	readOperations
long	readsIncomplete
long	seekOperations

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	close() Close triggers the merge of statistics into the filesystem's instrumentation instance.
AtomicLong	getVersionMismatchCounter() Get a reference to the version mismatch counter.
void	inputPolicySet(int updatedPolicy) The input policy has been switched.
void	readException() An ignored stream read exception was received.
void	readFullyOperationStarted(long pos, long len) A PositionedRead.read(position, buffer, offset, length) operation has just started.
void	readOperationCompleted(int requested, int actual) A read operation has completed.
void	readOperationStarted(long pos, long len) A read(byte[] buf, int off, int len) operation has started.
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	streamClose(boolean abortedConnection, long remainingInCurrentRequest) The inner stream was closed.
long	streamOpened() The inner stream was opened.
String	toString() String operator describes all the current statistics.

Methods inherited from class java.lang.Object

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

Field Detail

openOperations

public long openOperations

closeOperations

public long closeOperations

closed

public long closed

aborted

public long aborted

seekOperations

public long seekOperations

readExceptions

public long readExceptions

forwardSeekOperations

public long forwardSeekOperations

backwardSeekOperations

public long backwardSeekOperations

bytesRead

public long bytesRead

bytesSkippedOnSeek

public long bytesSkippedOnSeek

bytesBackwardsOnSeek

public long bytesBackwardsOnSeek

readOperations

public long readOperations

readFullyOperations

public long readFullyOperations

readsIncomplete

public long readsIncomplete

bytesReadInClose

public long bytesReadInClose

bytesDiscardedInAbort

public long bytesDiscardedInAbort

policySetCount

public long policySetCount

inputPolicy

public long inputPolicy

Method Detail

seekBackwards

public 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

public 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.

streamOpened

public long streamOpened()

The inner stream was opened.

Returns:

the previous count

streamClose

public void streamClose(boolean abortedConnection,
                        long remainingInCurrentRequest)

The inner stream was closed.

Parameters:

abortedConnection - flag to indicate the stream was aborted, rather than closed cleanly

remainingInCurrentRequest - the number of bytes remaining in the current request.

readException

public void readException()

An ignored stream read exception was received.

bytesRead

public 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

readOperationStarted

public void readOperationStarted(long pos,
                                 long len)

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

Parameters:

pos - starting position of the read

len - length of bytes to read

readFullyOperationStarted

public void readFullyOperationStarted(long pos,
                                      long len)

A PositionedRead.read(position, buffer, offset, length) operation has just started.

Parameters:

pos - starting position of the read

len - length of bytes to read

readOperationCompleted

public void readOperationCompleted(int requested,
                                   int actual)

A read operation has completed.

Parameters:

requested - number of requested bytes

actual - the actual number of bytes

close

public void close()

Close triggers the merge of statistics into the filesystem's instrumentation instance.

Specified by:

close in interface AutoCloseable

inputPolicySet

public void inputPolicySet(int updatedPolicy)

The input policy has been switched.

Parameters:

updatedPolicy - enum value of new policy.

getVersionMismatchCounter

public AtomicLong getVersionMismatchCounter()

Get a reference to the version mismatch counter.

Returns:

a counter which can be incremented.

toString

@InterfaceStability.Unstable
public String toString()

String operator describes all the current statistics. Important: there are no guarantees as to the stability of this value.

Overrides:

toString in class Object

Returns:

the current values of the stream statistics.