ScanMetrics (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics
- - org.apache.hadoop.hbase.client.metrics.ScanMetrics

```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public class ScanMetrics
extends ServerSideScanMetrics
```
Provides metrics related to scan operations (both server side and client side metrics).
The data can be passed to mapreduce framework or other systems. We use atomic longs so that one thread can increment, while another atomically resets to zero after the values are reported to hadoop's counters.
Some of these metrics are general for any client operation such as put However, there is no need for this. So they are defined under scan operation for now.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BYTES_IN_REMOTE_RESULTS_METRIC_NAME`
`static String`	`BYTES_IN_RESULTS_METRIC_NAME`
`AtomicLong`	`countOfBytesInRemoteResults` number of bytes in Result objects from remote region servers
`AtomicLong`	`countOfBytesInResults` number of bytes in Result objects from region servers
`AtomicLong`	`countOfNSRE` number of NotServingRegionException caught
`AtomicLong`	`countOfRegions` number of regions
`AtomicLong`	`countOfRemoteRPCcalls` number of remote RPC calls
`AtomicLong`	`countOfRemoteRPCRetries` number of remote RPC retries
`AtomicLong`	`countOfRPCcalls` number of RPC calls
`AtomicLong`	`countOfRPCRetries` number of RPC retries
`static String`	`MILLIS_BETWEEN_NEXTS_METRIC_NAME`
`static String`	`NOT_SERVING_REGION_EXCEPTION_METRIC_NAME`
`static String`	`REGIONS_SCANNED_METRIC_NAME`
`static String`	`REMOTE_RPC_CALLS_METRIC_NAME`
`static String`	`REMOTE_RPC_RETRIES_METRIC_NAME`
`static String`	`RPC_CALLS_METRIC_NAME`
`static String`	`RPC_RETRIES_METRIC_NAME`
`AtomicLong`	`sumOfMillisSecBetweenNexts` sum of milliseconds between sequential next calls

Fields inherited from class org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics
COUNT_OF_ROWS_FILTERED_KEY, COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME, COUNT_OF_ROWS_SCANNED_KEY, COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME, countOfRowsFiltered, countOfRowsScanned

Constructor Summary

Constructors
Constructor and Description

ScanMetrics()
constructor

Constructors
Constructor and Description
`ScanMetrics()` constructor

Method Summary
- Methods inherited from class org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics
  addToCounter, createCounter, getCounter, getMetricsMap, hasCounter, setCounter
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RPC_CALLS_METRIC_NAME
```
public static final String RPC_CALLS_METRIC_NAME
```
    See Also:
    Constant Field Values
  - REMOTE_RPC_CALLS_METRIC_NAME
```
public static final String REMOTE_RPC_CALLS_METRIC_NAME
```
    See Also:
    Constant Field Values
  - MILLIS_BETWEEN_NEXTS_METRIC_NAME
```
public static final String MILLIS_BETWEEN_NEXTS_METRIC_NAME
```
    See Also:
    Constant Field Values
  - NOT_SERVING_REGION_EXCEPTION_METRIC_NAME
```
public static final String NOT_SERVING_REGION_EXCEPTION_METRIC_NAME
```
    See Also:
    Constant Field Values
  - BYTES_IN_RESULTS_METRIC_NAME
```
public static final String BYTES_IN_RESULTS_METRIC_NAME
```
    See Also:
    Constant Field Values
  - BYTES_IN_REMOTE_RESULTS_METRIC_NAME
```
public static final String BYTES_IN_REMOTE_RESULTS_METRIC_NAME
```
    See Also:
    Constant Field Values
  - REGIONS_SCANNED_METRIC_NAME
```
public static final String REGIONS_SCANNED_METRIC_NAME
```
    See Also:
    Constant Field Values
  - RPC_RETRIES_METRIC_NAME
```
public static final String RPC_RETRIES_METRIC_NAME
```
    See Also:
    Constant Field Values
  - REMOTE_RPC_RETRIES_METRIC_NAME
```
public static final String REMOTE_RPC_RETRIES_METRIC_NAME
```
    See Also:
    Constant Field Values
  - countOfRPCcalls
```
public final AtomicLong countOfRPCcalls
```
    number of RPC calls
  - countOfRemoteRPCcalls
```
public final AtomicLong countOfRemoteRPCcalls
```
    number of remote RPC calls
  - sumOfMillisSecBetweenNexts
```
public final AtomicLong sumOfMillisSecBetweenNexts
```
    sum of milliseconds between sequential next calls
  - countOfNSRE
```
public final AtomicLong countOfNSRE
```
    number of NotServingRegionException caught
  - countOfBytesInResults
```
public final AtomicLong countOfBytesInResults
```
    number of bytes in Result objects from region servers
  - countOfBytesInRemoteResults
```
public final AtomicLong countOfBytesInRemoteResults
```
    number of bytes in Result objects from remote region servers
  - countOfRegions
```
public final AtomicLong countOfRegions
```
    number of regions
  - countOfRPCRetries
```
public final AtomicLong countOfRPCRetries
```
    number of RPC retries
  - countOfRemoteRPCRetries
```
public final AtomicLong countOfRemoteRPCRetries
```
    number of remote RPC retries
- Constructor Detail
  - ScanMetrics
```
public ScanMetrics()
```
    constructor

Class ScanMetrics

Field Summary

Fields inherited from class org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics

Methods inherited from class java.lang.Object

Field Detail

RPC_CALLS_METRIC_NAME

REMOTE_RPC_CALLS_METRIC_NAME

MILLIS_BETWEEN_NEXTS_METRIC_NAME

NOT_SERVING_REGION_EXCEPTION_METRIC_NAME

BYTES_IN_RESULTS_METRIC_NAME

BYTES_IN_REMOTE_RESULTS_METRIC_NAME

REGIONS_SCANNED_METRIC_NAME

RPC_RETRIES_METRIC_NAME

REMOTE_RPC_RETRIES_METRIC_NAME

countOfRPCcalls

countOfRemoteRPCcalls

sumOfMillisSecBetweenNexts

countOfNSRE

countOfBytesInResults

countOfBytesInRemoteResults

countOfRegions

countOfRPCRetries

countOfRemoteRPCRetries

Constructor Detail

ScanMetrics