blob: 4d6a3d1c76148af275ef0e898403712732901d7d [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.util, class: YammerHistogramUtils">
<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.util;</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 com.codahale.metrics.Histogram;</span>
<span class="source-line-no">021</span><span id="line-21">import com.codahale.metrics.Reservoir;</span>
<span class="source-line-no">022</span><span id="line-22">import com.codahale.metrics.Snapshot;</span>
<span class="source-line-no">023</span><span id="line-23">import java.lang.reflect.Constructor;</span>
<span class="source-line-no">024</span><span id="line-24">import java.text.DecimalFormat;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">/** Utility functions for working with Yammer Metrics. */</span>
<span class="source-line-no">028</span><span id="line-28">@InterfaceAudience.Private</span>
<span class="source-line-no">029</span><span id="line-29">public final class YammerHistogramUtils {</span>
<span class="source-line-no">030</span><span id="line-30"></span>
<span class="source-line-no">031</span><span id="line-31"> // not for public consumption</span>
<span class="source-line-no">032</span><span id="line-32"> private YammerHistogramUtils() {</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"> /**</span>
<span class="source-line-no">036</span><span id="line-36"> * Used formatting doubles so only two places after decimal point.</span>
<span class="source-line-no">037</span><span id="line-37"> */</span>
<span class="source-line-no">038</span><span id="line-38"> private static DecimalFormat DOUBLE_FORMAT = new DecimalFormat("#0.00");</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"> * Create a new {@link com.codahale.metrics.Histogram} instance. These constructors are not public</span>
<span class="source-line-no">042</span><span id="line-42"> * in 2.2.0, so we use reflection to find them.</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44"> public static Histogram newHistogram(Reservoir sample) {</span>
<span class="source-line-no">045</span><span id="line-45"> try {</span>
<span class="source-line-no">046</span><span id="line-46"> Constructor&lt;?&gt; ctor = Histogram.class.getDeclaredConstructor(Reservoir.class);</span>
<span class="source-line-no">047</span><span id="line-47"> ctor.setAccessible(true);</span>
<span class="source-line-no">048</span><span id="line-48"> return (Histogram) ctor.newInstance(sample);</span>
<span class="source-line-no">049</span><span id="line-49"> } catch (Exception e) {</span>
<span class="source-line-no">050</span><span id="line-50"> throw new RuntimeException(e);</span>
<span class="source-line-no">051</span><span id="line-51"> }</span>
<span class="source-line-no">052</span><span id="line-52"> }</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> /** Returns an abbreviated summary of {@code hist}. */</span>
<span class="source-line-no">055</span><span id="line-55"> public static String getShortHistogramReport(final Histogram hist) {</span>
<span class="source-line-no">056</span><span id="line-56"> Snapshot sn = hist.getSnapshot();</span>
<span class="source-line-no">057</span><span id="line-57"> return "mean=" + DOUBLE_FORMAT.format(sn.getMean()) + ", min="</span>
<span class="source-line-no">058</span><span id="line-58"> + DOUBLE_FORMAT.format(sn.getMin()) + ", max=" + DOUBLE_FORMAT.format(sn.getMax())</span>
<span class="source-line-no">059</span><span id="line-59"> + ", stdDev=" + DOUBLE_FORMAT.format(sn.getStdDev()) + ", 95th="</span>
<span class="source-line-no">060</span><span id="line-60"> + DOUBLE_FORMAT.format(sn.get95thPercentile()) + ", 99th="</span>
<span class="source-line-no">061</span><span id="line-61"> + DOUBLE_FORMAT.format(sn.get99thPercentile());</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"> /** Returns a summary of {@code hist}. */</span>
<span class="source-line-no">065</span><span id="line-65"> public static String getHistogramReport(final Histogram hist) {</span>
<span class="source-line-no">066</span><span id="line-66"> Snapshot sn = hist.getSnapshot();</span>
<span class="source-line-no">067</span><span id="line-67"> return "mean=" + DOUBLE_FORMAT.format(sn.getMean()) + ", min="</span>
<span class="source-line-no">068</span><span id="line-68"> + DOUBLE_FORMAT.format(sn.getMin()) + ", max=" + DOUBLE_FORMAT.format(sn.getMax())</span>
<span class="source-line-no">069</span><span id="line-69"> + ", stdDev=" + DOUBLE_FORMAT.format(sn.getStdDev()) + ", 50th="</span>
<span class="source-line-no">070</span><span id="line-70"> + DOUBLE_FORMAT.format(sn.getMedian()) + ", 75th="</span>
<span class="source-line-no">071</span><span id="line-71"> + DOUBLE_FORMAT.format(sn.get75thPercentile()) + ", 95th="</span>
<span class="source-line-no">072</span><span id="line-72"> + DOUBLE_FORMAT.format(sn.get95thPercentile()) + ", 99th="</span>
<span class="source-line-no">073</span><span id="line-73"> + DOUBLE_FORMAT.format(sn.get99thPercentile()) + ", 99.9th="</span>
<span class="source-line-no">074</span><span id="line-74"> + DOUBLE_FORMAT.format(sn.get999thPercentile()) + ", 99.99th="</span>
<span class="source-line-no">075</span><span id="line-75"> + DOUBLE_FORMAT.format(sn.getValue(0.9999)) + ", 99.999th="</span>
<span class="source-line-no">076</span><span id="line-76"> + DOUBLE_FORMAT.format(sn.getValue(0.99999));</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"> /** Returns pretty summary of {@code hist}. */</span>
<span class="source-line-no">080</span><span id="line-80"> public static String getPrettyHistogramReport(final Histogram h) {</span>
<span class="source-line-no">081</span><span id="line-81"> Snapshot sn = h.getSnapshot();</span>
<span class="source-line-no">082</span><span id="line-82"> return "Mean = " + DOUBLE_FORMAT.format(sn.getMean()) + "\n" + "Min = "</span>
<span class="source-line-no">083</span><span id="line-83"> + DOUBLE_FORMAT.format(sn.getMin()) + "\n" + "Max = "</span>
<span class="source-line-no">084</span><span id="line-84"> + DOUBLE_FORMAT.format(sn.getMax()) + "\n" + "StdDev = "</span>
<span class="source-line-no">085</span><span id="line-85"> + DOUBLE_FORMAT.format(sn.getStdDev()) + "\n" + "50th = "</span>
<span class="source-line-no">086</span><span id="line-86"> + DOUBLE_FORMAT.format(sn.getMedian()) + "\n" + "75th = "</span>
<span class="source-line-no">087</span><span id="line-87"> + DOUBLE_FORMAT.format(sn.get75thPercentile()) + "\n" + "95th = "</span>
<span class="source-line-no">088</span><span id="line-88"> + DOUBLE_FORMAT.format(sn.get95thPercentile()) + "\n" + "99th = "</span>
<span class="source-line-no">089</span><span id="line-89"> + DOUBLE_FORMAT.format(sn.get99thPercentile()) + "\n" + "99.9th = "</span>
<span class="source-line-no">090</span><span id="line-90"> + DOUBLE_FORMAT.format(sn.get999thPercentile()) + "\n" + "99.99th = "</span>
<span class="source-line-no">091</span><span id="line-91"> + DOUBLE_FORMAT.format(sn.getValue(0.9999)) + "\n" + "99.999th = "</span>
<span class="source-line-no">092</span><span id="line-92"> + DOUBLE_FORMAT.format(sn.getValue(0.99999));</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>
</pre>
</div>
</main>
</body>
</html>