Package org.apache.hadoop.ipc.metrics

Class RpcDetailedMetrics

java.lang.Object

org.apache.hadoop.ipc.metrics.RpcDetailedMetrics

@Private
@Metrics(about="Per method RPC metrics",
         context="rpcdetailed")
public class RpcDetailedMetrics
extends java.lang.Object

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

Method Summary

Modifier and Type	Method	Description
void	addDeferredProcessingTime(java.lang.String name, long processingTime)
void	addOverallProcessingTime(java.lang.String rpcCallName, long overallProcessingTime)	Add an overall RPC processing time sample.
void	addProcessingTime(java.lang.String rpcCallName, long processingTime)	Add an RPC processing time sample
static RpcDetailedMetrics	create(int port)
MutableRatesWithAggregation	getOverallRpcProcessingRates()
void	init(java.lang.Class<?> protocol)	Initialize the metrics for JMX with protocol methods
java.lang.String	name()
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

Method Detail

getOverallRpcProcessingRates

public MutableRatesWithAggregation getOverallRpcProcessingRates()

name

public java.lang.String name()

create

public static RpcDetailedMetrics create(int port)

init

public void init(java.lang.Class<?> protocol)

Initialize the metrics for JMX with protocol methods

Parameters:

protocol - the protocol class

addProcessingTime

public void addProcessingTime(java.lang.String rpcCallName,
                              long processingTime)

Add an RPC processing time sample

Parameters:

rpcCallName - of the RPC call

processingTime - the processing time

addDeferredProcessingTime

public void addDeferredProcessingTime(java.lang.String name,
                                      long processingTime)

addOverallProcessingTime

public void addOverallProcessingTime(java.lang.String rpcCallName,
                                     long overallProcessingTime)

Add an overall RPC processing time sample.

Parameters:

rpcCallName - of the RPC call

overallProcessingTime - the overall RPC processing time

shutdown

public void shutdown()

Shutdown the instrumentation for the process