MetricsConnection (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.client.MetricsConnection

All Implemented Interfaces:

StatisticTrackable
```
@InterfaceAudience.Private
public class MetricsConnection
extends Object
implements StatisticTrackable
```
This class is for maintaining the various connection statistics and publishing them through the metrics interfaces. This class manages its own MetricsRegistry and JmxReporter so as to not conflict with other uses of Yammer Metrics within the client application. Instantiating this class implicitly creates and "starts" instances of these classes; be sure to call shutdown() to terminate the thread pools they allocate.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetricsConnection.CallStats` A container class for collecting details about the RPC call as it percolates.
`protected static class`	`MetricsConnection.CallTracker`
`protected static class`	`MetricsConnection.RegionStats`
`protected static class`	`MetricsConnection.RunnerStats`

Field Summary

Fields
Modifier and Type	Field and Description
`protected MetricsConnection.CallTracker`	`appendTracker`
`static String`	`CLIENT_SIDE_METRICS_ENABLED_KEY` Set this key to `true` to enable metrics collection of client requests.
`protected com.yammer.metrics.core.Histogram`	`concurrentCallsPerServerHist`
`protected MetricsConnection.CallTracker`	`deleteTracker`
`protected MetricsConnection.CallTracker`	`getTracker`
`protected com.yammer.metrics.core.Counter`	`hedgedReadOps`
`protected com.yammer.metrics.core.Counter`	`hedgedReadWin`
`protected MetricsConnection.CallTracker`	`incrementTracker`
`protected com.yammer.metrics.core.Counter`	`metaCacheHits`
`protected com.yammer.metrics.core.Counter`	`metaCacheMisses`
`protected com.yammer.metrics.core.Counter`	`metaCacheNumClearRegion`
`protected com.yammer.metrics.core.Counter`	`metaCacheNumClearServer`
`protected MetricsConnection.CallTracker`	`multiTracker`
`protected MetricsConnection.CallTracker`	`putTracker`
`protected ConcurrentMap<String,com.yammer.metrics.core.Histogram>`	`rpcHistograms`
`protected ConcurrentMap<String,com.yammer.metrics.core.Timer>`	`rpcTimers`
`protected MetricsConnection.RunnerStats`	`runnerStats`
`protected MetricsConnection.CallTracker`	`scanTracker`
`protected ConcurrentHashMap<ServerName,ConcurrentMap<byte[],MetricsConnection.RegionStats>>`	`serverStats`

Constructor Summary

Constructors
Constructor and Description

MetricsConnection(org.apache.hadoop.hbase.client.ConnectionManager.HConnectionImplementation conn)

Constructors
Constructor and Description
`MetricsConnection(org.apache.hadoop.hbase.client.ConnectionManager.HConnectionImplementation conn)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`incrCacheDroppingExceptions(Object exception)`
`void`	`incrDelayRunners()` Increment the number of delay runner counts.
`void`	`incrHedgedReadOps()` Increment the number of hedged read that have occurred.
`void`	`incrHedgedReadWin()` Increment the number of hedged read returned faster than the original read.
`void`	`incrMetaCacheHit()` Increment the number of meta cache hits.
`void`	`incrMetaCacheMiss()` Increment the number of meta cache misses.
`void`	`incrMetaCacheNumClearRegion()` Increment the number of meta cache drops requested for individual region.
`void`	`incrMetaCacheNumClearServer()` Increment the number of meta cache drops requested for entire RegionServer.
`void`	`incrNormalRunners()` Increment the number of normal runner counts.
`static MetricsConnection.CallStats`	`newCallStats()` Produce an instance of `MetricsConnection.CallStats` for clients to attach to RPCs.
`void`	`shutdown()`
`void`	`updateDelayInterval(long interval)` Update delay interval of delay runner.
`void`	`updateRegionStats(ServerName serverName, byte[] regionName, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionLoadStats stats)` Update stats per region.
`void`	`updateRpc(com.google.protobuf.Descriptors.MethodDescriptor method, com.google.protobuf.Message param, MetricsConnection.CallStats stats)` Report RPC context to metrics system.
`void`	`updateServerStats(ServerName serverName, byte[] regionName, Object r)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLIENT_SIDE_METRICS_ENABLED_KEY
```
public static final String CLIENT_SIDE_METRICS_ENABLED_KEY
```
Set this key to true to enable metrics collection of client requests.

See Also:
Constant Field Values

serverStats

protected ConcurrentHashMap<ServerName,ConcurrentMap<byte[],MetricsConnection.RegionStats>> serverStats

metaCacheHits

protected final com.yammer.metrics.core.Counter metaCacheHits

metaCacheMisses

protected final com.yammer.metrics.core.Counter metaCacheMisses

getTracker

protected final MetricsConnection.CallTracker getTracker

scanTracker

protected final MetricsConnection.CallTracker scanTracker

appendTracker

protected final MetricsConnection.CallTracker appendTracker

deleteTracker

protected final MetricsConnection.CallTracker deleteTracker

incrementTracker

protected final MetricsConnection.CallTracker incrementTracker

putTracker

protected final MetricsConnection.CallTracker putTracker

multiTracker

protected final MetricsConnection.CallTracker multiTracker

runnerStats

protected final MetricsConnection.RunnerStats runnerStats

metaCacheNumClearServer

protected final com.yammer.metrics.core.Counter metaCacheNumClearServer

metaCacheNumClearRegion

protected final com.yammer.metrics.core.Counter metaCacheNumClearRegion

hedgedReadOps

protected final com.yammer.metrics.core.Counter hedgedReadOps

hedgedReadWin

protected final com.yammer.metrics.core.Counter hedgedReadWin

concurrentCallsPerServerHist

protected final com.yammer.metrics.core.Histogram concurrentCallsPerServerHist

rpcTimers

protected final ConcurrentMap<String,com.yammer.metrics.core.Timer> rpcTimers

rpcHistograms

protected final ConcurrentMap<String,com.yammer.metrics.core.Histogram> rpcHistograms

Constructor Detail

MetricsConnection

public MetricsConnection(org.apache.hadoop.hbase.client.ConnectionManager.HConnectionImplementation conn)

Method Detail

updateServerStats

public void updateServerStats(ServerName serverName,
                     byte[] regionName,
                     Object r)

updateRegionStats

public void updateRegionStats(ServerName serverName,
                     byte[] regionName,
                     org.apache.hadoop.hbase.protobuf.generated.ClientProtos.RegionLoadStats stats)

Description copied from interface: StatisticTrackable

Update stats per region.

Specified by:: updateRegionStats in interface StatisticTrackable

shutdown
```
public void shutdown()
```

newCallStats
```
public static MetricsConnection.CallStats newCallStats()
```
Produce an instance of MetricsConnection.CallStats for clients to attach to RPCs.

incrMetaCacheHit
```
public void incrMetaCacheHit()
```
Increment the number of meta cache hits.

incrMetaCacheMiss
```
public void incrMetaCacheMiss()
```
Increment the number of meta cache misses.

incrMetaCacheNumClearServer
```
public void incrMetaCacheNumClearServer()
```
Increment the number of meta cache drops requested for entire RegionServer.

incrMetaCacheNumClearRegion
```
public void incrMetaCacheNumClearRegion()
```
Increment the number of meta cache drops requested for individual region.

incrHedgedReadOps
```
public void incrHedgedReadOps()
```
Increment the number of hedged read that have occurred.

incrHedgedReadWin
```
public void incrHedgedReadWin()
```
Increment the number of hedged read returned faster than the original read.

incrNormalRunners
```
public void incrNormalRunners()
```
Increment the number of normal runner counts.

incrDelayRunners
```
public void incrDelayRunners()
```
Increment the number of delay runner counts.

updateDelayInterval
```
public void updateDelayInterval(long interval)
```
Update delay interval of delay runner.

updateRpc

public void updateRpc(com.google.protobuf.Descriptors.MethodDescriptor method,
             com.google.protobuf.Message param,
             MetricsConnection.CallStats stats)

Report RPC context to metrics system.

incrCacheDroppingExceptions

public void incrCacheDroppingExceptions(Object exception)

Class MetricsConnection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLIENT_SIDE_METRICS_ENABLED_KEY

serverStats

metaCacheHits

metaCacheMisses

getTracker

scanTracker

appendTracker

deleteTracker

incrementTracker

putTracker

multiTracker

runnerStats

metaCacheNumClearServer

metaCacheNumClearRegion

hedgedReadOps

hedgedReadWin

concurrentCallsPerServerHist

rpcTimers

rpcHistograms

Constructor Detail

MetricsConnection

Method Detail

updateServerStats

updateRegionStats

shutdown

newCallStats

incrMetaCacheHit

incrMetaCacheMiss

incrMetaCacheNumClearServer

incrMetaCacheNumClearRegion

incrHedgedReadOps

incrHedgedReadWin

incrNormalRunners

incrDelayRunners

updateDelayInterval

updateRpc

incrCacheDroppingExceptions