| <!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::MetricsReporters 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_1MetricsReporters.html">MetricsReporters</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classiceberg_1_1MetricsReporters-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::MetricsReporters Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Factory class for creating and managing <a class="el" href="classiceberg_1_1MetricsReporter.html" title="Interface for reporting metrics from Iceberg operations.">MetricsReporter</a> instances. |
| <a href="classiceberg_1_1MetricsReporters.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="metrics__reporters_8h_source.html">metrics_reporters.h</a>></code></p> |
| <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:ad30a5c4a9a58a083a3d2d7c96f46bc34" id="r_ad30a5c4a9a58a083a3d2d7c96f46bc34"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsReporters.html#ad30a5c4a9a58a083a3d2d7c96f46bc34">Load</a> (const std::unordered_map< std::string, std::string > &properties)</td></tr> |
| <tr class="memdesc:ad30a5c4a9a58a083a3d2d7c96f46bc34"><td class="mdescLeft"> </td><td class="mdescRight">Load a metrics reporter based on properties. <br /></td></tr> |
| <tr class="separator:ad30a5c4a9a58a083a3d2d7c96f46bc34"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7796f039b97c35ca6671a773b048ae73" id="r_a7796f039b97c35ca6671a773b048ae73"><td class="memItemLeft" align="right" valign="top">static Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsReporters.html#a7796f039b97c35ca6671a773b048ae73">Register</a> (std::string_view reporter_type, <a class="el" href="namespaceiceberg.html#a8f3a945ceed2309518ab9280d312f494">MetricsReporterFactory</a> factory)</td></tr> |
| <tr class="memdesc:a7796f039b97c35ca6671a773b048ae73"><td class="mdescLeft"> </td><td class="mdescRight">Register a factory for a metrics reporter type. <br /></td></tr> |
| <tr class="separator:a7796f039b97c35ca6671a773b048ae73"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a208634a42c0e0d3ec983fe2d9ce6db6d" id="r_a208634a42c0e0d3ec983fe2d9ce6db6d"><td class="memItemLeft" align="right" valign="top">static 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_1MetricsReporters.html#a208634a42c0e0d3ec983fe2d9ce6db6d">Combine</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > first, std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > second)</td></tr> |
| <tr class="memdesc:a208634a42c0e0d3ec983fe2d9ce6db6d"><td class="mdescLeft"> </td><td class="mdescRight">Combine two reporters into one. <br /></td></tr> |
| <tr class="separator:a208634a42c0e0d3ec983fe2d9ce6db6d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Factory class for creating and managing <a class="el" href="classiceberg_1_1MetricsReporter.html" title="Interface for reporting metrics from Iceberg operations.">MetricsReporter</a> instances. </p> |
| <p>This class provides a registry-based factory for creating <a class="el" href="classiceberg_1_1MetricsReporter.html" title="Interface for reporting metrics from Iceberg operations.">MetricsReporter</a> implementations. Custom reporter implementations can be registered using the <a class="el" href="classiceberg_1_1MetricsReporters.html#a7796f039b97c35ca6671a773b048ae73" title="Register a factory for a metrics reporter type.">Register()</a> method. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a208634a42c0e0d3ec983fe2d9ce6db6d" name="a208634a42c0e0d3ec983fe2d9ce6db6d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a208634a42c0e0d3ec983fe2d9ce6db6d">◆ </a></span>Combine()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > iceberg::MetricsReporters::Combine </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > </td> |
| <td class="paramname"><em>first</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > </td> |
| <td class="paramname"><em>second</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Combine two reporters into one. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">first</td><td>First reporter, may be nullptr. </td></tr> |
| <tr><td class="paramname">second</td><td>Second reporter, may be nullptr. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Combined reporter, or nullptr if both inputs are nullptr. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad30a5c4a9a58a083a3d2d7c96f46bc34" name="ad30a5c4a9a58a083a3d2d7c96f46bc34"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad30a5c4a9a58a083a3d2d7c96f46bc34">◆ </a></span>Load()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a> > > iceberg::MetricsReporters::Load </td> |
| <td>(</td> |
| <td class="paramtype">const std::unordered_map< std::string, std::string > & </td> |
| <td class="paramname"><em>properties</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Load a metrics reporter based on properties. </p> |
| <p>This method looks up the "metrics-reporter-impl" property to determine which reporter implementation to create. If not specified, returns a NoopMetricsReporter.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">properties</td><td>Configuration properties containing reporter type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classiceberg_1_1MetricsReporter.html" title="Interface for reporting metrics from Iceberg operations.">MetricsReporter</a> instance or an error. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7796f039b97c35ca6671a773b048ae73" name="a7796f039b97c35ca6671a773b048ae73"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7796f039b97c35ca6671a773b048ae73">◆ </a></span>Register()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static Status iceberg::MetricsReporters::Register </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>reporter_type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="namespaceiceberg.html#a8f3a945ceed2309518ab9280d312f494">MetricsReporterFactory</a> </td> |
| <td class="paramname"><em>factory</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register a factory for a metrics reporter type. </p> |
| <p>Thread-safe. Registrations can be performed at any time, including concurrently with <a class="el" href="classiceberg_1_1MetricsReporters.html#ad30a5c4a9a58a083a3d2d7c96f46bc34" title="Load a metrics reporter based on properties.">Load()</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reporter_type</td><td><a class="el" href="classiceberg_1_1Type.html" title="Interface for a data type for a field.">Type</a> identifier matched case-sensitively against the value of "metrics-reporter-impl" in catalog properties, mirroring Java's fully-qualified class-name lookup (e.g., "noop"). </td></tr> |
| <tr><td class="paramname">factory</td><td>Factory function that produces the reporter. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>OK if the registration succeeded, or an error if the factory is invalid. </dd></dl> |
| |
| </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> |
