Google Git
Sign in
apache / impala / asf-site / . / doc / html / classimpala_1_1StatsMetric.html
blob: a0b9fa21b2fca47535db3ec708498c67147ca0a1 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Impala: impala::StatsMetric&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classimpala_1_1StatsMetric.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classimpala_1_1StatsMetric-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::StatsMetric&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for impala::StatsMetric&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1StatsMetric__inherit__graph.svg" width="176" height="448"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<div class="dynheader">
Collaboration diagram for impala::StatsMetric&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classimpala_1_1StatsMetric__coll__graph.svg" width="631" height="563"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4bb337c3b076685feda6db7fe6d6babd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#a4bb337c3b076685feda6db7fe6d6babd">StatsMetric</a> (const std::string &amp;<a class="el" href="classimpala_1_1Metric.html#a56211a0cc08bb2e10a0c89ebe5b152d9">key</a>, const TUnit::type unit, const std::string &amp;<a class="el" href="classimpala_1_1Metric.html#a80682167db8743e5c8e38e73ad55f0c3">description</a>=&quot;&quot;)</td></tr>
<tr class="separator:a4bb337c3b076685feda6db7fe6d6babd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63e36e6ce39c43df7144d970dd0be733"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#a63e36e6ce39c43df7144d970dd0be733">Update</a> (const T &amp;value)</td></tr>
<tr class="separator:a63e36e6ce39c43df7144d970dd0be733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c1d1e39b500ce570768d7cdabb5cede"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#a1c1d1e39b500ce570768d7cdabb5cede">Reset</a> ()</td></tr>
<tr class="separator:a1c1d1e39b500ce570768d7cdabb5cede"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae01f8b10c0e09349705337ecff7b638"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#aae01f8b10c0e09349705337ecff7b638">ToJson</a> (rapidjson::Document *document, rapidjson::Value *val)</td></tr>
<tr class="memdesc:aae01f8b10c0e09349705337ecff7b638"><td class="mdescLeft">&#160;</td><td class="mdescRight">name, value, human_readable, description <a href="#aae01f8b10c0e09349705337ecff7b638">More...</a><br/></td></tr>
<tr class="separator:aae01f8b10c0e09349705337ecff7b638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a265ab5dd4b83ac75481203c1b240aafc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#a265ab5dd4b83ac75481203c1b240aafc">ToLegacyJson</a> (rapidjson::Document *document)</td></tr>
<tr class="memdesc:a265ab5dd4b83ac75481203c1b240aafc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is kept for backwards-compatibility with CM5.0. <a href="#a265ab5dd4b83ac75481203c1b240aafc">More...</a><br/></td></tr>
<tr class="separator:a265ab5dd4b83ac75481203c1b240aafc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a313f2d5b904ce2f8db513a89295f12b3"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#a313f2d5b904ce2f8db513a89295f12b3">ToHumanReadable</a> ()</td></tr>
<tr class="separator:a313f2d5b904ce2f8db513a89295f12b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56211a0cc08bb2e10a0c89ebe5b152d9"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Metric.html#a56211a0cc08bb2e10a0c89ebe5b152d9">key</a> () const </td></tr>
<tr class="separator:a56211a0cc08bb2e10a0c89ebe5b152d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80682167db8743e5c8e38e73ad55f0c3"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Metric.html#a80682167db8743e5c8e38e73ad55f0c3">description</a> () const </td></tr>
<tr class="separator:a80682167db8743e5c8e38e73ad55f0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a05010f15c634161716da4e8451dba06d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Metric.html#a05010f15c634161716da4e8451dba06d">AddStandardFields</a> (rapidjson::Document *document, rapidjson::Value *val)</td></tr>
<tr class="separator:a05010f15c634161716da4e8451dba06d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:abfaeffb213edb0d448f5b07638ee6963"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Metric.html#abfaeffb213edb0d448f5b07638ee6963">key_</a></td></tr>
<tr class="memdesc:abfaeffb213edb0d448f5b07638ee6963"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique key identifying this metric. <a href="#abfaeffb213edb0d448f5b07638ee6963">More...</a><br/></td></tr>
<tr class="separator:abfaeffb213edb0d448f5b07638ee6963"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27ca97f61ec3c3ea2608bb51b78c33ae"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1Metric.html#a27ca97f61ec3c3ea2608bb51b78c33ae">description_</a></td></tr>
<tr class="separator:a27ca97f61ec3c3ea2608bb51b78c33ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:ab9cf9cbc5ed49abfb2331ec27f68d15e"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
boost::accumulators::accumulator_set<br class="typebreak"/>
&lt; T, <br class="typebreak"/>
boost::accumulators::features<br class="typebreak"/>
&lt; boost::accumulators::tag::mean, <br class="typebreak"/>
<a class="el" href="partitioning-throughput-test_8cc.html#ad43c3812e6d13e0518d9f8b8f463ffcf">boost::accumulators::tag::count</a>, <br class="typebreak"/>
boost::accumulators::tag::min, <br class="typebreak"/>
boost::accumulators::tag::max, <br class="typebreak"/>
boost::accumulators::tag::variance &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#ab9cf9cbc5ed49abfb2331ec27f68d15e">Accumulator</a></td></tr>
<tr class="memdesc:ab9cf9cbc5ed49abfb2331ec27f68d15e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The set of accumulators that update the statistics on each <a class="el" href="classimpala_1_1StatsMetric.html#a63e36e6ce39c43df7144d970dd0be733">Update()</a> <a href="#ab9cf9cbc5ed49abfb2331ec27f68d15e">More...</a><br/></td></tr>
<tr class="separator:ab9cf9cbc5ed49abfb2331ec27f68d15e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ac0628e9f1925d7d8607e0b45373ed2d9"><td class="memItemLeft" align="right" valign="top">TUnit::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#ac0628e9f1925d7d8607e0b45373ed2d9">unit_</a></td></tr>
<tr class="memdesc:ac0628e9f1925d7d8607e0b45373ed2d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The units of the values captured in this metric, used when pretty-printing. <a href="#ac0628e9f1925d7d8607e0b45373ed2d9">More...</a><br/></td></tr>
<tr class="separator:ac0628e9f1925d7d8607e0b45373ed2d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef77971f1b4d6299ca1e1134abfaddcc"><td class="memItemLeft" align="right" valign="top">boost::mutex&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#aef77971f1b4d6299ca1e1134abfaddcc">lock_</a></td></tr>
<tr class="memdesc:aef77971f1b4d6299ca1e1134abfaddcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lock protecting the value and the accumulator_set. <a href="#aef77971f1b4d6299ca1e1134abfaddcc">More...</a><br/></td></tr>
<tr class="separator:aef77971f1b4d6299ca1e1134abfaddcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ee0bb33c9cb05db3c319de1842a1542"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#a3ee0bb33c9cb05db3c319de1842a1542">value_</a></td></tr>
<tr class="memdesc:a3ee0bb33c9cb05db3c319de1842a1542"><td class="mdescLeft">&#160;</td><td class="mdescRight">The last value. <a href="#a3ee0bb33c9cb05db3c319de1842a1542">More...</a><br/></td></tr>
<tr class="separator:a3ee0bb33c9cb05db3c319de1842a1542"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b50e12d2180135b6c41d418834bd2b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1StatsMetric.html#ab9cf9cbc5ed49abfb2331ec27f68d15e">Accumulator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1StatsMetric.html#a8b50e12d2180135b6c41d418834bd2b3">acc_</a></td></tr>
<tr class="separator:a8b50e12d2180135b6c41d418834bd2b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br/>
class impala::StatsMetric&lt; T &gt;</h3>
<p><a class="el" href="classimpala_1_1Metric.html" title="TODO: Add ToThrift() for conversion to an RPC-friendly format. ">Metric</a> which accumulates min, max and mean of all values, plus a count of samples seen. Printed output looks like: name: count: 4, last: 0.0141, min: 4.546e-06, max: 0.0243, mean: 0.0336, stddev: 0.0336 After construction, all statistics are ill-defined, but count will be 0. The first call to <a class="el" href="classimpala_1_1StatsMetric.html#a63e36e6ce39c43df7144d970dd0be733">Update()</a> will initialise all stats. </p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00107">107</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="ab9cf9cbc5ed49abfb2331ec27f68d15e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">typedef boost::accumulators::accumulator_set&lt;T, boost::accumulators::features&lt;boost::accumulators::tag::mean, <a class="el" href="partitioning-throughput-test_8cc.html#ad43c3812e6d13e0518d9f8b8f463ffcf">boost::accumulators::tag::count</a>, boost::accumulators::tag::min, boost::accumulators::tag::max, boost::accumulators::tag::variance&gt; &gt; <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::<a class="el" href="classimpala_1_1StatsMetric.html#ab9cf9cbc5ed49abfb2331ec27f68d15e">Accumulator</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The set of accumulators that update the statistics on each <a class="el" href="classimpala_1_1StatsMetric.html#a63e36e6ce39c43df7144d970dd0be733">Update()</a> </p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00198">198</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4bb337c3b076685feda6db7fe6d6babd"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::<a class="el" href="classimpala_1_1StatsMetric.html">StatsMetric</a> </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TUnit::type&#160;</td>
<td class="paramname"><em>unit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>description</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00109">109</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a05010f15c634161716da4e8451dba06d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Metric::AddStandardFields </td>
<td>(</td>
<td class="paramtype">rapidjson::Document *&#160;</td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">rapidjson::Value *&#160;</td>
<td class="paramname"><em>val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method to add standard fields (name, description, human readable string) to 'val'. </p>
<p>Definition at line <a class="el" href="metrics_8cc_source.html#l00046">46</a> of file <a class="el" href="metrics_8cc_source.html">metrics.cc</a>.</p>
<p>References <a class="el" href="cpu-info_8cc_source.html#l00050">impala::name</a>.</p>
<p>Referenced by <a class="el" href="collection-metrics_8h_source.html#l00062">impala::SetMetric&lt; std::string &gt;::ToJson()</a>, <a class="el" href="collection-metrics_8h_source.html#l00123">impala::StatsMetric&lt; double &gt;::ToJson()</a>, and <a class="el" href="metrics_8h_source.html#l00140">impala::SimpleMetric&lt; T, metric_kind &gt;::ToJson()</a>.</p>
</div>
</div>
<a class="anchor" id="a80682167db8743e5c8e38e73ad55f0c3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; impala::Metric::description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="metrics_8h_source.html#l00072">72</a> of file <a class="el" href="metrics_8h_source.html">metrics.h</a>.</p>
<p>References <a class="el" href="metrics_8h_source.html#l00080">impala::Metric::description_</a>.</p>
</div>
</div>
<a class="anchor" id="a56211a0cc08bb2e10a0c89ebe5b152d9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; impala::Metric::key </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="metrics_8h_source.html#l00071">71</a> of file <a class="el" href="metrics_8h_source.html">metrics.h</a>.</p>
<p>References <a class="el" href="metrics_8h_source.html#l00076">impala::Metric::key_</a>.</p>
<p>Referenced by <a class="el" href="metrics_8h_source.html#l00131">impala::SimpleMetric&lt; T, metric_kind &gt;::Increment()</a>.</p>
</div>
</div>
<a class="anchor" id="a1c1d1e39b500ce570768d7cdabb5cede"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00118">118</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
</div>
</div>
<a class="anchor" id="a313f2d5b904ce2f8db513a89295f12b3"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::ToHumanReadable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a human-readable representation of this metric to 'out'. This is the representation that is often displayed in webpages etc. </p>
<p>Implements <a class="el" href="classimpala_1_1Metric.html#a0927716b77c734cdda1c72b8f7314230">impala::Metric</a>.</p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00168">168</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
<p>Referenced by <a class="el" href="metrics-test_8cc_source.html#l00114">impala::TEST()</a>.</p>
</div>
</div>
<a class="anchor" id="aae01f8b10c0e09349705337ecff7b638"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::ToJson </td>
<td>(</td>
<td class="paramtype">rapidjson::Document *&#160;</td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">rapidjson::Value *&#160;</td>
<td class="paramname"><em>val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>name, value, human_readable, description </p>
<p>Builds a new Value into 'val', using (if required) the allocator from 'document'. Should set the following fields where appropriate: </p>
<p>Implements <a class="el" href="classimpala_1_1Metric.html#a9ffe6624e9683bf07561246655347285">impala::Metric</a>.</p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00123">123</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
</div>
</div>
<a class="anchor" id="a265ab5dd4b83ac75481203c1b240aafc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::ToLegacyJson </td>
<td>(</td>
<td class="paramtype">rapidjson::Document *&#160;</td>
<td class="paramname"><em>document</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is kept for backwards-compatibility with CM5.0. </p>
<p>Adds a new json value directly to 'document' of the form: "name" : "human-readable-string" </p>
<p>Implements <a class="el" href="classimpala_1_1Metric.html#a192ffba4fa4b4f5fb797af1cd7adcce1">impala::Metric</a>.</p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00147">147</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
</div>
</div>
<a class="anchor" id="a63e36e6ce39c43df7144d970dd0be733"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::Update </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00112">112</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
<p>Referenced by <a class="el" href="resource-broker_8cc_source.html#l00503">impala::ResourceBroker::Expand()</a>, <a class="el" href="catalog-server_8cc_source.html#l00252">impala::CatalogServer::GatherCatalogUpdatesThread()</a>, <a class="el" href="statestore-subscriber_8cc_source.html#l00279">impala::StatestoreSubscriber::Heartbeat()</a>, <a class="el" href="resource-broker_8cc_source.html#l00336">impala::ResourceBroker::LlamaRpc()</a>, <a class="el" href="rpc-trace_8cc_source.html#l00184">impala::RpcEventHandler::postWrite()</a>, <a class="el" href="resource-broker_8cc_source.html#l00569">impala::ResourceBroker::Reserve()</a>, <a class="el" href="request-pool-service_8cc_source.html#l00133">impala::RequestPoolService::ResolveRequestPool()</a>, <a class="el" href="statestore_8cc_source.html#l00587">impala::Statestore::SendHeartbeat()</a>, <a class="el" href="statestore_8cc_source.html#l00399">impala::Statestore::SendTopicUpdate()</a>, <a class="el" href="metrics-test_8cc_source.html#l00114">impala::TEST()</a>, <a class="el" href="statestore-subscriber_8cc_source.html#l00290">impala::StatestoreSubscriber::UpdateState()</a>, and <a class="el" href="parallel-executor_8cc_source.html#l00043">impala::ParallelExecutor::Worker()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a8b50e12d2180135b6c41d418834bd2b3"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1StatsMetric.html#ab9cf9cbc5ed49abfb2331ec27f68d15e">Accumulator</a> <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::acc_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00199">199</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
<p>Referenced by <a class="el" href="collection-metrics_8h_source.html#l00118">impala::StatsMetric&lt; double &gt;::Reset()</a>, <a class="el" href="collection-metrics_8h_source.html#l00168">impala::StatsMetric&lt; double &gt;::ToHumanReadable()</a>, <a class="el" href="collection-metrics_8h_source.html#l00123">impala::StatsMetric&lt; double &gt;::ToJson()</a>, <a class="el" href="collection-metrics_8h_source.html#l00147">impala::StatsMetric&lt; double &gt;::ToLegacyJson()</a>, and <a class="el" href="collection-metrics_8h_source.html#l00112">impala::StatsMetric&lt; double &gt;::Update()</a>.</p>
</div>
</div>
<a class="anchor" id="a27ca97f61ec3c3ea2608bb51b78c33ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string impala::Metric::description_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Description of this metric. TODO: share one copy amongst metrics with the same description. </p>
<p>Definition at line <a class="el" href="metrics_8h_source.html#l00080">80</a> of file <a class="el" href="metrics_8h_source.html">metrics.h</a>.</p>
<p>Referenced by <a class="el" href="metrics_8h_source.html#l00072">impala::Metric::description()</a>.</p>
</div>
</div>
<a class="anchor" id="abfaeffb213edb0d448f5b07638ee6963"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string impala::Metric::key_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique key identifying this metric. </p>
<p>Definition at line <a class="el" href="metrics_8h_source.html#l00076">76</a> of file <a class="el" href="metrics_8h_source.html">metrics.h</a>.</p>
<p>Referenced by <a class="el" href="metrics_8h_source.html#l00071">impala::Metric::key()</a>, <a class="el" href="collection-metrics_8h_source.html#l00075">impala::SetMetric&lt; std::string &gt;::ToLegacyJson()</a>, <a class="el" href="collection-metrics_8h_source.html#l00147">impala::StatsMetric&lt; double &gt;::ToLegacyJson()</a>, and <a class="el" href="metrics_8h_source.html#l00160">impala::SimpleMetric&lt; T, metric_kind &gt;::ToLegacyJson()</a>.</p>
</div>
</div>
<a class="anchor" id="aef77971f1b4d6299ca1e1134abfaddcc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::mutex <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::lock_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Lock protecting the value and the accumulator_set. </p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00187">187</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
<p>Referenced by <a class="el" href="collection-metrics_8h_source.html#l00118">impala::StatsMetric&lt; double &gt;::Reset()</a>, <a class="el" href="collection-metrics_8h_source.html#l00123">impala::StatsMetric&lt; double &gt;::ToJson()</a>, <a class="el" href="collection-metrics_8h_source.html#l00147">impala::StatsMetric&lt; double &gt;::ToLegacyJson()</a>, and <a class="el" href="collection-metrics_8h_source.html#l00112">impala::StatsMetric&lt; double &gt;::Update()</a>.</p>
</div>
</div>
<a class="anchor" id="ac0628e9f1925d7d8607e0b45373ed2d9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TUnit::type <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::unit_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The units of the values captured in this metric, used when pretty-printing. </p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00184">184</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
<p>Referenced by <a class="el" href="collection-metrics_8h_source.html#l00168">impala::StatsMetric&lt; double &gt;::ToHumanReadable()</a>, and <a class="el" href="collection-metrics_8h_source.html#l00123">impala::StatsMetric&lt; double &gt;::ToJson()</a>.</p>
</div>
</div>
<a class="anchor" id="a3ee0bb33c9cb05db3c319de1842a1542"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classimpala_1_1StatsMetric.html">impala::StatsMetric</a>&lt; T &gt;::value_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The last value. </p>
<p>Definition at line <a class="el" href="collection-metrics_8h_source.html#l00190">190</a> of file <a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a>.</p>
<p>Referenced by <a class="el" href="collection-metrics_8h_source.html#l00168">impala::StatsMetric&lt; double &gt;::ToHumanReadable()</a>, <a class="el" href="collection-metrics_8h_source.html#l00123">impala::StatsMetric&lt; double &gt;::ToJson()</a>, <a class="el" href="collection-metrics_8h_source.html#l00147">impala::StatsMetric&lt; double &gt;::ToLegacyJson()</a>, and <a class="el" href="collection-metrics_8h_source.html#l00112">impala::StatsMetric&lt; double &gt;::Update()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>be/src/util/<a class="el" href="collection-metrics_8h_source.html">collection-metrics.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1StatsMetric.html">StatsMetric</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:50 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>