org.hbase.async

Class RegionClientStats

java.lang.Object

org.hbase.async.RegionClientStats

public final class RegionClientStats
extends Object

RegionClient usage statistics.

This is an immutable snapshot of usage statistics of the region client. Please note that not all the numbers in the snapshot are collected atomically, so although each individual number is up-to-date as of the time this object is created, small inconsistencies between numbers can arise.

Since:

1.7

Method Summary

Modifier and Type	Method and Description
long	inflightBreached() The number of times RPCs were rejected due to there being too many RPCs in flight and waiting for responses from the HBase server.
int	inflightRPCs() Represents the number of RPCs that have been sent to the region client and are currently waiting for a response.
boolean	isDead() Whether or not this region client has been marked as dead and should not be used for requests.
int	pendingBatchedRPCs() The number of batched RPCs waiting to be sent to the server.
long	pendingBreached() The number of times RPCs were rejected due to there being too many RPCs in the pending queue, i.e.
int	pendingRPCs() The number of RPCs that are queued up and ready to be sent to the region server.
String	remoteEndpoint() The remote endpoint of the region server this client is connecting to.
long	rpcID() The current RPC ID.
long	rpcResponsesTimedout() Represents the number of responses that were received from HBase for RPCs that were already timed out by the client.
long	rpcResponsesUnknown() Represents the number of responses that were received from HBase that were for RPCs the region client supposedly did not send.
long	rpcsSent() Represents the total number of RPCs sent from this client to the server, whether they were successful or not.
long	rpcsTimedout() The number of RPCs that timed out due to not receiving a response from HBase in a configurable amount of time.
long	writesBlocked() The number of times sending an RPC was blocked due to the socket send buffer being full.

Methods inherited from class java.lang.Object

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

Method Detail

rpcsSent

public long rpcsSent()

Represents the total number of RPCs sent from this client to the server, whether they were successful or not.

Returns:

The number of RPCs sent over TCP to the server

inflightRPCs

public int inflightRPCs()

Represents the number of RPCs that have been sent to the region client and are currently waiting for a response. If this value increases then the region server is likely overloaded.

Returns:

the number of RPCs sent to region client waiting for response.

pendingRPCs

public int pendingRPCs()

The number of RPCs that are queued up and ready to be sent to the region server. When an RPC is sent, this number should be decremented and rpcsInFlight incremented.

Returns:

the number of RPCs queued and ready to be sent to region server.

rpcID

public long rpcID()

The current RPC ID. This can be used to track the number of RPC requests sent from this region client. Note that the counter is initialized at -1 when a new client has been instantiated but no RPCs sent. It increments from there and may rollover quickly, returning negative values. This is acceptable as HBase doesn't care about the RPC ID as long as it's unique.

Returns:

the current RPC ID.

isDead

public boolean isDead()

Whether or not this region client has been marked as dead and should not be used for requests. This likely means the host or server has failed or we simply can't connect any more.

Returns:

whether this region client has been marked as dead and should not be used for requests.

remoteEndpoint

public String remoteEndpoint()

The remote endpoint of the region server this client is connecting to.

Returns:

the host name (or IP address) of the region server this client is connecting to.

pendingBatchedRPCs

public int pendingBatchedRPCs()

The number of batched RPCs waiting to be sent to the server.

Returns:

the number of batched RPCs waiting to be sent to the server.

rpcsTimedout

public long rpcsTimedout()

The number of RPCs that timed out due to not receiving a response from HBase in a configurable amount of time.

Returns:

The number of RPCs timedout

writesBlocked

public long writesBlocked()

The number of times sending an RPC was blocked due to the socket send buffer being full. This means HBase was not consuming RPCs fast enough.

Returns:

The number of writes blocked due to a full buffer.

rpcResponsesTimedout

public long rpcResponsesTimedout()

Represents the number of responses that were received from HBase for RPCs that were already timed out by the client. A fairly high number means HBase is busy but recovered.

Returns:

The number of late responses received from HBase

rpcResponsesUnknown

public long rpcResponsesUnknown()

Represents the number of responses that were received from HBase that were for RPCs the region client supposedly did not send. This means something really strange happened, i.e. we had a corrupt packet or HBase is sending responses for another connection.

Returns:

The number of unknown responses from HBase

inflightBreached

public long inflightBreached()

The number of times RPCs were rejected due to there being too many RPCs in flight and waiting for responses from the HBase server. Failed RPCs throw a PleaseThrottleException

Returns:

The number of times we rejected RPCs due to a full inflight queue.

pendingBreached

public long pendingBreached()

The number of times RPCs were rejected due to there being too many RPCs in the pending queue, i.e. while we were waiting for HBase to respond to the connection request. Failed RPCs throw a PleaseThrottleException

Returns:

The number of times we rejected RPCs due to a full pending queue.