mkdocs/docs/api/classiceberg_1_1MetricsReporter.html - iceberg-cpp - Git at Google

 <!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::MetricsReporter 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&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="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1MetricsReporter.html">MetricsReporter</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="classiceberg_1_1MetricsReporter-members.html">List of all members</a>  </div>
   <div class="headertitle"><div class="title">iceberg::MetricsReporter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
 </div><!--header-->
 <div class="contents">

 <p>Interface for reporting metrics from Iceberg operations.
  <a href="classiceberg_1_1MetricsReporter.html#details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="metrics__reporter_8h_source.html">metrics_reporter.h</a>&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for iceberg::MetricsReporter:</div>
 <div class="dyncontent">
  <div class="center">
   <img src="classiceberg_1_1MetricsReporter.png" usemap="#iceberg::MetricsReporter_map" alt=""/>
   <map id="iceberg::MetricsReporter_map" name="iceberg::MetricsReporter_map">
 <area href="classiceberg_1_1CompositeMetricsReporter.html" title="A MetricsReporter that delegates to multiple reporters." alt="iceberg::CompositeMetricsReporter" shape="rect" coords="0,56,210,80"/>
   </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:a4a61bb9e321d19b3cbf3364c849e08f7" id="r_a4a61bb9e321d19b3cbf3364c849e08f7"><td class="memItemLeft" align="right" valign="top">virtual Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsReporter.html#a4a61bb9e321d19b3cbf3364c849e08f7">Initialize</a> (const std::unordered_map&lt; std::string, std::string &gt; &amp;properties)</td></tr>
 <tr class="memdesc:a4a61bb9e321d19b3cbf3364c849e08f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the reporter with catalog properties after construction.  <br /></td></tr>
 <tr class="separator:a4a61bb9e321d19b3cbf3364c849e08f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ada754787bbf4f5625b4739ee489296c7" id="r_ada754787bbf4f5625b4739ee489296c7"><td class="memItemLeft" align="right" valign="top">virtual Status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsReporter.html#ada754787bbf4f5625b4739ee489296c7">Report</a> (const <a class="el" href="namespaceiceberg.html#af4c8144c46c4c1e12da2bf476817c800">MetricsReport</a> &amp;report)=0</td></tr>
 <tr class="memdesc:ada754787bbf4f5625b4739ee489296c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report a metrics report.  <br /></td></tr>
 <tr class="separator:ada754787bbf4f5625b4739ee489296c7"><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>Interface for reporting metrics from Iceberg operations. </p>
 <p>Implementations of this interface can be used to collect and report metrics about scan and commit operations. Common implementations include logging reporters, metrics collectors, and the noop reporter for testing.</p>
 <p>Implementations must not throw. Return an error Status instead. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="a4a61bb9e321d19b3cbf3364c849e08f7" name="a4a61bb9e321d19b3cbf3364c849e08f7"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a4a61bb9e321d19b3cbf3364c849e08f7">&#9670;&#160;</a></span>Initialize()</h2>

 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">virtual Status iceberg::MetricsReporter::Initialize </td>
           <td>(</td>
           <td class="paramtype">const std::unordered_map&lt; std::string, std::string &gt; &amp;&#160;</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">inline</span><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Initialize the reporter with catalog properties after construction. </p>
 <p>Called by <a class="el" href="classiceberg_1_1MetricsReporters.html#ad30a5c4a9a58a083a3d2d7c96f46bc34" title="Load a metrics reporter based on properties.">MetricsReporters::Load()</a> before the first <a class="el" href="classiceberg_1_1MetricsReporter.html#ada754787bbf4f5625b4739ee489296c7" title="Report a metrics report.">Report()</a> invocation. The default implementation is a no-op. Override to perform property-based setup (e.g., configure endpoints, credentials, sampling rates). </p>

 </div>
 </div>
 <a id="ada754787bbf4f5625b4739ee489296c7" name="ada754787bbf4f5625b4739ee489296c7"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ada754787bbf4f5625b4739ee489296c7">&#9670;&#160;</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">virtual Status iceberg::MetricsReporter::Report </td>
           <td>(</td>
           <td class="paramtype">const <a class="el" href="namespaceiceberg.html#af4c8144c46c4c1e12da2bf476817c800">MetricsReport</a> &amp;&#160;</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">pure 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>Implemented in <a class="el" href="classiceberg_1_1CompositeMetricsReporter.html#adc3c44f92b0a28b28b620d373d26861f">iceberg::CompositeMetricsReporter</a>.</p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>iceberg/metrics/<a class="el" href="metrics__reporter_8h_source.html">metrics_reporter.h</a></li>
 </ul>
 </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>
	<!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::MetricsReporter 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_1MetricsReporter.html">MetricsReporter</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#pub-methods">Public Member Functions</a> \|
	<a href="classiceberg_1_1MetricsReporter-members.html">List of all members</a> </div>
	<div class="headertitle"><div class="title">iceberg::MetricsReporter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
	</div><!--header-->
	<div class="contents">

	<p>Interface for reporting metrics from Iceberg operations.
	<a href="classiceberg_1_1MetricsReporter.html#details">More...</a></p>

	<p><code>#include <<a class="el" href="metrics__reporter_8h_source.html">metrics_reporter.h</a>></code></p>
	<div class="dynheader">
	Inheritance diagram for iceberg::MetricsReporter:</div>
	<div class="dyncontent">
	<div class="center">
	<img src="classiceberg_1_1MetricsReporter.png" usemap="#iceberg::MetricsReporter_map" alt=""/>
	<map id="iceberg::MetricsReporter_map" name="iceberg::MetricsReporter_map">
	<area href="classiceberg_1_1CompositeMetricsReporter.html" title="A MetricsReporter that delegates to multiple reporters." alt="iceberg::CompositeMetricsReporter" shape="rect" coords="0,56,210,80"/>
	</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:a4a61bb9e321d19b3cbf3364c849e08f7" 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"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the reporter with catalog properties after construction. <br /></td></tr>
	<tr class="separator:a4a61bb9e321d19b3cbf3364c849e08f7"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:ada754787bbf4f5625b4739ee489296c7" id="r_ada754787bbf4f5625b4739ee489296c7"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MetricsReporter.html#ada754787bbf4f5625b4739ee489296c7">Report</a> (const <a class="el" href="namespaceiceberg.html#af4c8144c46c4c1e12da2bf476817c800">MetricsReport</a> &report)=0</td></tr>
	<tr class="memdesc:ada754787bbf4f5625b4739ee489296c7"><td class="mdescLeft"> </td><td class="mdescRight">Report a metrics report. <br /></td></tr>
	<tr class="separator:ada754787bbf4f5625b4739ee489296c7"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Interface for reporting metrics from Iceberg operations. </p>
	<p>Implementations of this interface can be used to collect and report metrics about scan and commit operations. Common implementations include logging reporters, metrics collectors, and the noop reporter for testing.</p>
	<p>Implementations must not throw. Return an error Status instead. </p>
	</div><h2 class="groupheader">Member Function Documentation</h2>
	<a id="a4a61bb9e321d19b3cbf3364c849e08f7" name="a4a61bb9e321d19b3cbf3364c849e08f7"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a4a61bb9e321d19b3cbf3364c849e08f7">◆ </a></span>Initialize()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="mlabels">
	<tr>
	<td class="mlabels-left">
	<table class="memname">
	<tr>
	<td class="memname">virtual Status iceberg::MetricsReporter::Initialize </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">inline</span><span class="mlabel">virtual</span></span> </td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Initialize the reporter with catalog properties after construction. </p>
	<p>Called by <a class="el" href="classiceberg_1_1MetricsReporters.html#ad30a5c4a9a58a083a3d2d7c96f46bc34" title="Load a metrics reporter based on properties.">MetricsReporters::Load()</a> before the first <a class="el" href="classiceberg_1_1MetricsReporter.html#ada754787bbf4f5625b4739ee489296c7" title="Report a metrics report.">Report()</a> invocation. The default implementation is a no-op. Override to perform property-based setup (e.g., configure endpoints, credentials, sampling rates). </p>

	</div>
	</div>
	<a id="ada754787bbf4f5625b4739ee489296c7" name="ada754787bbf4f5625b4739ee489296c7"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#ada754787bbf4f5625b4739ee489296c7">◆ </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">virtual Status iceberg::MetricsReporter::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">pure 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>Implemented in <a class="el" href="classiceberg_1_1CompositeMetricsReporter.html#adc3c44f92b0a28b28b620d373d26861f">iceberg::CompositeMetricsReporter</a>.</p>

	</div>
	</div>
	<hr/>The documentation for this class was generated from the following file:<ul>
	<li>iceberg/metrics/<a class="el" href="metrics__reporter_8h_source.html">metrics_reporter.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>