ServerSideScanMetrics (Apache HBase 1.2.12 API)

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

Direct Known Subclasses:: ScanMetrics

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class ServerSideScanMetrics
extends Object

Provides server side metrics related to scan operations.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COUNT_OF_ROWS_FILTERED_KEY` Deprecated. Use `COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME` instead
`static String`	`COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME`
`static String`	`COUNT_OF_ROWS_SCANNED_KEY` Deprecated. Use `COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME` instead
`static String`	`COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME`
`private Map<String,AtomicLong>`	`counters` Hash to hold the String -> Atomic Long mappings for each metric
`AtomicLong`	`countOfRowsFiltered` number of rows filtered during scan RPC
`AtomicLong`	`countOfRowsScanned` number of rows scanned during scan RPC.

Constructor Summary

Constructors
Constructor and Description

ServerSideScanMetrics()

Constructors
Constructor and Description
`ServerSideScanMetrics()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToCounter(String counterName, long delta)`
`protected AtomicLong`	`createCounter(String counterName)` Create a new counter with the specified name
`AtomicLong`	`getCounter(String counterName)`
`Map<String,Long>`	`getMetricsMap()` Get all of the values since the last time this function was called.
`boolean`	`hasCounter(String counterName)`
`void`	`setCounter(String counterName, long value)`

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

- Field Detail
  - counters
```
private final Map<String,AtomicLong> counters
```
    Hash to hold the String -> Atomic Long mappings for each metric
  - COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME
```
public static final String COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME
```
    See Also:
    Constant Field Values
  - COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME
```
public static final String COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME
```
    See Also:
    Constant Field Values
  - COUNT_OF_ROWS_SCANNED_KEY
```
public static final String COUNT_OF_ROWS_SCANNED_KEY
```
    Deprecated. Use COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME instead
    
    See Also:
    Constant Field Values
  - COUNT_OF_ROWS_FILTERED_KEY
```
public static final String COUNT_OF_ROWS_FILTERED_KEY
```
    Deprecated. Use COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME instead
    
    See Also:
    Constant Field Values
  - countOfRowsFiltered
```
public final AtomicLong countOfRowsFiltered
```
    number of rows filtered during scan RPC
  - countOfRowsScanned
```
public final AtomicLong countOfRowsScanned
```
    number of rows scanned during scan RPC. Not every row scanned will be returned to the client since rows may be filtered.
- Constructor Detail
  - ServerSideScanMetrics
```
public ServerSideScanMetrics()
```
- Method Detail
  - createCounter
```
protected AtomicLong createCounter(String counterName)
```
    Create a new counter with the specified name
    
    Parameters:
    counterName -
    
    Returns:
    AtomicLong instance for the counter with counterName
  - setCounter
```
public void setCounter(String counterName,
              long value)
```
    Parameters:
    counterName -
    value -
  - hasCounter
```
public boolean hasCounter(String counterName)
```
    Parameters:
    counterName -
    
    Returns:
    true if a counter exists with the counterName
  - getCounter
```
public AtomicLong getCounter(String counterName)
```
    Parameters:
    counterName -
    
    Returns:
    AtomicLong instance for this counter name, null if counter does not exist.
  - addToCounter
```
public void addToCounter(String counterName,
                long delta)
```
    Parameters:
    counterName -
    delta -
  - getMetricsMap
```
public Map<String,Long> getMetricsMap()
```
    Get all of the values since the last time this function was called. Calling this function will reset all AtomicLongs in the instance back to 0.
    
    Returns:
    A Map of String -> Long for metrics

Class ServerSideScanMetrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

counters

COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME

COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME

COUNT_OF_ROWS_SCANNED_KEY

COUNT_OF_ROWS_FILTERED_KEY

countOfRowsFiltered

countOfRowsScanned

Constructor Detail

ServerSideScanMetrics

Method Detail

createCounter

setCounter

hasCounter

getCounter

addToCounter

getMetricsMap