Package org.apache.hadoop.hbase.client.metrics

Class ServerSideScanMetrics

java.lang.Object

org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics

Direct Known Subclasses:

ScanMetrics

@Public
public class ServerSideScanMetrics
extends Object

Provides server side metrics related to scan operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLOCK_BYTES_SCANNED_KEY_METRIC_NAME
static final String	COUNT_OF_ROWS_FILTERED_KEY	Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17886).
static final String	COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME
static final String	COUNT_OF_ROWS_SCANNED_KEY	Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17886).
static final String	COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME
private final Map<String,AtomicLong>	counters	Hash to hold the String -> Atomic Long mappings for each metric
final AtomicLong	countOfBlockBytesScanned
final AtomicLong	countOfRowsFiltered	number of rows filtered during scan RPC
final AtomicLong	countOfRowsScanned	number of rows scanned during scan RPC.
static final String	FS_READ_TIME_METRIC_NAME
final AtomicLong	fsReadTime

Constructor Summary

Constructors

Constructor	Description
ServerSideScanMetrics()

Method Summary

Modifier and Type	Method	Description
void	addToCounter(String counterName, long delta)
protected AtomicLong	createCounter(String counterName)	Create a new counter with the specified name
AtomicLong	getCounter(String counterName)	Returns AtomicLong instance for this counter name, null if counter does not exist.
Map<String,Long>	getMetricsMap()	Get all of the values since the last time this function was called.
Map<String,Long>	getMetricsMap(boolean reset)	Get all of the values.
boolean	hasCounter(String counterName)	Returns true if a counter exists with the 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 Details

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

BLOCK_BYTES_SCANNED_KEY_METRIC_NAME

public static final String BLOCK_BYTES_SCANNED_KEY_METRIC_NAME

See Also:

• Constant Field Values

FS_READ_TIME_METRIC_NAME

public static final String FS_READ_TIME_METRIC_NAME

See Also:

• Constant Field Values

COUNT_OF_ROWS_SCANNED_KEY

@Deprecated
public static final String COUNT_OF_ROWS_SCANNED_KEY

Deprecated.

As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17886). Use COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME.

See Also:

• Constant Field Values

COUNT_OF_ROWS_FILTERED_KEY

@Deprecated
public static final String COUNT_OF_ROWS_FILTERED_KEY

Deprecated.

As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-17886). Use COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME.

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.

countOfBlockBytesScanned

public final AtomicLong countOfBlockBytesScanned

fsReadTime

public final AtomicLong fsReadTime

Constructor Details

ServerSideScanMetrics

public ServerSideScanMetrics()

Method Details

createCounter

protected AtomicLong createCounter(String counterName)

Create a new counter with the specified name

Returns:

AtomicLong instance for the counter with counterName

setCounter

public void setCounter(String counterName,
 long value)

hasCounter

public boolean hasCounter(String counterName)

Returns true if a counter exists with the counterName

getCounter

public AtomicLong getCounter(String counterName)

Returns AtomicLong instance for this counter name, null if counter does not exist.

addToCounter

public void addToCounter(String counterName,
 long 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

getMetricsMap

public Map<String,Long> getMetricsMap(boolean reset)

Get all of the values. If reset is true, we will reset the all AtomicLongs back to 0.

Parameters:

reset - whether to reset the AtomicLongs to 0.

Returns:

A Map of String -> Long for metrics