| <!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>iceberg-cpp: iceberg::CommitMetrics Class 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">iceberg-cpp |
| </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&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&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="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1CommitMetrics.html">CommitMetrics</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="classiceberg_1_1CommitMetrics-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::CommitMetrics Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Live commit metrics collected during a table commit operation. |
| <a href="classiceberg_1_1CommitMetrics.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="commit__report_8h_source.html">commit_report.h</a>></code></p> |
| <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:a92090e152d2c313d58543333b8783d43" id="r_a92090e152d2c313d58543333b8783d43"><td class="memItemLeft" align="right" valign="top"><a id="a92090e152d2c313d58543333b8783d43" name="a92090e152d2c313d58543333b8783d43"></a> |
| <a class="el" href="structiceberg_1_1CommitMetricsResult.html">CommitMetricsResult</a> </td><td class="memItemRight" valign="bottom"><b>ToResult</b> () const</td></tr> |
| <tr class="memdesc:a92090e152d2c313d58543333b8783d43"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structiceberg_1_1Snapshot.html" title="A snapshot of the data in a table at a point in time.">Snapshot</a> current timer and counter values into a <a class="el" href="structiceberg_1_1CommitMetricsResult.html" title="Immutable snapshot of commit metrics for use in CommitReport.">CommitMetricsResult</a>. <br /></td></tr> |
| <tr class="separator:a92090e152d2c313d58543333b8783d43"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a289bc4172381103cb8ad4192e155b0ea" id="r_a289bc4172381103cb8ad4192e155b0ea"><td class="memItemLeft" align="right" valign="top"><a id="a289bc4172381103cb8ad4192e155b0ea" name="a289bc4172381103cb8ad4192e155b0ea"></a> |
| static std::unique_ptr< <a class="el" href="classiceberg_1_1CommitMetrics.html">CommitMetrics</a> > </td><td class="memItemRight" valign="bottom"><b>Make</b> (<a class="el" href="classiceberg_1_1MetricsContext.html">MetricsContext</a> &context)</td></tr> |
| <tr class="memdesc:a289bc4172381103cb8ad4192e155b0ea"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1CommitMetrics.html" title="Live commit metrics collected during a table commit operation.">CommitMetrics</a> instance backed by the given <a class="el" href="classiceberg_1_1MetricsContext.html" title="Factory for creating named Counter and Timer instances.">MetricsContext</a>. <br /></td></tr> |
| <tr class="separator:a289bc4172381103cb8ad4192e155b0ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16595dfcfe15e86d3e047be801490900" id="r_a16595dfcfe15e86d3e047be801490900"><td class="memItemLeft" align="right" valign="top"><a id="a16595dfcfe15e86d3e047be801490900" name="a16595dfcfe15e86d3e047be801490900"></a> |
| static std::unique_ptr< <a class="el" href="classiceberg_1_1CommitMetrics.html">CommitMetrics</a> > </td><td class="memItemRight" valign="bottom"><b>Noop</b> ()</td></tr> |
| <tr class="memdesc:a16595dfcfe15e86d3e047be801490900"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1CommitMetrics.html" title="Live commit metrics collected during a table commit operation.">CommitMetrics</a> instance with all-noop timer and counter. <br /></td></tr> |
| <tr class="separator:a16595dfcfe15e86d3e047be801490900"><td class="memSeparator" colspan="2"> </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:ae82deb2c9694b7e306537b5fac4bd269" id="r_ae82deb2c9694b7e306537b5fac4bd269"><td class="memItemLeft" align="right" valign="top"><a id="ae82deb2c9694b7e306537b5fac4bd269" name="ae82deb2c9694b7e306537b5fac4bd269"></a> |
| std::shared_ptr< <a class="el" href="classiceberg_1_1Timer.html">Timer</a> > </td><td class="memItemRight" valign="bottom"><b>total_duration</b></td></tr> |
| <tr class="memdesc:ae82deb2c9694b7e306537b5fac4bd269"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classiceberg_1_1Timer.html" title="Abstract timer for measuring operation durations.">Timer</a> measuring total wall-clock time of the commit call. <br /></td></tr> |
| <tr class="separator:ae82deb2c9694b7e306537b5fac4bd269"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71ff1dd05486fd70cbc6c9cfd5e7eec1" id="r_a71ff1dd05486fd70cbc6c9cfd5e7eec1"><td class="memItemLeft" align="right" valign="top"><a id="a71ff1dd05486fd70cbc6c9cfd5e7eec1" name="a71ff1dd05486fd70cbc6c9cfd5e7eec1"></a> |
| std::shared_ptr< <a class="el" href="classiceberg_1_1Counter.html">Counter</a> > </td><td class="memItemRight" valign="bottom"><b>attempts</b></td></tr> |
| <tr class="memdesc:a71ff1dd05486fd70cbc6c9cfd5e7eec1"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classiceberg_1_1Counter.html" title="Abstract counter for tracking event totals.">Counter</a> for the number of commit attempts (including retries). <br /></td></tr> |
| <tr class="separator:a71ff1dd05486fd70cbc6c9cfd5e7eec1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Live commit metrics collected during a table commit operation. </p> |
| <p>Tracks the overall commit duration and retry count. File/record counts come from the snapshot summary after the commit succeeds and are stored separately in <a class="el" href="structiceberg_1_1CommitMetricsResult.html" title="Immutable snapshot of commit metrics for use in CommitReport.">CommitMetricsResult</a>. </p> |
| </div><hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/metrics/<a class="el" href="commit__report_8h_source.html">commit_report.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
