| <!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, interface: ServerMetrics"> |
| <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;</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 edu.umd.cs.findbugs.annotations.Nullable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.List;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Map;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Set;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.replication.ReplicationLoadSink;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.replication.ReplicationLoadSource;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * This class is used for exporting current state of load on a RegionServer.</span> |
| <span class="source-line-no">030</span><span id="line-30"> */</span> |
| <span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.Public</span> |
| <span class="source-line-no">032</span><span id="line-32">public interface ServerMetrics {</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34"> ServerName getServerName();</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36"> /** Returns the version number of a regionserver. */</span> |
| <span class="source-line-no">037</span><span id="line-37"> default int getVersionNumber() {</span> |
| <span class="source-line-no">038</span><span id="line-38"> return 0;</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"> /** Returns the string type version of a regionserver. */</span> |
| <span class="source-line-no">042</span><span id="line-42"> default String getVersion() {</span> |
| <span class="source-line-no">043</span><span id="line-43"> return "0.0.0";</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"> /** Returns the number of requests per second. */</span> |
| <span class="source-line-no">047</span><span id="line-47"> long getRequestCountPerSecond();</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> /** Returns total Number of requests from the start of the region server. */</span> |
| <span class="source-line-no">050</span><span id="line-50"> long getRequestCount();</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> /** Returns total Number of read requests from the start of the region server. */</span> |
| <span class="source-line-no">053</span><span id="line-53"> long getReadRequestsCount();</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> /** Returns total Number of write requests from the start of the region server. */</span> |
| <span class="source-line-no">056</span><span id="line-56"> long getWriteRequestsCount();</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /** Returns the amount of used heap */</span> |
| <span class="source-line-no">059</span><span id="line-59"> Size getUsedHeapSize();</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /** Returns the maximum allowable size of the heap */</span> |
| <span class="source-line-no">062</span><span id="line-62"> Size getMaxHeapSize();</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> int getInfoServerPort();</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Call directly from client such as hbase shell</span> |
| <span class="source-line-no">068</span><span id="line-68"> * @return the list of ReplicationLoadSource</span> |
| <span class="source-line-no">069</span><span id="line-69"> */</span> |
| <span class="source-line-no">070</span><span id="line-70"> List<ReplicationLoadSource> getReplicationLoadSourceList();</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * Call directly from client such as hbase shell</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @return a map of ReplicationLoadSource list per peer id</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> Map<String, List<ReplicationLoadSource>> getReplicationLoadSourceMap();</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> /**</span> |
| <span class="source-line-no">079</span><span id="line-79"> * Call directly from client such as hbase shell</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> @Nullable</span> |
| <span class="source-line-no">082</span><span id="line-82"> ReplicationLoadSink getReplicationLoadSink();</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /** Returns region load metrics */</span> |
| <span class="source-line-no">085</span><span id="line-85"> Map<byte[], RegionMetrics> getRegionMetrics();</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /** Returns metrics per user */</span> |
| <span class="source-line-no">088</span><span id="line-88"> Map<byte[], UserMetrics> getUserMetrics();</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> /**</span> |
| <span class="source-line-no">091</span><span id="line-91"> * Return the RegionServer-level and Region-level coprocessors</span> |
| <span class="source-line-no">092</span><span id="line-92"> * @return string set of loaded RegionServer-level and Region-level coprocessors</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> Set<String> getCoprocessorNames();</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /** Returns the timestamp (server side) of generating this metrics */</span> |
| <span class="source-line-no">097</span><span id="line-97"> long getReportTimestamp();</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /** Returns the last timestamp (server side) of generating this metrics */</span> |
| <span class="source-line-no">100</span><span id="line-100"> long getLastReportTimestamp();</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /**</span> |
| <span class="source-line-no">103</span><span id="line-103"> * Called directly from clients such as the hbase shell</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @return the active monitored tasks</span> |
| <span class="source-line-no">105</span><span id="line-105"> */</span> |
| <span class="source-line-no">106</span><span id="line-106"> @Nullable</span> |
| <span class="source-line-no">107</span><span id="line-107"> List<ServerTask> getTasks();</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"> * Returns the region cache information for the regions hosted on this server</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @return map of region encoded name and the size of the region cached on this region server</span> |
| <span class="source-line-no">112</span><span id="line-112"> * rounded to MB</span> |
| <span class="source-line-no">113</span><span id="line-113"> */</span> |
| <span class="source-line-no">114</span><span id="line-114"> Map<String, Integer> getRegionCachedInfo();</span> |
| <span class="source-line-no">115</span><span id="line-115">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
