ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/structripple_1_1metrics_1_1SingleMetrics.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

315 lines
18 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::metrics::SingleMetrics Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1metrics.html">metrics</a></li><li class="navelem"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html">SingleMetrics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1metrics_1_1SingleMetrics-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::metrics::SingleMetrics Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Run single metrics rolling average.
<a href="structripple_1_1metrics_1_1SingleMetrics.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::metrics::SingleMetrics:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1metrics_1_1SingleMetrics__coll__graph.png" border="0" usemap="#aripple_1_1metrics_1_1SingleMetrics_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1metrics_1_1SingleMetrics_coll__map" id="aripple_1_1metrics_1_1SingleMetrics_coll__map">
<area shape="rect" title="Run single metrics rolling average." alt="" coords="13,108,225,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,5,108,31"/>
<area shape="poly" title=" " alt="" coords="69,42,91,83,110,106,106,109,86,85,64,44"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="132,5,235,31"/>
<area shape="poly" title=" " alt="" coords="177,45,156,86,135,110,131,106,152,82,172,43"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad8612103e65d1cca73971350a8ef7141" id="r_ad8612103e65d1cca73971350a8ef7141"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#ad8612103e65d1cca73971350a8ef7141">clock_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a></td></tr>
<tr class="separator:ad8612103e65d1cca73971350a8ef7141"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a603661e5f74f98c3a38007474493bd62" id="r_a603661e5f74f98c3a38007474493bd62"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#a603661e5f74f98c3a38007474493bd62">SingleMetrics</a> (bool ptu=true)</td></tr>
<tr class="memdesc:a603661e5f74f98c3a38007474493bd62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class constructor. <br /></td></tr>
<tr class="separator:a603661e5f74f98c3a38007474493bd62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85743c0bc59b1abc4d9297f42ffe36d2" id="r_a85743c0bc59b1abc4d9297f42ffe36d2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#a85743c0bc59b1abc4d9297f42ffe36d2">addMetrics</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> val)</td></tr>
<tr class="memdesc:a85743c0bc59b1abc4d9297f42ffe36d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add metrics value. <br /></td></tr>
<tr class="separator:a85743c0bc59b1abc4d9297f42ffe36d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a23ef59aaec18412598b443f9d15d41c3" id="r_a23ef59aaec18412598b443f9d15d41c3"><td class="memItemLeft" align="right" valign="top">clock_type::time_point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#a23ef59aaec18412598b443f9d15d41c3">intervalStart</a> {<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock/now.html">clock_type::now</a>()}</td></tr>
<tr class="separator:a23ef59aaec18412598b443f9d15d41c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a279ac12cfe0009cbf6f3bea31dfb304e" id="r_a279ac12cfe0009cbf6f3bea31dfb304e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#a279ac12cfe0009cbf6f3bea31dfb304e">accum</a> {0}</td></tr>
<tr class="separator:a279ac12cfe0009cbf6f3bea31dfb304e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6b2ddd512154cf14290b37dfc6a785c" id="r_aa6b2ddd512154cf14290b37dfc6a785c"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#aa6b2ddd512154cf14290b37dfc6a785c">rollingAvg</a> {0}</td></tr>
<tr class="separator:aa6b2ddd512154cf14290b37dfc6a785c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4ed44a8f9324c6c68030aeb71b473b3" id="r_ac4ed44a8f9324c6c68030aeb71b473b3"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#ac4ed44a8f9324c6c68030aeb71b473b3">N</a> {0}</td></tr>
<tr class="separator:ac4ed44a8f9324c6c68030aeb71b473b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a49da4be07cac3bb4d23fb4a36e6c7a" id="r_a5a49da4be07cac3bb4d23fb4a36e6c7a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#a5a49da4be07cac3bb4d23fb4a36e6c7a">perTimeUnit</a> {true}</td></tr>
<tr class="separator:a5a49da4be07cac3bb4d23fb4a36e6c7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cb7e08fa11b2d780f7b9a19818ec746" id="r_a0cb7e08fa11b2d780f7b9a19818ec746"><td class="memItemLeft" align="right" valign="top">boost::circular_buffer&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#a0cb7e08fa11b2d780f7b9a19818ec746">rollingAvgAggreg</a> {30, 0ull}</td></tr>
<tr class="separator:a0cb7e08fa11b2d780f7b9a19818ec746"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Run single metrics rolling average. </p>
<p>Can be either average of a value per second or average of a value's sample per second. For instance, for transaction it makes sense to have transaction bytes and count per second, but for a number of selected peers to relay per transaction it makes sense to have sample's average. </p>
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00022">22</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ad8612103e65d1cca73971350a8ef7141" name="ad8612103e65d1cca73971350a8ef7141"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8612103e65d1cca73971350a8ef7141">&#9670;&#160;</a></span>clock_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structripple_1_1metrics_1_1SingleMetrics.html#ad8612103e65d1cca73971350a8ef7141">ripple::metrics::SingleMetrics::clock_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock.html">std::chrono::steady_clock</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00031">31</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a603661e5f74f98c3a38007474493bd62" name="a603661e5f74f98c3a38007474493bd62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a603661e5f74f98c3a38007474493bd62">&#9670;&#160;</a></span>SingleMetrics()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::metrics::SingleMetrics::SingleMetrics </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>ptu</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Class constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptu</td><td>if true then calculate metrics per second, otherwise sample's average </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00028">28</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a85743c0bc59b1abc4d9297f42ffe36d2" name="a85743c0bc59b1abc4d9297f42ffe36d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85743c0bc59b1abc4d9297f42ffe36d2">&#9670;&#160;</a></span>addMetrics()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::metrics::SingleMetrics::addMetrics </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td>
<td class="paramname"><em>val</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add metrics value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">val</td><td>metrics value, either bytes or count </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="TxMetrics_8cpp_source.html#l00074">74</a> of file <a class="el" href="TxMetrics_8cpp_source.html">TxMetrics.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a23ef59aaec18412598b443f9d15d41c3" name="a23ef59aaec18412598b443f9d15d41c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23ef59aaec18412598b443f9d15d41c3">&#9670;&#160;</a></span>intervalStart</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">clock_type::time_point ripple::metrics::SingleMetrics::intervalStart {<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/steady_clock/now.html">clock_type::now</a>()}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00032">32</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
<a id="a279ac12cfe0009cbf6f3bea31dfb304e" name="a279ac12cfe0009cbf6f3bea31dfb304e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a279ac12cfe0009cbf6f3bea31dfb304e">&#9670;&#160;</a></span>accum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> ripple::metrics::SingleMetrics::accum {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00033">33</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
<a id="aa6b2ddd512154cf14290b37dfc6a785c" name="aa6b2ddd512154cf14290b37dfc6a785c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6b2ddd512154cf14290b37dfc6a785c">&#9670;&#160;</a></span>rollingAvg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> ripple::metrics::SingleMetrics::rollingAvg {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00034">34</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
<a id="ac4ed44a8f9324c6c68030aeb71b473b3" name="ac4ed44a8f9324c6c68030aeb71b473b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4ed44a8f9324c6c68030aeb71b473b3">&#9670;&#160;</a></span>N</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::metrics::SingleMetrics::N {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00035">35</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
<a id="a5a49da4be07cac3bb4d23fb4a36e6c7a" name="a5a49da4be07cac3bb4d23fb4a36e6c7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a49da4be07cac3bb4d23fb4a36e6c7a">&#9670;&#160;</a></span>perTimeUnit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::metrics::SingleMetrics::perTimeUnit {true}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00036">36</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
<a id="a0cb7e08fa11b2d780f7b9a19818ec746" name="a0cb7e08fa11b2d780f7b9a19818ec746"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cb7e08fa11b2d780f7b9a19818ec746">&#9670;&#160;</a></span>rollingAvgAggreg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::circular_buffer&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a>&gt; ripple::metrics::SingleMetrics::rollingAvgAggreg {30, 0ull}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TxMetrics_8h_source.html#l00037">37</a> of file <a class="el" href="TxMetrics_8h_source.html">TxMetrics.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink