ClusterMetrics (Apache HBase 2.1.0 API)

+
+
所有已知实现类:
+
ClusterStatus
+
+
+
+
```
@InterfaceAudience.Public
+public interface ClusterMetrics
```
+
Metrics information on the HBase cluster. +
+ ClusterMetrics 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
+ ClusterMetrics.Option provides a way to get desired ClusterStatus information. + The following codes will get all the cluster information. +
```
+ 
+ // Original version still works
+ Admin admin = connection.getAdmin();
+ ClusterMetrics metrics = admin.getClusterStatus();
+ // or below, a new version which has the same effects
+ ClusterMetrics metrics = admin.getClusterStatus(EnumSet.allOf(Option.class));
+ 
+ 
```
+ If information about live servers is the only wanted. + then codes in the following way: +
```
+ 
+ Admin admin = connection.getAdmin();
+ ClusterMetrics metrics = admin.getClusterStatus(EnumSet.of(Option.LIVE_SERVERS));
+ 
+ 
```
+

+ +

+ + +
嵌套类概要
+ + + + + + + + + + +
嵌套类
限定符和类型接口和说明
static class ClusterMetrics.Option +
Kinds of ClusterMetrics
+
+

嵌套类
限定符和类型	接口和说明
`static class`	`ClusterMetrics.Option` + Kinds of ClusterMetrics +

+ +

方法概要

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`default double`	`getAverageLoad()`
`List<ServerName>`	`getBackupMasterNames()`
`Boolean`	`getBalancerOn()`
`String`	`getClusterId()`
`List<ServerName>`	`getDeadServerNames()`
`String`	`getHBaseVersion()`
`default long`	`getLastMajorCompactionTimestamp(byte[] regionName)`
`default long`	`getLastMajorCompactionTimestamp(TableName table)`
`Map<ServerName,ServerMetrics>`	`getLiveServerMetrics()`
`List<String>`	`getMasterCoprocessorNames()`
`int`	`getMasterInfoPort()`
`ServerName`	`getMasterName()` + Returns detailed information about the current master `ServerName`. +
`default int`	`getRegionCount()`
`List<RegionState>`	`getRegionStatesInTransition()`
`default long`	`getRequestCount()`

+ +
- + + +
  方法详细资料
  + + + +
  - +
    getHBaseVersion
    +
```
@Nullable
+String getHBaseVersion()
```
    +
    +
    返回:
    +
    the HBase version string as reported by the HMaster
    +
    +
  + + + +
  - +
    getDeadServerNames
    +
```
List<ServerName> getDeadServerNames()
```
    +
    +
    返回:
    +
    the names of region servers on the dead list
    +
    +
  + + + +
  - +
    getLiveServerMetrics
    +
```
Map<ServerName,ServerMetrics> getLiveServerMetrics()
```
    +
    +
    返回:
    +
    the names of region servers on the live list
    +
    +
  + + + +
  - +
    getRegionCount
    +
```
default int getRegionCount()
```
    +
    +
    返回:
    +
    the number of regions deployed on the cluster
    +
    +
  + + + +
  - +
    getRequestCount
    +
```
default long getRequestCount()
```
    +
    +
    返回:
    +
    the number of requests since last report
    +
    +
  + + + +
  - +
    getMasterName
    +
```
@Nullable
+ServerName getMasterName()
```
    +
    Returns detailed information about the current master ServerName.
    +
    +
    返回:
    +
    current master information if it exists
    +
    +
  + + + +
  - +
    getBackupMasterNames
    +
```
List<ServerName> getBackupMasterNames()
```
    +
    +
    返回:
    +
    the names of backup masters
    +
    +
  + + + +
  - +
    getRegionStatesInTransition
    +
```
@InterfaceAudience.Private
+List<RegionState> getRegionStatesInTransition()
```
    +
  + + + +
  - +
    getClusterId
    +
```
@Nullable
+String getClusterId()
```
    +
  + + + +
  - +
    getMasterCoprocessorNames
    +
```
List<String> getMasterCoprocessorNames()
```
    +
  + + + +
  - +
    getLastMajorCompactionTimestamp
    +
```
default long getLastMajorCompactionTimestamp(TableName table)
```
    +
  + + + +
  - +
    getLastMajorCompactionTimestamp
    +
```
default long getLastMajorCompactionTimestamp(byte[] regionName)
```
    +
  + + + +
  - +
    getBalancerOn
    +
```
@Nullable
+Boolean getBalancerOn()
```
    +
  + + + +
  - +
    getMasterInfoPort
    +
```
int getMasterInfoPort()
```
    +
  + + + +
  - +
    getAverageLoad
    +
```
default double getAverageLoad()
```
    +
    +
    返回:
    +
    the average cluster load
    +
    +
  +
+

java.lang.Object
+
- org.apache.hadoop.hbase.ClusterMetricsBuilder
+

+
+

@InterfaceAudience.Private
+public final class ClusterMetricsBuilder
+extends Object

+ +

+ + +

方法概要

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`ClusterMetrics`	`build()`
`static ClusterMetricsBuilder`	`newBuilder()`
`ClusterMetricsBuilder`	`setBackerMasterNames(List<ServerName> value)`
`ClusterMetricsBuilder`	`setBalancerOn(Boolean value)`
`ClusterMetricsBuilder`	`setClusterId(String value)`
`ClusterMetricsBuilder`	`setDeadServerNames(List<ServerName> value)`
`ClusterMetricsBuilder`	`setHBaseVersion(String value)`
`ClusterMetricsBuilder`	`setLiveServerMetrics(Map<ServerName,ServerMetrics> value)`
`ClusterMetricsBuilder`	`setMasterCoprocessorNames(List<String> value)`
`ClusterMetricsBuilder`	`setMasterInfoPort(int value)`
`ClusterMetricsBuilder`	`setMasterName(ServerName value)`
`ClusterMetricsBuilder`	`setRegionsInTransition(List<RegionState> value)`
`static ClusterMetrics`	`toClusterMetrics(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.ClusterStatus proto)`
`static org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.ClusterStatus`	`toClusterStatus(ClusterMetrics metrics)`
`static org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option`	`toOption(ClusterMetrics.Option option)` + Convert ClusterMetrics.Option to ClusterStatusProtos.Option +
`static ClusterMetrics.Option`	`toOption(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option option)` + Convert ClusterStatusProtos.Option to ClusterMetrics.Option +
`static List<org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option>`	`toOptions(EnumSet<ClusterMetrics.Option> options)` + Convert an enum set of ClusterMetrics.Option to a list of ClusterStatusProtos.Option +
`static EnumSet<ClusterMetrics.Option>`	`toOptions(List<org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option> options)` + Convert a list of ClusterStatusProtos.Option to an enum set of ClusterMetrics.Option +

+ + +
从类继承的方法 java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +

方法详细资料

+ + + +

toClusterStatus

public static org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.ClusterStatus toClusterStatus(ClusterMetrics metrics)

+ + + +

toClusterMetrics

public static ClusterMetrics toClusterMetrics(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.ClusterStatus proto)

+ + + +

+
toOption
+
```
public static ClusterMetrics.Option toOption(org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option option)
```
+
Convert ClusterStatusProtos.Option to ClusterMetrics.Option
+
+
参数:
+
option - a ClusterStatusProtos.Option
+
返回:
+
converted ClusterMetrics.Option
+
+

+ + + +

+
toOption
+
```
public static org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option toOption(ClusterMetrics.Option option)
```
+
Convert ClusterMetrics.Option to ClusterStatusProtos.Option
+
+
参数:
+
option - a ClusterMetrics.Option
+
返回:
+
converted ClusterStatusProtos.Option
+
+

+ + + +

+
toOptions
+
```
public static EnumSet<ClusterMetrics.Option> toOptions(List<org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option> options)
```
+
Convert a list of ClusterStatusProtos.Option to an enum set of ClusterMetrics.Option
+
+
参数:
+
options - the pb options
+
返回:
+
an enum set of ClusterMetrics.Option
+
+

+ + + +

+
toOptions
+
```
public static List<org.apache.hadoop.hbase.shaded.protobuf.generated.ClusterStatusProtos.Option> toOptions(EnumSet<ClusterMetrics.Option> options)
```
+
Convert an enum set of ClusterMetrics.Option to a list of ClusterStatusProtos.Option
+
+
参数:
+
options - the ClusterMetrics options
+
返回:
+
a list of ClusterStatusProtos.Option
+
+

+ + + +

newBuilder

public static ClusterMetricsBuilder newBuilder()

+ + + +

setHBaseVersion

public ClusterMetricsBuilder setHBaseVersion(String value)

+ + + +

setDeadServerNames

public ClusterMetricsBuilder setDeadServerNames(List<ServerName> value)

+ + + +

setLiveServerMetrics

public ClusterMetricsBuilder setLiveServerMetrics(Map<ServerName,ServerMetrics> value)

+ + + +

setMasterName

public ClusterMetricsBuilder setMasterName(ServerName value)

+ + + +

setBackerMasterNames

public ClusterMetricsBuilder setBackerMasterNames(List<ServerName> value)

+ + + +

setRegionsInTransition

public ClusterMetricsBuilder setRegionsInTransition(List<RegionState> value)

+ + + +

setClusterId

public ClusterMetricsBuilder setClusterId(String value)

+ + + +

setMasterCoprocessorNames

public ClusterMetricsBuilder setMasterCoprocessorNames(List<String> value)

+ + + +

setBalancerOn

public ClusterMetricsBuilder setBalancerOn(@Nullable
+                                           Boolean value)

+ + + +

setMasterInfoPort

public ClusterMetricsBuilder setMasterInfoPort(int value)

+ + + +

+
build
+
```
public ClusterMetrics build()
```
+

接口 ClusterMetrics

嵌套类概要

方法概要

方法详细资料

getHBaseVersion

getDeadServerNames

getLiveServerMetrics

getRegionCount

getRequestCount

getMasterName

getBackupMasterNames

getRegionStatesInTransition

getClusterId

getMasterCoprocessorNames

getLastMajorCompactionTimestamp

getLastMajorCompactionTimestamp

getBalancerOn

getMasterInfoPort

getAverageLoad

类 ClusterMetricsBuilder

方法概要

从类继承的方法 java.lang.Object

方法详细资料

toClusterStatus

toClusterMetrics

toOption

toOption

toOptions

toOptions

newBuilder

setHBaseVersion

setDeadServerNames

setLiveServerMetrics

setMasterName

setBackerMasterNames

setRegionsInTransition

setClusterId

setMasterCoprocessorNames

setBalancerOn

setMasterInfoPort

build