| <!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.zookeeper, interface: MetricsZooKeeperSource"> |
| <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.zookeeper;</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">/**</span> |
| <span class="source-line-no">024</span><span id="line-24"> * Interface of the source that will export metrics about the ZooKeeper.</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 MetricsZooKeeperSource extends 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"> /**</span> |
| <span class="source-line-no">030</span><span id="line-30"> * The name of the metrics</span> |
| <span class="source-line-no">031</span><span id="line-31"> */</span> |
| <span class="source-line-no">032</span><span id="line-32"> String METRICS_NAME = "ZOOKEEPER";</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34"> /**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * The name of the metrics context that metrics will be under.</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37"> String METRICS_CONTEXT = "zookeeper";</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39"> /**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * Description</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42"> String METRICS_DESCRIPTION = "Metrics about ZooKeeper";</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> /**</span> |
| <span class="source-line-no">045</span><span id="line-45"> * The name of the metrics context that metrics will be under in jmx.</span> |
| <span class="source-line-no">046</span><span id="line-46"> */</span> |
| <span class="source-line-no">047</span><span id="line-47"> String METRICS_JMX_CONTEXT = "ZooKeeper,sub=" + METRICS_NAME;</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> String EXCEPTION_AUTHFAILED = "AUTHFAILED Exception";</span> |
| <span class="source-line-no">050</span><span id="line-50"> String EXCEPTION_AUTHFAILED_DESC = "Number of failed ops due to an AUTHFAILED exception,";</span> |
| <span class="source-line-no">051</span><span id="line-51"> String EXCEPTION_CONNECTIONLOSS = "CONNECTIONLOSS Exception";</span> |
| <span class="source-line-no">052</span><span id="line-52"> String EXCEPTION_CONNECTIONLOSS_DESC = "Number of failed ops due to a CONNECTIONLOSS exception.";</span> |
| <span class="source-line-no">053</span><span id="line-53"> String EXCEPTION_DATAINCONSISTENCY = "DATAINCONSISTENCY Exception";</span> |
| <span class="source-line-no">054</span><span id="line-54"> String EXCEPTION_DATAINCONSISTENCY_DESC =</span> |
| <span class="source-line-no">055</span><span id="line-55"> "Number of failed ops due to a DATAINCONSISTENCY exception.";</span> |
| <span class="source-line-no">056</span><span id="line-56"> String EXCEPTION_INVALIDACL = "INVALIDACL Exception";</span> |
| <span class="source-line-no">057</span><span id="line-57"> String EXCEPTION_INVALIDACL_DESC = "Number of failed ops due to an INVALIDACL exception";</span> |
| <span class="source-line-no">058</span><span id="line-58"> String EXCEPTION_NOAUTH = "NOAUTH Exception";</span> |
| <span class="source-line-no">059</span><span id="line-59"> String EXCEPTION_NOAUTH_DESC = "Number of failed ops due to a NOAUTH exception.";</span> |
| <span class="source-line-no">060</span><span id="line-60"> String EXCEPTION_OPERATIONTIMEOUT = "OPERATIONTIMEOUT Exception";</span> |
| <span class="source-line-no">061</span><span id="line-61"> String EXCEPTION_OPERATIONTIMEOUT_DESC =</span> |
| <span class="source-line-no">062</span><span id="line-62"> "Number of failed ops due to an OPERATIONTIMEOUT exception.";</span> |
| <span class="source-line-no">063</span><span id="line-63"> String EXCEPTION_RUNTIMEINCONSISTENCY = "RUNTIMEINCONSISTENCY Exception";</span> |
| <span class="source-line-no">064</span><span id="line-64"> String EXCEPTION_RUNTIMEINCONSISTENCY_DESC =</span> |
| <span class="source-line-no">065</span><span id="line-65"> "Number of failed ops due to a RUNTIMEINCONSISTENCY exception.";</span> |
| <span class="source-line-no">066</span><span id="line-66"> String EXCEPTION_SESSIONEXPIRED = "SESSIONEXPIRED Exception";</span> |
| <span class="source-line-no">067</span><span id="line-67"> String EXCEPTION_SESSIONEXPIRED_DESC = "Number of failed ops due to a SESSIONEXPIRED exception.";</span> |
| <span class="source-line-no">068</span><span id="line-68"> String EXCEPTION_SYSTEMERROR = "SYSTEMERROR Exception";</span> |
| <span class="source-line-no">069</span><span id="line-69"> String EXCEPTION_SYSTEMERROR_DESC = "Number of failed ops due to a SYSTEMERROR exception.";</span> |
| <span class="source-line-no">070</span><span id="line-70"> String TOTAL_FAILED_ZK_CALLS = "TotalFailedZKCalls";</span> |
| <span class="source-line-no">071</span><span id="line-71"> String TOTAL_FAILED_ZK_CALLS_DESC = "Total number of failed ZooKeeper API Calls";</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> String READ_OPERATION_LATENCY_NAME = "ReadOperationLatency";</span> |
| <span class="source-line-no">074</span><span id="line-74"> String READ_OPERATION_LATENCY_DESC = "Latency histogram for read operations.";</span> |
| <span class="source-line-no">075</span><span id="line-75"> String WRITE_OPERATION_LATENCY_NAME = "WriteOperationLatency";</span> |
| <span class="source-line-no">076</span><span id="line-76"> String WRITE_OPERATION_LATENCY_DESC = "Latency histogram for write operations.";</span> |
| <span class="source-line-no">077</span><span id="line-77"> String SYNC_OPERATION_LATENCY_NAME = "SyncOperationLatency";</span> |
| <span class="source-line-no">078</span><span id="line-78"> String SYNC_OPERATION_LATENCY_DESC = "Latency histogram for sync operations.";</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> /**</span> |
| <span class="source-line-no">081</span><span id="line-81"> * Increment the count of failed ops due to AUTHFAILED Exception.</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 incrementAuthFailedCount();</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> /**</span> |
| <span class="source-line-no">086</span><span id="line-86"> * Increment the count of failed ops due to a CONNECTIONLOSS Exception.</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> void incrementConnectionLossCount();</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"> * Increment the count of failed ops due to a DATAINCONSISTENCY Exception.</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> void incrementDataInconsistencyCount();</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"> * Increment the count of failed ops due to INVALIDACL Exception.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> void incrementInvalidACLCount();</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> /**</span> |
| <span class="source-line-no">101</span><span id="line-101"> * Increment the count of failed ops due to NOAUTH Exception.</span> |
| <span class="source-line-no">102</span><span id="line-102"> */</span> |
| <span class="source-line-no">103</span><span id="line-103"> void incrementNoAuthCount();</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> |
| <span class="source-line-no">106</span><span id="line-106"> * Increment the count of failed ops due to an OPERATIONTIMEOUT Exception.</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 incrementOperationTimeoutCount();</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> /**</span> |
| <span class="source-line-no">111</span><span id="line-111"> * Increment the count of failed ops due to RUNTIMEINCONSISTENCY Exception.</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 incrementRuntimeInconsistencyCount();</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * Increment the count of failed ops due to a SESSIONEXPIRED Exception.</span> |
| <span class="source-line-no">117</span><span id="line-117"> */</span> |
| <span class="source-line-no">118</span><span id="line-118"> void incrementSessionExpiredCount();</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> /**</span> |
| <span class="source-line-no">121</span><span id="line-121"> * Increment the count of failed ops due to a SYSTEMERROR Exception.</span> |
| <span class="source-line-no">122</span><span id="line-122"> */</span> |
| <span class="source-line-no">123</span><span id="line-123"> void incrementSystemErrorCount();</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> /**</span> |
| <span class="source-line-no">126</span><span id="line-126"> * Record the latency incurred for read operations.</span> |
| <span class="source-line-no">127</span><span id="line-127"> */</span> |
| <span class="source-line-no">128</span><span id="line-128"> void recordReadOperationLatency(long latency);</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> /**</span> |
| <span class="source-line-no">131</span><span id="line-131"> * Record the latency incurred for write operations.</span> |
| <span class="source-line-no">132</span><span id="line-132"> */</span> |
| <span class="source-line-no">133</span><span id="line-133"> void recordWriteOperationLatency(long latency);</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Record the latency incurred for sync operations.</span> |
| <span class="source-line-no">137</span><span id="line-137"> */</span> |
| <span class="source-line-no">138</span><span id="line-138"> void recordSyncOperationLatency(long latency);</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> /**</span> |
| <span class="source-line-no">141</span><span id="line-141"> * Record the total number of failed ZooKeeper API calls.</span> |
| <span class="source-line-no">142</span><span id="line-142"> */</span> |
| <span class="source-line-no">143</span><span id="line-143"> void incrementTotalFailedZKCalls();</span> |
| <span class="source-line-no">144</span><span id="line-144">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
