View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.hadoop.hbase.master;
20  
21  import org.apache.hadoop.hbase.metrics.BaseSource;
22  import org.apache.hadoop.hbase.metrics.JvmPauseMonitorSource;
23  
24  /**
25   * Interface that classes that expose metrics about the master will implement.
26   */
27  public interface MetricsMasterSource extends BaseSource, JvmPauseMonitorSource {
28  
29    /**
30     * The name of the metrics
31     */
32    String METRICS_NAME = "Server";
33  
34    /**
35     * The context metrics will be under.
36     */
37    String METRICS_CONTEXT = "master";
38  
39    /**
40     * The name of the metrics context that metrics will be under in jmx
41     */
42    String METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;
43  
44    /**
45     * Description
46     */
47    String METRICS_DESCRIPTION = "Metrics about HBase master server";
48  
49    // Strings used for exporting to metrics system.
50    String MASTER_ACTIVE_TIME_NAME = "masterActiveTime";
51    String MASTER_START_TIME_NAME = "masterStartTime";
52    String AVERAGE_LOAD_NAME = "averageLoad";
53    String LIVE_REGION_SERVERS_NAME = "liveRegionServers";
54    String DEAD_REGION_SERVERS_NAME = "deadRegionServers";
55    String NUM_REGION_SERVERS_NAME = "numRegionServers";
56    String NUM_DEAD_REGION_SERVERS_NAME = "numDeadRegionServers";
57    String ZOOKEEPER_QUORUM_NAME = "zookeeperQuorum";
58    String SERVER_NAME_NAME = "serverName";
59    String CLUSTER_ID_NAME = "clusterId";
60    String IS_ACTIVE_MASTER_NAME = "isActiveMaster";
61  
62  
63    String CLUSTER_REQUESTS_NAME = "clusterRequests";
64    String MASTER_ACTIVE_TIME_DESC = "Master Active Time";
65    String MASTER_START_TIME_DESC = "Master Start Time";
66    String AVERAGE_LOAD_DESC = "AverageLoad";
67    String LIVE_REGION_SERVERS_DESC = "Names of live RegionServers";
68    String NUMBER_OF_REGION_SERVERS_DESC = "Number of RegionServers";
69    String DEAD_REGION_SERVERS_DESC = "Names of dead RegionServers";
70    String NUMBER_OF_DEAD_REGION_SERVERS_DESC = "Number of dead RegionServers";
71    String ZOOKEEPER_QUORUM_DESC = "Zookeeper Quorum";
72    String SERVER_NAME_DESC = "Server Name";
73    String CLUSTER_ID_DESC = "Cluster Id";
74    String IS_ACTIVE_MASTER_DESC = "Is Active Master";
75  
76  
77  
78    /**
79     * Increment the number of requests the cluster has seen.
80     *
81     * @param inc Ammount to increment the total by.
82     */
83    void incRequests(final int inc);
84  
85    
86  
87  
88  }