Package org.apache.hadoop.hbase

Interface ServerMetrics

All Known Implementing Classes:

ServerLoad, ServerMetricsBuilder.ServerMetricsImpl

@Public
public interface ServerMetrics

This class is used for exporting current state of load on a RegionServer.

Method Summary

Modifier and Type	Method	Description
Set<String>	getCoprocessorNames()	Return the RegionServer-level and Region-level coprocessors
int	getInfoServerPort()
long	getLastReportTimestamp()	Returns the last timestamp (server side) of generating this metrics
Size	getMaxHeapSize()	Returns the maximum allowable size of the heap
Map<String,Integer>	getRegionCachedInfo()	Returns the region cache information for the regions hosted on this server
Map<byte[],RegionMetrics>	getRegionMetrics()	Returns region load metrics
ReplicationLoadSink	getReplicationLoadSink()	Call directly from client such as hbase shell
List<ReplicationLoadSource>	getReplicationLoadSourceList()	Call directly from client such as hbase shell
Map<String,List<ReplicationLoadSource>>	getReplicationLoadSourceMap()	Call directly from client such as hbase shell
long	getReportTimestamp()	Returns the timestamp (server side) of generating this metrics
long	getRequestCount()	Returns total Number of requests from the start of the region server.
long	getRequestCountPerSecond()	Returns the number of requests per second.
ServerName	getServerName()
List<ServerTask>	getTasks()	Called directly from clients such as the hbase shell
Size	getUsedHeapSize()	Returns the amount of used heap
Map<byte[],UserMetrics>	getUserMetrics()	Returns metrics per user
default String	getVersion()	Returns the string type version of a regionserver.
default int	getVersionNumber()	Returns the version number of a regionserver.

Method Details

getServerName

ServerName getServerName()

getVersionNumber

default int getVersionNumber()

Returns the version number of a regionserver.

getVersion

default String getVersion()

Returns the string type version of a regionserver.

getRequestCountPerSecond

long getRequestCountPerSecond()

Returns the number of requests per second.

getRequestCount

long getRequestCount()

Returns total Number of requests from the start of the region server.

getUsedHeapSize

Size getUsedHeapSize()

Returns the amount of used heap

getMaxHeapSize

Size getMaxHeapSize()

Returns the maximum allowable size of the heap

getInfoServerPort

int getInfoServerPort()

getReplicationLoadSourceList

List<ReplicationLoadSource> getReplicationLoadSourceList()

Call directly from client such as hbase shell

Returns:

the list of ReplicationLoadSource

getReplicationLoadSourceMap

Map<String,List<ReplicationLoadSource>> getReplicationLoadSourceMap()

Call directly from client such as hbase shell

Returns:

a map of ReplicationLoadSource list per peer id

getReplicationLoadSink

@Nullable
ReplicationLoadSink getReplicationLoadSink()

Call directly from client such as hbase shell

getRegionMetrics

Map<byte[],RegionMetrics> getRegionMetrics()

Returns region load metrics

getUserMetrics

Map<byte[],UserMetrics> getUserMetrics()

Returns metrics per user

getCoprocessorNames

Set<String> getCoprocessorNames()

Return the RegionServer-level and Region-level coprocessors

Returns:

string set of loaded RegionServer-level and Region-level coprocessors

getReportTimestamp

long getReportTimestamp()

Returns the timestamp (server side) of generating this metrics

getLastReportTimestamp

long getLastReportTimestamp()

Returns the last timestamp (server side) of generating this metrics

getTasks

@Nullable
List<ServerTask> getTasks()

Called directly from clients such as the hbase shell

Returns:

the active monitored tasks

getRegionCachedInfo

Map<String,Integer> getRegionCachedInfo()

Returns the region cache information for the regions hosted on this server

Returns:

map of region encoded name and the size of the region cached on this region server rounded to MB