blob: 152557563d22b268d7fa41cd322c0732e9db2a8d [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.regionserver.wal, interface: MetricsWALSource">
<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.regionserver.wal;</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.TableName;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.metrics.BaseSource;</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 of the source that will export metrics about the region server's WAL.</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 MetricsWALSource 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 = "WAL";</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 name of the metrics context that 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 = "regionserver";</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"> * Description</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_DESCRIPTION = "Metrics about HBase RegionServer WAL";</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"> * The name of the metrics context that metrics will be under in jmx</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_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;</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 APPEND_TIME = "appendTime";</span>
<span class="source-line-no">051</span><span id="line-51"> String APPEND_TIME_DESC = "Time an append to the log took.";</span>
<span class="source-line-no">052</span><span id="line-52"> String APPEND_COUNT = "appendCount";</span>
<span class="source-line-no">053</span><span id="line-53"> String APPEND_COUNT_DESC = "Number of appends to the write ahead log.";</span>
<span class="source-line-no">054</span><span id="line-54"> String APPEND_SIZE = "appendSize";</span>
<span class="source-line-no">055</span><span id="line-55"> String APPEND_SIZE_DESC = "Size (in bytes) of the data appended to the WAL.";</span>
<span class="source-line-no">056</span><span id="line-56"> String SLOW_APPEND_COUNT = "slowAppendCount";</span>
<span class="source-line-no">057</span><span id="line-57"> String SLOW_APPEND_COUNT_DESC = "Number of appends that were slow.";</span>
<span class="source-line-no">058</span><span id="line-58"> String SYNC_TIME = "syncTime";</span>
<span class="source-line-no">059</span><span id="line-59"> String SYNC_TIME_DESC = "The time it took to sync the WAL to HDFS.";</span>
<span class="source-line-no">060</span><span id="line-60"> String ROLL_REQUESTED = "rollRequest";</span>
<span class="source-line-no">061</span><span id="line-61"> String ROLL_REQUESTED_DESC = "How many times a roll has been requested total";</span>
<span class="source-line-no">062</span><span id="line-62"> String ERROR_ROLL_REQUESTED = "errorRollRequest";</span>
<span class="source-line-no">063</span><span id="line-63"> String ERROR_ROLL_REQUESTED_DESC =</span>
<span class="source-line-no">064</span><span id="line-64"> "How many times a roll was requested due to I/O or other errors.";</span>
<span class="source-line-no">065</span><span id="line-65"> String LOW_REPLICA_ROLL_REQUESTED = "lowReplicaRollRequest";</span>
<span class="source-line-no">066</span><span id="line-66"> String LOW_REPLICA_ROLL_REQUESTED_DESC =</span>
<span class="source-line-no">067</span><span id="line-67"> "How many times a roll was requested due to too few datanodes in the write pipeline.";</span>
<span class="source-line-no">068</span><span id="line-68"> String SLOW_SYNC_ROLL_REQUESTED = "slowSyncRollRequest";</span>
<span class="source-line-no">069</span><span id="line-69"> String SLOW_SYNC_ROLL_REQUESTED_DESC =</span>
<span class="source-line-no">070</span><span id="line-70"> "How many times a roll was requested due to sync too slow on the write pipeline.";</span>
<span class="source-line-no">071</span><span id="line-71"> String SIZE_ROLL_REQUESTED = "sizeRollRequest";</span>
<span class="source-line-no">072</span><span id="line-72"> String SIZE_ROLL_REQUESTED_DESC =</span>
<span class="source-line-no">073</span><span id="line-73"> "How many times a roll was requested due to file size roll threshold.";</span>
<span class="source-line-no">074</span><span id="line-74"> String WRITTEN_BYTES = "writtenBytes";</span>
<span class="source-line-no">075</span><span id="line-75"> String WRITTEN_BYTES_DESC = "Size (in bytes) of the data written to the WAL.";</span>
<span class="source-line-no">076</span><span id="line-76"> String SUCCESSFUL_LOG_ROLLS = "successfulLogRolls";</span>
<span class="source-line-no">077</span><span id="line-77"> String SUCCESSFUL_LOG_ROLLS_DESC = "Number of successful log rolls requests";</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> /**</span>
<span class="source-line-no">080</span><span id="line-80"> * Add the append size.</span>
<span class="source-line-no">081</span><span id="line-81"> */</span>
<span class="source-line-no">082</span><span id="line-82"> void incrementAppendSize(TableName tableName, long size);</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"> * Add the time it took to append.</span>
<span class="source-line-no">086</span><span id="line-86"> */</span>
<span class="source-line-no">087</span><span id="line-87"> void incrementAppendTime(long time);</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"> * Increment the count of wal appends</span>
<span class="source-line-no">091</span><span id="line-91"> */</span>
<span class="source-line-no">092</span><span id="line-92"> void incrementAppendCount(TableName tableName);</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> /**</span>
<span class="source-line-no">095</span><span id="line-95"> * Increment the number of appends that were slow</span>
<span class="source-line-no">096</span><span id="line-96"> */</span>
<span class="source-line-no">097</span><span id="line-97"> void incrementSlowAppendCount();</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> /**</span>
<span class="source-line-no">100</span><span id="line-100"> * Add the time it took to sync the wal.</span>
<span class="source-line-no">101</span><span id="line-101"> */</span>
<span class="source-line-no">102</span><span id="line-102"> void incrementSyncTime(long time);</span>
<span class="source-line-no">103</span><span id="line-103"></span>
<span class="source-line-no">104</span><span id="line-104"> void incrementLogRollRequested();</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> void incrementErrorLogRoll();</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> void incrementLowReplicationLogRoll();</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> long getSlowAppendCount();</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> void incrementSlowSyncLogRoll();</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> void incrementSizeLogRoll();</span>
<span class="source-line-no">115</span><span id="line-115"></span>
<span class="source-line-no">116</span><span id="line-116"> void incrementWrittenBytes(long val);</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> /**</span>
<span class="source-line-no">119</span><span id="line-119"> * Increment the number of successful log roll requests.</span>
<span class="source-line-no">120</span><span id="line-120"> */</span>
<span class="source-line-no">121</span><span id="line-121"> void incrementSuccessfulLogRolls();</span>
<span class="source-line-no">122</span><span id="line-122"></span>
<span class="source-line-no">123</span><span id="line-123"> long getSuccessfulLogRolls();</span>
<span class="source-line-no">124</span><span id="line-124">}</span>
</pre>
</div>
</main>
</body>
</html>