| <!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::CompositeMetricsReporter 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_1CompositeMetricsReporter.html">CompositeMetricsReporter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1CompositeMetricsReporter-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::CompositeMetricsReporter Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A <a class="el" href="classiceberg_1_1MetricsReporter.html" title="Interface for reporting metrics from Iceberg operations.">MetricsReporter</a> that delegates to multiple reporters. |
| <a href="classiceberg_1_1CompositeMetricsReporter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="metrics__reporters_8h_source.html">metrics_reporters.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::CompositeMetricsReporter:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1CompositeMetricsReporter.png" usemap="#iceberg::CompositeMetricsReporter_map" alt=""/> |
| <map id="iceberg::CompositeMetricsReporter_map" name="iceberg::CompositeMetricsReporter_map"> |
| <area href="classiceberg_1_1MetricsReporter.html" title="Interface for reporting metrics from Iceberg operations." alt="iceberg::MetricsReporter" shape="rect" coords="0,0,210,24"/> |
| </map> |
| </div></div> |
| <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:a94c26ea86bf0d9c4b87d50debd86b70b" id="r_a94c26ea86bf0d9c4b87d50debd86b70b"><td class="memItemLeft" align="right" valign="top"><a id="a94c26ea86bf0d9c4b87d50debd86b70b" name="a94c26ea86bf0d9c4b87d50debd86b70b"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>CompositeMetricsReporter</b> (std::unordered_set< std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > > reporters)</td></tr> |
| <tr class="separator:a94c26ea86bf0d9c4b87d50debd86b70b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc3c44f92b0a28b28b620d373d26861f" id="r_adc3c44f92b0a28b28b620d373d26861f"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1CompositeMetricsReporter.html#adc3c44f92b0a28b28b620d373d26861f">Report</a> (const <a class="el" href="namespaceiceberg.html#af4c8144c46c4c1e12da2bf476817c800">MetricsReport</a> &report) override</td></tr> |
| <tr class="memdesc:adc3c44f92b0a28b28b620d373d26861f"><td class="mdescLeft"> </td><td class="mdescRight">Report a metrics report. <br /></td></tr> |
| <tr class="separator:adc3c44f92b0a28b28b620d373d26861f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5e4766b4a4d9a8ff8cec6b07e918ca61" id="r_a5e4766b4a4d9a8ff8cec6b07e918ca61"><td class="memItemLeft" align="right" valign="top">const std::unordered_set< std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1CompositeMetricsReporter.html#a5e4766b4a4d9a8ff8cec6b07e918ca61">Reporters</a> () const</td></tr> |
| <tr class="memdesc:a5e4766b4a4d9a8ff8cec6b07e918ca61"><td class="mdescLeft"> </td><td class="mdescRight">The reporters contained in this composite. <br /></td></tr> |
| <tr class="separator:a5e4766b4a4d9a8ff8cec6b07e918ca61"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classiceberg_1_1MetricsReporter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1MetricsReporter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1MetricsReporter.html">iceberg::MetricsReporter</a></td></tr> |
| <tr class="memitem:a4a61bb9e321d19b3cbf3364c849e08f7 inherit pub_methods_classiceberg_1_1MetricsReporter" id="r_a4a61bb9e321d19b3cbf3364c849e08f7"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsReporter.html#a4a61bb9e321d19b3cbf3364c849e08f7">Initialize</a> (const std::unordered_map< std::string, std::string > &properties)</td></tr> |
| <tr class="memdesc:a4a61bb9e321d19b3cbf3364c849e08f7 inherit pub_methods_classiceberg_1_1MetricsReporter"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the reporter with catalog properties after construction. <br /></td></tr> |
| <tr class="separator:a4a61bb9e321d19b3cbf3364c849e08f7 inherit pub_methods_classiceberg_1_1MetricsReporter"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <a class="el" href="classiceberg_1_1MetricsReporter.html" title="Interface for reporting metrics from Iceberg operations.">MetricsReporter</a> that delegates to multiple reporters. </p> |
| <p>Combines several reporters so that every report is delivered to each of them. Implementations must not throw; return an error Status instead. All reporters receive the report regardless of individual failures. If any reporters fail, the first error Status is returned.</p> |
| <p>Use <a class="el" href="classiceberg_1_1MetricsReporters.html#a208634a42c0e0d3ec983fe2d9ce6db6d" title="Combine two reporters into one.">MetricsReporters::Combine()</a> to create instances — that helper flattens nested composites and deduplicates reporters by identity. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="adc3c44f92b0a28b28b620d373d26861f" name="adc3c44f92b0a28b28b620d373d26861f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adc3c44f92b0a28b28b620d373d26861f">◆ </a></span>Report()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::CompositeMetricsReporter::Report </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespaceiceberg.html#af4c8144c46c4c1e12da2bf476817c800">MetricsReport</a> & </td> |
| <td class="paramname"><em>report</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Report a metrics report. </p> |
| <p>Implementations should handle the report according to their purpose (e.g., logging, sending to a metrics service, etc.).</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">report</td><td>The metrics report to process. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1MetricsReporter.html#ada754787bbf4f5625b4739ee489296c7">iceberg::MetricsReporter</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5e4766b4a4d9a8ff8cec6b07e918ca61" name="a5e4766b4a4d9a8ff8cec6b07e918ca61"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5e4766b4a4d9a8ff8cec6b07e918ca61">◆ </a></span>Reporters()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::unordered_set< std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > > & iceberg::CompositeMetricsReporter::Reporters </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The reporters contained in this composite. </p> |
| <p>Used by <a class="el" href="classiceberg_1_1MetricsReporters.html#a208634a42c0e0d3ec983fe2d9ce6db6d" title="Combine two reporters into one.">MetricsReporters::Combine()</a> for flattening. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/metrics/<a class="el" href="metrics__reporters_8h_source.html">metrics_reporters.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> |
