| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.master, interface: MetricsMasterSource"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.master;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import org.apache.hadoop.hbase.metrics.BaseSource;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.metrics.OperationMetrics;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">/**</span> |
| <span class="source-line-no">025</span><span id="line-25"> * Interface that classes that expose metrics about the master will implement.</span> |
| <span class="source-line-no">026</span><span id="line-26"> */</span> |
| <span class="source-line-no">027</span><span id="line-27">@InterfaceAudience.Private</span> |
| <span class="source-line-no">028</span><span id="line-28">public interface MetricsMasterSource extends BaseSource {</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30"> /**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * The name of the metrics</span> |
| <span class="source-line-no">032</span><span id="line-32"> */</span> |
| <span class="source-line-no">033</span><span id="line-33"> String METRICS_NAME = "Server";</span> |
| <span class="source-line-no">034</span><span id="line-34"></span> |
| <span class="source-line-no">035</span><span id="line-35"> /**</span> |
| <span class="source-line-no">036</span><span id="line-36"> * The context metrics will be under.</span> |
| <span class="source-line-no">037</span><span id="line-37"> */</span> |
| <span class="source-line-no">038</span><span id="line-38"> String METRICS_CONTEXT = "master";</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40"> /**</span> |
| <span class="source-line-no">041</span><span id="line-41"> * The name of the metrics context that metrics will be under in jmx</span> |
| <span class="source-line-no">042</span><span id="line-42"> */</span> |
| <span class="source-line-no">043</span><span id="line-43"> String METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> /**</span> |
| <span class="source-line-no">046</span><span id="line-46"> * Description</span> |
| <span class="source-line-no">047</span><span id="line-47"> */</span> |
| <span class="source-line-no">048</span><span id="line-48"> String METRICS_DESCRIPTION = "Metrics about HBase master server";</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> // Strings used for exporting to metrics system.</span> |
| <span class="source-line-no">051</span><span id="line-51"> String MASTER_ACTIVE_TIME_NAME = "masterActiveTime";</span> |
| <span class="source-line-no">052</span><span id="line-52"> String MASTER_START_TIME_NAME = "masterStartTime";</span> |
| <span class="source-line-no">053</span><span id="line-53"> String MASTER_FINISHED_INITIALIZATION_TIME_NAME = "masterFinishedInitializationTime";</span> |
| <span class="source-line-no">054</span><span id="line-54"> String AVERAGE_LOAD_NAME = "averageLoad";</span> |
| <span class="source-line-no">055</span><span id="line-55"> String LIVE_REGION_SERVERS_NAME = "liveRegionServers";</span> |
| <span class="source-line-no">056</span><span id="line-56"> String DEAD_REGION_SERVERS_NAME = "deadRegionServers";</span> |
| <span class="source-line-no">057</span><span id="line-57"> String DRAINING_REGION_SERVER_NAME = "drainingRegionServers";</span> |
| <span class="source-line-no">058</span><span id="line-58"> String NUM_REGION_SERVERS_NAME = "numRegionServers";</span> |
| <span class="source-line-no">059</span><span id="line-59"> String NUM_DEAD_REGION_SERVERS_NAME = "numDeadRegionServers";</span> |
| <span class="source-line-no">060</span><span id="line-60"> String NUM_DRAINING_REGION_SERVERS_NAME = "numDrainingRegionServers";</span> |
| <span class="source-line-no">061</span><span id="line-61"> String ZOOKEEPER_QUORUM_NAME = "zookeeperQuorum";</span> |
| <span class="source-line-no">062</span><span id="line-62"> String SERVER_NAME_NAME = "serverName";</span> |
| <span class="source-line-no">063</span><span id="line-63"> String CLUSTER_ID_NAME = "clusterId";</span> |
| <span class="source-line-no">064</span><span id="line-64"> String IS_ACTIVE_MASTER_NAME = "isActiveMaster";</span> |
| <span class="source-line-no">065</span><span id="line-65"> String SPLIT_PLAN_COUNT_NAME = "splitPlanCount";</span> |
| <span class="source-line-no">066</span><span id="line-66"> String MERGE_PLAN_COUNT_NAME = "mergePlanCount";</span> |
| <span class="source-line-no">067</span><span id="line-67"> String ONLINE_REGION_COUNT_NAME = "onlineRegionCount";</span> |
| <span class="source-line-no">068</span><span id="line-68"> String OFFLINE_REGION_COUNT_NAME = "offlineRegionCount";</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> String CLUSTER_REQUESTS_NAME = "clusterRequests";</span> |
| <span class="source-line-no">071</span><span id="line-71"> String CLUSTER_READ_REQUESTS_NAME = "clusterReadRequests";</span> |
| <span class="source-line-no">072</span><span id="line-72"> String CLUSTER_WRITE_REQUESTS_NAME = "clusterWriteRequests";</span> |
| <span class="source-line-no">073</span><span id="line-73"> String OLD_WAL_DIR_SIZE_NAME = "oldWALsDirSize";</span> |
| <span class="source-line-no">074</span><span id="line-74"> String MASTER_ACTIVE_TIME_DESC = "Master Active Time";</span> |
| <span class="source-line-no">075</span><span id="line-75"> String MASTER_START_TIME_DESC = "Master Start Time";</span> |
| <span class="source-line-no">076</span><span id="line-76"> String MASTER_FINISHED_INITIALIZATION_TIME_DESC =</span> |
| <span class="source-line-no">077</span><span id="line-77"> "Timestamp when Master has finished initializing";</span> |
| <span class="source-line-no">078</span><span id="line-78"> String AVERAGE_LOAD_DESC = "AverageLoad";</span> |
| <span class="source-line-no">079</span><span id="line-79"> String LIVE_REGION_SERVERS_DESC = "Names of live RegionServers";</span> |
| <span class="source-line-no">080</span><span id="line-80"> String NUMBER_OF_REGION_SERVERS_DESC = "Number of RegionServers";</span> |
| <span class="source-line-no">081</span><span id="line-81"> String DEAD_REGION_SERVERS_DESC = "Names of dead RegionServers";</span> |
| <span class="source-line-no">082</span><span id="line-82"> String NUMBER_OF_DEAD_REGION_SERVERS_DESC = "Number of dead RegionServers";</span> |
| <span class="source-line-no">083</span><span id="line-83"> String DRAINING_REGION_SERVER_DESC = "Names of draining RegionServers";</span> |
| <span class="source-line-no">084</span><span id="line-84"> String NUMBER_OF_DRAINING_REGION_SERVERS_DESC = "Number of draining RegionServers";</span> |
| <span class="source-line-no">085</span><span id="line-85"> String ZOOKEEPER_QUORUM_DESC = "ZooKeeper Quorum";</span> |
| <span class="source-line-no">086</span><span id="line-86"> String SERVER_NAME_DESC = "Server Name";</span> |
| <span class="source-line-no">087</span><span id="line-87"> String CLUSTER_ID_DESC = "Cluster Id";</span> |
| <span class="source-line-no">088</span><span id="line-88"> String IS_ACTIVE_MASTER_DESC = "Is Active Master";</span> |
| <span class="source-line-no">089</span><span id="line-89"> String SPLIT_PLAN_COUNT_DESC = "Number of Region Split Plans executed";</span> |
| <span class="source-line-no">090</span><span id="line-90"> String MERGE_PLAN_COUNT_DESC = "Number of Region Merge Plans executed";</span> |
| <span class="source-line-no">091</span><span id="line-91"> String ONLINE_REGION_COUNT_DESC = "Number of Online Regions";</span> |
| <span class="source-line-no">092</span><span id="line-92"> String OFFLINE_REGION_COUNT_DESC = "Number of Offline Regions";</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> String SERVER_CRASH_METRIC_PREFIX = "serverCrash";</span> |
| <span class="source-line-no">095</span><span id="line-95"> String OLD_WAL_DIR_SIZE_DESC = "size of old WALs directory in bytes";</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> /**</span> |
| <span class="source-line-no">098</span><span id="line-98"> * Increment the number of requests the cluster has seen.</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @param inc Ammount to increment the total by.</span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101"> void incRequests(final long inc);</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> /**</span> |
| <span class="source-line-no">104</span><span id="line-104"> * Increment the number of read requests the cluster has seen.</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param inc Ammount to increment the total by.</span> |
| <span class="source-line-no">106</span><span id="line-106"> */</span> |
| <span class="source-line-no">107</span><span id="line-107"> void incReadRequests(final long inc);</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> /**</span> |
| <span class="source-line-no">110</span><span id="line-110"> * Increment the number of write requests the cluster has seen.</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @param inc Ammount to increment the total by.</span> |
| <span class="source-line-no">112</span><span id="line-112"> */</span> |
| <span class="source-line-no">113</span><span id="line-113"> void incWriteRequests(final long inc);</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /** Returns {@link OperationMetrics} containing common metrics for server crash operation */</span> |
| <span class="source-line-no">116</span><span id="line-116"> OperationMetrics getServerCrashMetrics();</span> |
| <span class="source-line-no">117</span><span id="line-117">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
