MetricsZooKeeperSource (Apache HBase 2.5.0 API)

All Superinterfaces:

BaseSource

All Known Implementing Classes:

MetricsZooKeeperSourceImpl
```
@InterfaceAudience.Private
public interface MetricsZooKeeperSource
extends BaseSource
```
Interface of the source that will export metrics about the ZooKeeper.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXCEPTION_AUTHFAILED`
`static String`	`EXCEPTION_AUTHFAILED_DESC`
`static String`	`EXCEPTION_CONNECTIONLOSS`
`static String`	`EXCEPTION_CONNECTIONLOSS_DESC`
`static String`	`EXCEPTION_DATAINCONSISTENCY`
`static String`	`EXCEPTION_DATAINCONSISTENCY_DESC`
`static String`	`EXCEPTION_INVALIDACL`
`static String`	`EXCEPTION_INVALIDACL_DESC`
`static String`	`EXCEPTION_NOAUTH`
`static String`	`EXCEPTION_NOAUTH_DESC`
`static String`	`EXCEPTION_OPERATIONTIMEOUT`
`static String`	`EXCEPTION_OPERATIONTIMEOUT_DESC`
`static String`	`EXCEPTION_RUNTIMEINCONSISTENCY`
`static String`	`EXCEPTION_RUNTIMEINCONSISTENCY_DESC`
`static String`	`EXCEPTION_SESSIONEXPIRED`
`static String`	`EXCEPTION_SESSIONEXPIRED_DESC`
`static String`	`EXCEPTION_SYSTEMERROR`
`static String`	`EXCEPTION_SYSTEMERROR_DESC`
`static String`	`METRICS_CONTEXT` The name of the metrics context that metrics will be under.
`static String`	`METRICS_DESCRIPTION` Description
`static String`	`METRICS_JMX_CONTEXT` The name of the metrics context that metrics will be under in jmx.
`static String`	`METRICS_NAME` The name of the metrics
`static String`	`READ_OPERATION_LATENCY_DESC`
`static String`	`READ_OPERATION_LATENCY_NAME`
`static String`	`SYNC_OPERATION_LATENCY_DESC`
`static String`	`SYNC_OPERATION_LATENCY_NAME`
`static String`	`TOTAL_FAILED_ZK_CALLS`
`static String`	`TOTAL_FAILED_ZK_CALLS_DESC`
`static String`	`WRITE_OPERATION_LATENCY_DESC`
`static String`	`WRITE_OPERATION_LATENCY_NAME`

Fields inherited from interface org.apache.hadoop.hbase.metrics.BaseSource
HBASE_METRICS_SYSTEM_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`incrementAuthFailedCount()` Increment the count of failed ops due to AUTHFAILED Exception.
`void`	`incrementConnectionLossCount()` Increment the count of failed ops due to a CONNECTIONLOSS Exception.
`void`	`incrementDataInconsistencyCount()` Increment the count of failed ops due to a DATAINCONSISTENCY Exception.
`void`	`incrementInvalidACLCount()` Increment the count of failed ops due to INVALIDACL Exception.
`void`	`incrementNoAuthCount()` Increment the count of failed ops due to NOAUTH Exception.
`void`	`incrementOperationTimeoutCount()` Increment the count of failed ops due to an OPERATIONTIMEOUT Exception.
`void`	`incrementRuntimeInconsistencyCount()` Increment the count of failed ops due to RUNTIMEINCONSISTENCY Exception.
`void`	`incrementSessionExpiredCount()` Increment the count of failed ops due to a SESSIONEXPIRED Exception.
`void`	`incrementSystemErrorCount()` Increment the count of failed ops due to a SYSTEMERROR Exception.
`void`	`incrementTotalFailedZKCalls()` Record the total number of failed ZooKeeper API calls.
`void`	`recordReadOperationLatency(long latency)` Record the latency incurred for read operations.
`void`	`recordSyncOperationLatency(long latency)` Record the latency incurred for sync operations.
`void`	`recordWriteOperationLatency(long latency)` Record the latency incurred for write operations.

Methods inherited from interface org.apache.hadoop.hbase.metrics.BaseSource
decGauge, getMetricRegistryInfo, getMetricsContext, getMetricsDescription, getMetricsJmxContext, getMetricsName, incCounters, incGauge, init, removeMetric, setGauge, updateHistogram

- Field Detail
  - METRICS_NAME
```
static final String METRICS_NAME
```
    The name of the metrics
    
    See Also:
    
    Constant Field Values
  - METRICS_CONTEXT
```
static final String METRICS_CONTEXT
```
    The name of the metrics context that metrics will be under.
    
    See Also:
    
    Constant Field Values
  - METRICS_DESCRIPTION
```
static final String METRICS_DESCRIPTION
```
    Description
    
    See Also:
    
    Constant Field Values
  - METRICS_JMX_CONTEXT
```
static final String METRICS_JMX_CONTEXT
```
    The name of the metrics context that metrics will be under in jmx.
    
    See Also:
    
    Constant Field Values
  - EXCEPTION_AUTHFAILED
```
static final String EXCEPTION_AUTHFAILED
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_AUTHFAILED_DESC
```
static final String EXCEPTION_AUTHFAILED_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_CONNECTIONLOSS
```
static final String EXCEPTION_CONNECTIONLOSS
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_CONNECTIONLOSS_DESC
```
static final String EXCEPTION_CONNECTIONLOSS_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_DATAINCONSISTENCY
```
static final String EXCEPTION_DATAINCONSISTENCY
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_DATAINCONSISTENCY_DESC
```
static final String EXCEPTION_DATAINCONSISTENCY_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_INVALIDACL
```
static final String EXCEPTION_INVALIDACL
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_INVALIDACL_DESC
```
static final String EXCEPTION_INVALIDACL_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_NOAUTH
```
static final String EXCEPTION_NOAUTH
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_NOAUTH_DESC
```
static final String EXCEPTION_NOAUTH_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_OPERATIONTIMEOUT
```
static final String EXCEPTION_OPERATIONTIMEOUT
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_OPERATIONTIMEOUT_DESC
```
static final String EXCEPTION_OPERATIONTIMEOUT_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_RUNTIMEINCONSISTENCY
```
static final String EXCEPTION_RUNTIMEINCONSISTENCY
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_RUNTIMEINCONSISTENCY_DESC
```
static final String EXCEPTION_RUNTIMEINCONSISTENCY_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_SESSIONEXPIRED
```
static final String EXCEPTION_SESSIONEXPIRED
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_SESSIONEXPIRED_DESC
```
static final String EXCEPTION_SESSIONEXPIRED_DESC
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_SYSTEMERROR
```
static final String EXCEPTION_SYSTEMERROR
```
    See Also:
    
    Constant Field Values
  - EXCEPTION_SYSTEMERROR_DESC
```
static final String EXCEPTION_SYSTEMERROR_DESC
```
    See Also:
    
    Constant Field Values
  - TOTAL_FAILED_ZK_CALLS
```
static final String TOTAL_FAILED_ZK_CALLS
```
    See Also:
    
    Constant Field Values
  - TOTAL_FAILED_ZK_CALLS_DESC
```
static final String TOTAL_FAILED_ZK_CALLS_DESC
```
    See Also:
    
    Constant Field Values
  - READ_OPERATION_LATENCY_NAME
```
static final String READ_OPERATION_LATENCY_NAME
```
    See Also:
    
    Constant Field Values
  - READ_OPERATION_LATENCY_DESC
```
static final String READ_OPERATION_LATENCY_DESC
```
    See Also:
    
    Constant Field Values
  - WRITE_OPERATION_LATENCY_NAME
```
static final String WRITE_OPERATION_LATENCY_NAME
```
    See Also:
    
    Constant Field Values
  - WRITE_OPERATION_LATENCY_DESC
```
static final String WRITE_OPERATION_LATENCY_DESC
```
    See Also:
    
    Constant Field Values
  - SYNC_OPERATION_LATENCY_NAME
```
static final String SYNC_OPERATION_LATENCY_NAME
```
    See Also:
    
    Constant Field Values
  - SYNC_OPERATION_LATENCY_DESC
```
static final String SYNC_OPERATION_LATENCY_DESC
```
    See Also:
    
    Constant Field Values
- Method Detail
  - incrementAuthFailedCount
```
void incrementAuthFailedCount()
```
    Increment the count of failed ops due to AUTHFAILED Exception.
  - incrementConnectionLossCount
```
void incrementConnectionLossCount()
```
    Increment the count of failed ops due to a CONNECTIONLOSS Exception.
  - incrementDataInconsistencyCount
```
void incrementDataInconsistencyCount()
```
    Increment the count of failed ops due to a DATAINCONSISTENCY Exception.
  - incrementInvalidACLCount
```
void incrementInvalidACLCount()
```
    Increment the count of failed ops due to INVALIDACL Exception.
  - incrementNoAuthCount
```
void incrementNoAuthCount()
```
    Increment the count of failed ops due to NOAUTH Exception.
  - incrementOperationTimeoutCount
```
void incrementOperationTimeoutCount()
```
    Increment the count of failed ops due to an OPERATIONTIMEOUT Exception.
  - incrementRuntimeInconsistencyCount
```
void incrementRuntimeInconsistencyCount()
```
    Increment the count of failed ops due to RUNTIMEINCONSISTENCY Exception.
  - incrementSessionExpiredCount
```
void incrementSessionExpiredCount()
```
    Increment the count of failed ops due to a SESSIONEXPIRED Exception.
  - incrementSystemErrorCount
```
void incrementSystemErrorCount()
```
    Increment the count of failed ops due to a SYSTEMERROR Exception.
  - recordReadOperationLatency
```
void recordReadOperationLatency(long latency)
```
    Record the latency incurred for read operations.
  - recordWriteOperationLatency
```
void recordWriteOperationLatency(long latency)
```
    Record the latency incurred for write operations.
  - recordSyncOperationLatency
```
void recordSyncOperationLatency(long latency)
```
    Record the latency incurred for sync operations.
  - incrementTotalFailedZKCalls
```
void incrementTotalFailedZKCalls()
```
    Record the total number of failed ZooKeeper API calls.

Interface MetricsZooKeeperSource

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.metrics.BaseSource

Method Summary

Methods inherited from interface org.apache.hadoop.hbase.metrics.BaseSource

Field Detail

METRICS_NAME

METRICS_CONTEXT

METRICS_DESCRIPTION

METRICS_JMX_CONTEXT

EXCEPTION_AUTHFAILED

EXCEPTION_AUTHFAILED_DESC

EXCEPTION_CONNECTIONLOSS

EXCEPTION_CONNECTIONLOSS_DESC

EXCEPTION_DATAINCONSISTENCY

EXCEPTION_DATAINCONSISTENCY_DESC

EXCEPTION_INVALIDACL

EXCEPTION_INVALIDACL_DESC

EXCEPTION_NOAUTH

EXCEPTION_NOAUTH_DESC

EXCEPTION_OPERATIONTIMEOUT

EXCEPTION_OPERATIONTIMEOUT_DESC

EXCEPTION_RUNTIMEINCONSISTENCY

EXCEPTION_RUNTIMEINCONSISTENCY_DESC

EXCEPTION_SESSIONEXPIRED

EXCEPTION_SESSIONEXPIRED_DESC

EXCEPTION_SYSTEMERROR

EXCEPTION_SYSTEMERROR_DESC

TOTAL_FAILED_ZK_CALLS

TOTAL_FAILED_ZK_CALLS_DESC

READ_OPERATION_LATENCY_NAME

READ_OPERATION_LATENCY_DESC

WRITE_OPERATION_LATENCY_NAME

WRITE_OPERATION_LATENCY_DESC

SYNC_OPERATION_LATENCY_NAME

SYNC_OPERATION_LATENCY_DESC

Method Detail

incrementAuthFailedCount

incrementConnectionLossCount

incrementDataInconsistencyCount

incrementInvalidACLCount

incrementNoAuthCount

incrementOperationTimeoutCount

incrementRuntimeInconsistencyCount

incrementSessionExpiredCount

incrementSystemErrorCount

recordReadOperationLatency

recordWriteOperationLatency

recordSyncOperationLatency

incrementTotalFailedZKCalls