| <!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.metrics, interface: BaseSource"> |
| <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.metrics;</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.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">/**</span> |
| <span class="source-line-no">023</span><span id="line-23"> * BaseSource for dynamic metrics to announce to Metrics2. In hbase-hadoop{1|2}-compat there is an</span> |
| <span class="source-line-no">024</span><span id="line-24"> * implementation of this interface.</span> |
| <span class="source-line-no">025</span><span id="line-25"> */</span> |
| <span class="source-line-no">026</span><span id="line-26">@InterfaceAudience.Private</span> |
| <span class="source-line-no">027</span><span id="line-27">public interface BaseSource {</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29"> String HBASE_METRICS_SYSTEM_NAME = "HBase";</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31"> /**</span> |
| <span class="source-line-no">032</span><span id="line-32"> * Clear out the metrics and re-prepare the source.</span> |
| <span class="source-line-no">033</span><span id="line-33"> */</span> |
| <span class="source-line-no">034</span><span id="line-34"> void init();</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36"> /**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * Set a gauge to a specific value.</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @param gaugeName the name of the gauge</span> |
| <span class="source-line-no">039</span><span id="line-39"> * @param value the value</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41"> void setGauge(String gaugeName, long value);</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> /**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * Add some amount to a gauge.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * @param gaugeName the name of the gauge</span> |
| <span class="source-line-no">046</span><span id="line-46"> * @param delta the amount to change the gauge by.</span> |
| <span class="source-line-no">047</span><span id="line-47"> */</span> |
| <span class="source-line-no">048</span><span id="line-48"> void incGauge(String gaugeName, long delta);</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> /**</span> |
| <span class="source-line-no">051</span><span id="line-51"> * Subtract some amount from a gauge.</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @param gaugeName the name of the gauge</span> |
| <span class="source-line-no">053</span><span id="line-53"> * @param delta the amount to change the gauge by.</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> void decGauge(String gaugeName, long delta);</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * Remove a metric and no longer announce it.</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @param key Name of the gauge to remove.</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> void removeMetric(String key);</span> |
| <span class="source-line-no">062</span><span id="line-62"></span> |
| <span class="source-line-no">063</span><span id="line-63"> /**</span> |
| <span class="source-line-no">064</span><span id="line-64"> * Add some amount to a counter.</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @param counterName the name of the counter</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @param delta the amount to change the counter by.</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> void incCounters(String counterName, long delta);</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> /**</span> |
| <span class="source-line-no">071</span><span id="line-71"> * Add some value to a histogram.</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param name the name of the histogram</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @param value the value to add to the histogram</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> void updateHistogram(String name, long value);</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * Get the metrics context. For hadoop metrics2 system this is usually an all lowercased string.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * eg. regionserver, master, thriftserver</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @return The string context used to register this source to hadoop's metrics2 system.</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> String getMetricsContext();</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * Get the description of what this source exposes.</span> |
| <span class="source-line-no">086</span><span id="line-86"> */</span> |
| <span class="source-line-no">087</span><span id="line-87"> String getMetricsDescription();</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> /**</span> |
| <span class="source-line-no">090</span><span id="line-90"> * Get the name of the context in JMX that this source will be exposed through. This is in</span> |
| <span class="source-line-no">091</span><span id="line-91"> * ObjectName format. With the default context being Hadoop -&gt; HBase</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> String getMetricsJmxContext();</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Get the name of the metrics that are being exported by this source. Eg. IPC, GC, WAL</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> String getMetricsName();</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> default MetricRegistryInfo getMetricRegistryInfo() {</span> |
| <span class="source-line-no">101</span><span id="line-101"> return new MetricRegistryInfo(getMetricsName(), getMetricsDescription(), getMetricsContext(),</span> |
| <span class="source-line-no">102</span><span id="line-102"> getMetricsJmxContext(), true);</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
