Package org.apache.hadoop.ipc.metrics

Class RpcMetrics

java.lang.Object

org.apache.hadoop.ipc.metrics.RpcMetrics

@Private
@Metrics(about="Aggregate RPC metrics",
         context="rpc")
public class RpcMetrics
extends java.lang.Object

This class is for maintaining the various RPC statistics and publishing them through the metrics interfaces.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.concurrent.TimeUnit	DEFAULT_METRIC_TIME_UNIT

Method Summary

Modifier and Type	Method	Description
void	addDeferredRpcProcessingTime(long processingTime)
void	addRpcEnQueueTime(long enQTime)	Sometimes, the request time observed by the client is much longer than the queue + process time on the RPC server.Perhaps the RPC request 'waiting enQueue' took too long on the RPC server, so we should add enQueue time to RpcMetrics.
void	addRpcLockWaitTime(long waitTime)
void	addRpcProcessingTime(long processingTime)	Add an RPC processing time sample
void	addRpcQueueTime(long qTime)	Add an RPC queue time sample
void	addRpcResponseTime(long responseTime)
int	callQueueLength()
static RpcMetrics	create(Server server, Configuration conf)
long	getClientBackoffDisconnected()	Returns the number of disconnected backoffs.
double	getDeferredRpcProcessingMean()
long	getDeferredRpcProcessingSampleCount()
double	getDeferredRpcProcessingStdDev()
MutableRate	getDeferredRpcProcessingTime()
java.util.concurrent.TimeUnit	getMetricsTimeUnit()
static java.util.concurrent.TimeUnit	getMetricsTimeUnit(Configuration conf)
int	getNumInProcessHandler()
double	getProcessingMean()	Returns mean of RPC Processing Times.
long	getProcessingSampleCount()	Returns the number of samples that we have seen so far.
double	getProcessingStdDev()	Return Standard Deviation of the Processing Time.
MutableCounterLong	getRpcAuthorizationSuccesses()
MutableRate	getRpcProcessingTime()	Returns a MutableRate Counter.
long	getRpcRequeueCalls()	Returns the number of requeue calls.
long	getRpcSlowCalls()	Returns the number of slow calls.
MetricsTag	getTag(java.lang.String tagName)
long	getTotalRequests()
long	getTotalRequestsPerSecond()
void	incrAuthenticationFailures()	One authentication failure event
void	incrAuthenticationSuccesses()	One authentication success event
void	incrAuthorizationFailures()	One authorization failure event
void	incrAuthorizationSuccesses()	One authorization success event
void	incrClientBackoff()	One client backoff event
void	incrClientBackoffDisconnected()	Client was disconnected due to backoff
void	incrReceivedBytes(int count)	Increment received bytes by count
void	incrRequeueCalls()	Increments the Requeue Calls counter.
void	incrRpcCallSuccesses()	One RPC call success event.
void	incrSentBytes(int count)	Increment sent bytes by count
void	incrSlowRpc()	Increments the Slow RPC counter.
java.lang.String	name()
long	numDroppedConnections()
int	numOpenConnections()
java.lang.String	numOpenConnectionsPerUser()
void	shutdown()	Shutdown the instrumentation for the process

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_METRIC_TIME_UNIT

public static final java.util.concurrent.TimeUnit DEFAULT_METRIC_TIME_UNIT

Method Detail

name

public java.lang.String name()

create

public static RpcMetrics create(Server server,
                                Configuration conf)

numOpenConnections

@Metric("Number of open connections")
public int numOpenConnections()

getNumInProcessHandler

@Metric("Number of in process handlers")
public int getNumInProcessHandler()

numOpenConnectionsPerUser

@Metric("Number of open connections per user")
public java.lang.String numOpenConnectionsPerUser()

callQueueLength

@Metric("Length of the call queue")
public int callQueueLength()

numDroppedConnections

@Metric("Number of dropped connections")
public long numDroppedConnections()

getTotalRequests

@Metric("Number of total requests")
public long getTotalRequests()

getTotalRequestsPerSecond

@Metric("Number of total requests per second")
public long getTotalRequestsPerSecond()

getMetricsTimeUnit

public java.util.concurrent.TimeUnit getMetricsTimeUnit()

getMetricsTimeUnit

public static java.util.concurrent.TimeUnit getMetricsTimeUnit(Configuration conf)

incrAuthenticationFailures

public void incrAuthenticationFailures()

One authentication failure event

incrAuthenticationSuccesses

public void incrAuthenticationSuccesses()

One authentication success event

incrAuthorizationSuccesses

public void incrAuthorizationSuccesses()

One authorization success event

incrAuthorizationFailures

public void incrAuthorizationFailures()

One authorization failure event

shutdown

public void shutdown()

Shutdown the instrumentation for the process

incrSentBytes

public void incrSentBytes(int count)

Increment sent bytes by count

Parameters:

count - to increment

incrReceivedBytes

public void incrReceivedBytes(int count)

Increment received bytes by count

Parameters:

count - to increment

addRpcEnQueueTime

public void addRpcEnQueueTime(long enQTime)

Sometimes, the request time observed by the client is much longer than the queue + process time on the RPC server.Perhaps the RPC request 'waiting enQueue' took too long on the RPC server, so we should add enQueue time to RpcMetrics. See HADOOP-18840 for details. Add an RPC enqueue time sample

Parameters:

enQTime - the queue time

addRpcQueueTime

public void addRpcQueueTime(long qTime)

Add an RPC queue time sample

Parameters:

qTime - the queue time

addRpcLockWaitTime

public void addRpcLockWaitTime(long waitTime)

addRpcProcessingTime

public void addRpcProcessingTime(long processingTime)

Add an RPC processing time sample

Parameters:

processingTime - the processing time

addRpcResponseTime

public void addRpcResponseTime(long responseTime)

addDeferredRpcProcessingTime

public void addDeferredRpcProcessingTime(long processingTime)

incrClientBackoff

public void incrClientBackoff()

One client backoff event

incrClientBackoffDisconnected

public void incrClientBackoffDisconnected()

Client was disconnected due to backoff

getClientBackoffDisconnected

public long getClientBackoffDisconnected()

Returns the number of disconnected backoffs.

Returns:

long

incrSlowRpc

public void incrSlowRpc()

Increments the Slow RPC counter.

incrRequeueCalls

public void incrRequeueCalls()

Increments the Requeue Calls counter.

incrRpcCallSuccesses

public void incrRpcCallSuccesses()

One RPC call success event.

getRpcProcessingTime

public MutableRate getRpcProcessingTime()

Returns a MutableRate Counter.

Returns:

Mutable Rate

getProcessingSampleCount

public long getProcessingSampleCount()

Returns the number of samples that we have seen so far.

Returns:

long

getProcessingMean

public double getProcessingMean()

Returns mean of RPC Processing Times.

Returns:

double

getProcessingStdDev

public double getProcessingStdDev()

Return Standard Deviation of the Processing Time.

Returns:

double

getRpcSlowCalls

public long getRpcSlowCalls()

Returns the number of slow calls.

Returns:

long

getRpcRequeueCalls

@VisibleForTesting
public long getRpcRequeueCalls()

Returns the number of requeue calls.

Returns:

long

getDeferredRpcProcessingTime

public MutableRate getDeferredRpcProcessingTime()

getDeferredRpcProcessingSampleCount

public long getDeferredRpcProcessingSampleCount()

getDeferredRpcProcessingMean

public double getDeferredRpcProcessingMean()

getDeferredRpcProcessingStdDev

public double getDeferredRpcProcessingStdDev()

getTag

@VisibleForTesting
public MetricsTag getTag(java.lang.String tagName)

getRpcAuthorizationSuccesses

@VisibleForTesting
public MutableCounterLong getRpcAuthorizationSuccesses()