blob: 5a35199c33625b3c1b401d0d111ea514b7610fd6 [file] [log] [blame]
<!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.io, interface: MetricsIOSource">
<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.io;</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.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">@InterfaceAudience.Private</span>
<span class="source-line-no">024</span><span id="line-24">public interface MetricsIOSource extends BaseSource {</span>
<span class="source-line-no">025</span><span id="line-25"></span>
<span class="source-line-no">026</span><span id="line-26"> /**</span>
<span class="source-line-no">027</span><span id="line-27"> * The name of the metrics</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 METRICS_NAME = "IO";</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"> * The name of the metrics context that metrics will be under.</span>
<span class="source-line-no">033</span><span id="line-33"> */</span>
<span class="source-line-no">034</span><span id="line-34"> String METRICS_CONTEXT = "regionserver";</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"> * Description</span>
<span class="source-line-no">038</span><span id="line-38"> */</span>
<span class="source-line-no">039</span><span id="line-39"> String METRICS_DESCRIPTION = "Metrics about FileSystem IO";</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> /**</span>
<span class="source-line-no">042</span><span id="line-42"> * The name of the metrics context that metrics will be under in jmx</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44"> String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> String FS_READ_TIME_HISTO_KEY = "fsReadTime";</span>
<span class="source-line-no">047</span><span id="line-47"> String FS_PREAD_TIME_HISTO_KEY = "fsPReadTime";</span>
<span class="source-line-no">048</span><span id="line-48"> String FS_WRITE_HISTO_KEY = "fsWriteTime";</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> String SLOW_FS_READS_KEY = "fsSlowReadsCount";</span>
<span class="source-line-no">051</span><span id="line-51"> String SLOW_FS_READS_DESC = "Number of HFile reads which were slower than a configured threshold";</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> String CHECKSUM_FAILURES_KEY = "fsChecksumFailureCount";</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> String FS_READ_TIME_HISTO_DESC =</span>
<span class="source-line-no">056</span><span id="line-56"> "Latency of HFile's sequential reads on this region server in milliseconds";</span>
<span class="source-line-no">057</span><span id="line-57"> String FS_PREAD_TIME_HISTO_DESC =</span>
<span class="source-line-no">058</span><span id="line-58"> "Latency of HFile's positional reads on this region server in milliseconds";</span>
<span class="source-line-no">059</span><span id="line-59"> String FS_WRITE_TIME_HISTO_DESC =</span>
<span class="source-line-no">060</span><span id="line-60"> "Latency of HFile's writes on this region server in milliseconds";</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> String CHECKSUM_FAILURES_DESC = "Number of checksum failures for the HBase HFile checksums at the"</span>
<span class="source-line-no">063</span><span id="line-63"> + " HBase level (separate from HDFS checksums)";</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> /**</span>
<span class="source-line-no">066</span><span id="line-66"> * Update the fs sequential read time histogram</span>
<span class="source-line-no">067</span><span id="line-67"> * @param t time it took, in milliseconds</span>
<span class="source-line-no">068</span><span id="line-68"> */</span>
<span class="source-line-no">069</span><span id="line-69"> void updateFsReadTime(long t);</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> /**</span>
<span class="source-line-no">072</span><span id="line-72"> * Update the fs positional read time histogram</span>
<span class="source-line-no">073</span><span id="line-73"> * @param t time it took, in milliseconds</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 updateFsPReadTime(long t);</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"> * Update the fs write time histogram</span>
<span class="source-line-no">079</span><span id="line-79"> * @param t time it took, in milliseconds</span>
<span class="source-line-no">080</span><span id="line-80"> */</span>
<span class="source-line-no">081</span><span id="line-81"> void updateFsWriteTime(long t);</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> void incrSlowFsRead();</span>
<span class="source-line-no">084</span><span id="line-84">}</span>
</pre>
</div>
</main>
</body>
</html>