org.apache.hadoop.hbase

Class ClusterStatus

java.lang.Object

VersionedWritable

org.apache.hadoop.hbase.ClusterStatus

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class ClusterStatus
extends VersionedWritable

Status information on the HBase cluster.

ClusterStatus provides clients with information such as:

• The count and names of region servers in the cluster.
• The count and names of dead region servers in the cluster.
• The name of the active master for the cluster.
• The name(s) of the backup master(s) for the cluster, if they exist.
• The average cluster load.
• The number of regions deployed on the cluster.
• The number of requests since last report.
• Detailed region server loading and resource usage information, per server and per region.
• Regions in transition at master
• The unique cluster ID

Constructor Summary

Constructors

Constructor and Description
ClusterStatus() Deprecated. As of release 0.96 (HBASE-6038). This will be removed in HBase 2.0.0. Used by Writables and Writables are going away.
ClusterStatus(String hbaseVersion, String clusterid, Map<ServerName,ServerLoad> servers, Collection<ServerName> deadServers, ServerName master, Collection<ServerName> backupMasters, Map<String,RegionState> rit, String[] masterCoprocessors, Boolean balancerOn)

Method Summary

Modifier and Type	Method and Description
ClusterStatusProtos.ClusterStatus	convert() Convert a ClusterStatus to a protobuf ClusterStatus
static ClusterStatus	convert(ClusterStatusProtos.ClusterStatus proto) Convert a protobuf ClusterStatus to a ClusterStatus
boolean	equals(Object o)
double	getAverageLoad()
Collection<ServerName>	getBackupMasters()
int	getBackupMastersSize()
Boolean	getBalancerOn()
String	getClusterId()
Collection<ServerName>	getDeadServerNames()
int	getDeadServers()
String	getHBaseVersion()
long	getLastMajorCompactionTsForRegion(byte[] region)
long	getLastMajorCompactionTsForTable(TableName table)
ServerLoad	getLoad(ServerName sn)
ServerName	getMaster() Returns detailed information about the current master ServerName.
String[]	getMasterCoprocessors()
int	getRegionsCount()
Map<String,RegionState>	getRegionsInTransition()
int	getRequestsCount()
Collection<ServerName>	getServerInfo() Deprecated. As of release 0.92 (HBASE-1502). This will be removed in HBase 2.0.0. Use getServers().
Collection<ServerName>	getServers()
int	getServersSize()
byte	getVersion()
int	hashCode()
boolean	isBalancerOn()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClusterStatus

@Deprecated
public ClusterStatus()

Deprecated. As of release 0.96 (HBASE-6038). This will be removed in HBase 2.0.0. Used by Writables and Writables are going away.

Constructor, for Writable

ClusterStatus

public ClusterStatus(String hbaseVersion,
                     String clusterid,
                     Map<ServerName,ServerLoad> servers,
                     Collection<ServerName> deadServers,
                     ServerName master,
                     Collection<ServerName> backupMasters,
                     Map<String,RegionState> rit,
                     String[] masterCoprocessors,
                     Boolean balancerOn)

Method Detail

getDeadServerNames

public Collection<ServerName> getDeadServerNames()

Returns:

the names of region servers on the dead list

getServersSize

public int getServersSize()

Returns:

the number of region servers in the cluster

getDeadServers

public int getDeadServers()

Returns:

the number of dead region servers in the cluster

getAverageLoad

public double getAverageLoad()

Returns:

the average cluster load

getRegionsCount

public int getRegionsCount()

Returns:

the number of regions deployed on the cluster

getRequestsCount

public int getRequestsCount()

Returns:

the number of requests since last report

getHBaseVersion

public String getHBaseVersion()

Returns:

the HBase version string as reported by the HMaster

equals

public boolean equals(Object o)

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

See Also:

Object.hashCode()

getVersion

public byte getVersion()

Returns:

the object version number

getServerInfo

@Deprecated
public Collection<ServerName> getServerInfo()

Deprecated. As of release 0.92 (HBASE-1502). This will be removed in HBase 2.0.0. Use getServers().

Returns detailed region server information: A list of ServerName.

Returns:

region server information

getServers

public Collection<ServerName> getServers()

getMaster

public ServerName getMaster()

Returns detailed information about the current master ServerName.

Returns:

current master information if it exists

getBackupMastersSize

public int getBackupMastersSize()

Returns:

the number of backup masters in the cluster

getBackupMasters

public Collection<ServerName> getBackupMasters()

Returns:

the names of backup masters

getLoad

public ServerLoad getLoad(ServerName sn)

Parameters:

sn -

Returns:

Server's load or null if not found.

getRegionsInTransition

@InterfaceAudience.Private
public Map<String,RegionState> getRegionsInTransition()

getClusterId

public String getClusterId()

getMasterCoprocessors

public String[] getMasterCoprocessors()

getLastMajorCompactionTsForTable

public long getLastMajorCompactionTsForTable(TableName table)

getLastMajorCompactionTsForRegion

public long getLastMajorCompactionTsForRegion(byte[] region)

isBalancerOn

public boolean isBalancerOn()

getBalancerOn

public Boolean getBalancerOn()

toString

public String toString()

convert

public ClusterStatusProtos.ClusterStatus convert()

Convert a ClusterStatus to a protobuf ClusterStatus

Returns:

the protobuf ClusterStatus

convert

public static ClusterStatus convert(ClusterStatusProtos.ClusterStatus proto)

Convert a protobuf ClusterStatus to a ClusterStatus

Parameters:

proto - the protobuf ClusterStatus

Returns:

the converted ClusterStatus