org.apache.hadoop.hbase

Class ClusterStatus

java.lang.Object

org.apache.hadoop.io.VersionedWritable

org.apache.hadoop.hbase.ClusterStatus

All Implemented Interfaces:

org.apache.hadoop.io.Writable

@InterfaceAudience.Public
public class ClusterStatus
extends org.apache.hadoop.io.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

ClusterStatus.Options provides a way to filter out infos which unwanted. The following codes will retrieve all the cluster information.

 
 // Original version still works
 Admin admin = connection.getAdmin();
 ClusterStatus status = admin.getClusterStatus();
 // or below, a new version which has the same effects
 ClusterStatus status = admin.getClusterStatus(Options.defaultOptions());
 
 

If information about dead servers and master coprocessors are unwanted, then codes in the following way:

 
 Admin admin = connection.getAdmin();
 ClusterStatus status = admin.getClusterStatus(
                                Options.defaultOptions()
                                       .excludeDeadServers()
                                       .excludeMasterCoprocessors());
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterStatus.Builder Builder for construct a ClusterStatus.
static class	ClusterStatus.Options Options provides a way to filter out unwanted information.

Constructor Summary

Constructors

Constructor and Description
ClusterStatus(String hbaseVersion, String clusterid, Map<ServerName,ServerLoad> servers, Collection<ServerName> deadServers, ServerName master, Collection<ServerName> backupMasters, List<RegionState> rit, String[] masterCoprocessors, Boolean balancerOn) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-15511).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
double	getAverageLoad()
Collection<ServerName>	getBackupMasters()
int	getBackupMastersSize()
Boolean	getBalancerOn()
String	getClusterId()
Collection<ServerName>	getDeadServerNames()
int	getDeadServers() Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13656). Use getDeadServersSize().
int	getDeadServersSize()
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()
List<RegionState>	getRegionsInTransition()
int	getRequestsCount()
Collection<ServerName>	getServers()
int	getServersSize()
byte	getVersion()
int	hashCode()
boolean	isBalancerOn()
static ClusterStatus.Builder	newBuilder()
String	toString()

Methods inherited from class org.apache.hadoop.io.VersionedWritable

readFields, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterStatus

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

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-15511).

Use ClusterStatus.Builder to construct a ClusterStatus instead.

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

@Deprecated
public int getDeadServers()

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 (HBASE-13656). Use getDeadServersSize().

Returns:

the number of dead region servers in the cluster

getDeadServersSize

public int getDeadServersSize()

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)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getVersion

public byte getVersion()

Specified by:

getVersion in class org.apache.hadoop.io.VersionedWritable

Returns:

the object version number

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 List<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()

Overrides:

toString in class Object

newBuilder

public static ClusterStatus.Builder newBuilder()