MetricsConnection (Apache HBase 1.2.12 API)

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

```
@InterfaceAudience.Private
public class MetricsConnection
extends Object
```
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`
`private static interface`	`MetricsConnection.NewMetric<T>` A lambda for dispatching to the appropriate metric factory method
`protected static class`	`MetricsConnection.RegionStats`
`protected static class`	`MetricsConnection.RunnerStats`

Field Summary

Fields
Modifier and Type	Field and Description
`protected MetricsConnection.CallTracker`	`appendTracker`
`private static int`	`CAPACITY` Anticipated number of metric entries
`static String`	`CLIENT_SIDE_METRICS_ENABLED_KEY` Set this key to `true` to enable metrics collection of client requests.
`private static String`	`CLIENT_SVC`
`private static int`	`CONCURRENCY_LEVEL` Anticipated number of concurrent accessor threads, from `ConnectionManager.HConnectionImplementation.getBatchPool()`
`protected MetricsConnection.CallTracker`	`deleteTracker`
`private static String`	`DRTN_BASE`
`protected MetricsConnection.CallTracker`	`getTracker`
`private static String`	`HEAP_BASE`
`private MetricsConnection.NewMetric<com.yammer.metrics.core.Histogram>`	`histogramFactory`
`protected MetricsConnection.CallTracker`	`incrementTracker`
`private static float`	`LOAD_FACTOR` Default load factor from `HashMap.DEFAULT_LOAD_FACTOR`
`private static String`	`MEMLOAD_BASE`
`protected com.yammer.metrics.core.Counter`	`metaCacheHits`
`protected com.yammer.metrics.core.Counter`	`metaCacheMisses`
`protected MetricsConnection.CallTracker`	`multiTracker`
`protected MetricsConnection.CallTracker`	`putTracker`
`private com.yammer.metrics.core.MetricsRegistry`	`registry`
`private com.yammer.metrics.reporting.JmxReporter`	`reporter`
`private static String`	`REQ_BASE`
`private static String`	`RESP_BASE`
`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`
`private String`	`scope`
`protected ConcurrentHashMap<ServerName,ConcurrentMap<byte[],MetricsConnection.RegionStats>>`	`serverStats`
`private MetricsConnection.NewMetric<com.yammer.metrics.core.Timer>`	`timerFactory`

Constructor Summary

Constructors
Constructor and Description

MetricsConnection(ConnectionManager.HConnectionImplementation conn)

Constructors
Constructor and Description
`MetricsConnection(ConnectionManager.HConnectionImplementation conn)`

Method Summary

Methods
Modifier and Type	Method and Description
`private <T> T`	`getMetric(String key, ConcurrentMap<String,T> map, MetricsConnection.NewMetric<T> factory)` Get a metric for `key` from `map`, or create it with `factory`.
`void`	`incrDelayRunners()` Increment the number of delay runner counts.
`void`	`incrMetaCacheHit()` Increment the number of meta cache hits.
`void`	`incrMetaCacheMiss()` Increment the number of meta cache misses.
`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`	`updateRpc(com.google.protobuf.Descriptors.MethodDescriptor method, com.google.protobuf.Message param, MetricsConnection.CallStats stats)` Report RPC context to metrics system.
`private void`	`updateRpcGeneric(com.google.protobuf.Descriptors.MethodDescriptor method, MetricsConnection.CallStats stats)` Update call stats for non-critical-path methods
`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

DRTN_BASE
```
private static final String DRTN_BASE
```
See Also:
Constant Field Values

REQ_BASE
```
private static final String REQ_BASE
```
See Also:
Constant Field Values

RESP_BASE
```
private static final String RESP_BASE
```
See Also:
Constant Field Values

MEMLOAD_BASE

private static final String MEMLOAD_BASE

See Also:: Constant Field Values

HEAP_BASE
```
private static final String HEAP_BASE
```
See Also:
Constant Field Values

CLIENT_SVC
```
private static final String CLIENT_SVC
```

serverStats

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

CAPACITY
```
private static final int CAPACITY
```
Anticipated number of metric entries

See Also:
Constant Field Values

LOAD_FACTOR
```
private static final float LOAD_FACTOR
```
Default load factor from HashMap.DEFAULT_LOAD_FACTOR

See Also:
Constant Field Values

CONCURRENCY_LEVEL
```
private static final int CONCURRENCY_LEVEL
```
Anticipated number of concurrent accessor threads, from ConnectionManager.HConnectionImplementation.getBatchPool()

See Also:
Constant Field Values

registry

private final com.yammer.metrics.core.MetricsRegistry registry

reporter

private final com.yammer.metrics.reporting.JmxReporter reporter

scope
```
private final String scope
```

timerFactory

private final MetricsConnection.NewMetric<com.yammer.metrics.core.Timer> timerFactory

histogramFactory

private final MetricsConnection.NewMetric<com.yammer.metrics.core.Histogram> histogramFactory

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

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(ConnectionManager.HConnectionImplementation conn)

Method Detail

updateServerStats

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

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.

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.

getMetric

private <T> T getMetric(String key,
              ConcurrentMap<String,T> map,
              MetricsConnection.NewMetric<T> factory)

Get a metric for key from map, or create it with factory.

updateRpcGeneric

private void updateRpcGeneric(com.google.protobuf.Descriptors.MethodDescriptor method,
                    MetricsConnection.CallStats stats)

Update call stats for non-critical-path methods

updateRpc

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

Report RPC context to metrics system.

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

DRTN_BASE

REQ_BASE

RESP_BASE

MEMLOAD_BASE

HEAP_BASE

CLIENT_SVC

serverStats

CAPACITY

LOAD_FACTOR

CONCURRENCY_LEVEL

registry

reporter

scope

timerFactory

histogramFactory

metaCacheHits

metaCacheMisses

getTracker

scanTracker

appendTracker

deleteTracker

incrementTracker

putTracker

multiTracker

runnerStats

rpcTimers

rpcHistograms

Constructor Detail

MetricsConnection

Method Detail

updateServerStats

shutdown

newCallStats

incrMetaCacheHit

incrMetaCacheMiss

incrNormalRunners

incrDelayRunners

updateDelayInterval

getMetric

updateRpcGeneric

updateRpc