| <!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/metrics/metrics_context.h Source File</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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_5dc26e7e5886cb79baf1860f841364b7.html">metrics</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">metrics_context.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="metrics__context_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="counter_8h.html">iceberg/metrics/counter.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="timer_8h.html">iceberg/metrics/timer.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="foldopen" id="foldopen00035" data-start="{" data-end="};"> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classiceberg_1_1MetricsContext.html"> 35</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1MetricsContext.html">MetricsContext</a> {</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classiceberg_1_1MetricsContext.html">~MetricsContext</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classiceberg_1_1MetricsContext.html#a04db6c1286a00a4237e1bf403e9147f8"> 40</a></span> <span class="keyword">virtual</span> std::shared_ptr<Counter> <a class="code hl_function" href="classiceberg_1_1MetricsContext.html#a04db6c1286a00a4237e1bf403e9147f8">GetCounter</a>(std::string_view name,</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_enumeration" href="namespaceiceberg.html#ab43be837ffa520a0d8a9186d90edac43">CounterUnit</a> unit) = 0;</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div> |
| <div class="foldopen" id="foldopen00046" data-start="{" data-end="}"> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classiceberg_1_1MetricsContext.html#ad0691fd499918d833d9fe0158245e51a"> 46</a></span> std::shared_ptr<Counter> <a class="code hl_function" href="classiceberg_1_1MetricsContext.html#ad0691fd499918d833d9fe0158245e51a">GetCounter</a>(std::string_view name) {</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">return</span> GetCounter(name, CounterUnit::kCount);</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div> |
| </div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classiceberg_1_1MetricsContext.html#a269394fb5a0537eef70b54f8d10781b0"> 51</a></span> <span class="keyword">virtual</span> std::shared_ptr<Timer> <a class="code hl_function" href="classiceberg_1_1MetricsContext.html#a269394fb5a0537eef70b54f8d10781b0">GetTimer</a>(std::string_view name, <a class="code hl_enumeration" href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">TimerUnit</a> unit) = 0;</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="foldopen" id="foldopen00056" data-start="{" data-end="}"> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classiceberg_1_1MetricsContext.html#a6dacd2ba7d895ff58c7870a7c2a86eab"> 56</a></span> std::shared_ptr<Timer> <a class="code hl_function" href="classiceberg_1_1MetricsContext.html#a6dacd2ba7d895ff58c7870a7c2a86eab">GetTimer</a>(std::string_view name) {</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">return</span> GetTimer(name, TimerUnit::kNanoseconds);</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div> |
| </div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classiceberg_1_1MetricsContext.html#a0f5198704f2a80282fe4f45827bfb6d3"> 63</a></span> <span class="keyword">static</span> <span class="keyword">const</span> std::shared_ptr<MetricsContext>& <a class="code hl_function" href="classiceberg_1_1MetricsContext.html#a0f5198704f2a80282fe4f45827bfb6d3">Noop</a>();</div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classiceberg_1_1MetricsContext.html#a1b42df11c9bf12bdba8928f4aa6a99dc"> 66</a></span> <span class="keyword">static</span> std::unique_ptr<MetricsContext> <a class="code hl_function" href="classiceberg_1_1MetricsContext.html#a1b42df11c9bf12bdba8928f4aa6a99dc">Default</a>();</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>};</div> |
| </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="foldopen" id="foldopen00070" data-start="{" data-end="};"> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultMetricsContext.html"> 70</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1DefaultMetricsContext.html">DefaultMetricsContext</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1MetricsContext.html">MetricsContext</a> {</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">using </span>MetricsContext::GetCounter; <span class="comment">// expose the one-arg base overload</span></div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">using </span>MetricsContext::GetTimer; <span class="comment">// expose the one-arg base overload</span></div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultMetricsContext.html#afd37231eefdef92754b51e44f41554ea"> 75</a></span> std::shared_ptr<Counter> <a class="code hl_function" href="classiceberg_1_1DefaultMetricsContext.html#afd37231eefdef92754b51e44f41554ea">GetCounter</a>(std::string_view name, <a class="code hl_enumeration" href="namespaceiceberg.html#ab43be837ffa520a0d8a9186d90edac43">CounterUnit</a> unit) <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultMetricsContext.html#a9a6f4c762fa46b119f7bc7fb5d0a5cd2"> 77</a></span> std::shared_ptr<Timer> <a class="code hl_function" href="classiceberg_1_1DefaultMetricsContext.html#a9a6f4c762fa46b119f7bc7fb5d0a5cd2">GetTimer</a>(std::string_view name, <a class="code hl_enumeration" href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">TimerUnit</a> unit) <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>};</div> |
| </div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultMetricsContext_html"><div class="ttname"><a href="classiceberg_1_1DefaultMetricsContext.html">iceberg::DefaultMetricsContext</a></div><div class="ttdoc">MetricsContext backed by DefaultCounter and DefaultTimer instances.</div><div class="ttdef"><b>Definition</b> metrics_context.h:70</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultMetricsContext_html_a9a6f4c762fa46b119f7bc7fb5d0a5cd2"><div class="ttname"><a href="classiceberg_1_1DefaultMetricsContext.html#a9a6f4c762fa46b119f7bc7fb5d0a5cd2">iceberg::DefaultMetricsContext::GetTimer</a></div><div class="ttdeci">std::shared_ptr< Timer > GetTimer(std::string_view name, TimerUnit unit) override</div><div class="ttdoc">Get or create a named Timer with an explicit unit.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultMetricsContext_html_afd37231eefdef92754b51e44f41554ea"><div class="ttname"><a href="classiceberg_1_1DefaultMetricsContext.html#afd37231eefdef92754b51e44f41554ea">iceberg::DefaultMetricsContext::GetCounter</a></div><div class="ttdeci">std::shared_ptr< Counter > GetCounter(std::string_view name, CounterUnit unit) override</div><div class="ttdoc">Get or create a named Counter with an explicit unit.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1MetricsContext_html"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html">iceberg::MetricsContext</a></div><div class="ttdoc">Factory for creating named Counter and Timer instances.</div><div class="ttdef"><b>Definition</b> metrics_context.h:35</div></div> |
| <div class="ttc" id="aclassiceberg_1_1MetricsContext_html_a04db6c1286a00a4237e1bf403e9147f8"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html#a04db6c1286a00a4237e1bf403e9147f8">iceberg::MetricsContext::GetCounter</a></div><div class="ttdeci">virtual std::shared_ptr< Counter > GetCounter(std::string_view name, CounterUnit unit)=0</div><div class="ttdoc">Get or create a named Counter with an explicit unit.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1MetricsContext_html_a0f5198704f2a80282fe4f45827bfb6d3"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html#a0f5198704f2a80282fe4f45827bfb6d3">iceberg::MetricsContext::Noop</a></div><div class="ttdeci">static const std::shared_ptr< MetricsContext > & Noop()</div><div class="ttdoc">Return the no-op MetricsContext singleton.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1MetricsContext_html_a1b42df11c9bf12bdba8928f4aa6a99dc"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html#a1b42df11c9bf12bdba8928f4aa6a99dc">iceberg::MetricsContext::Default</a></div><div class="ttdeci">static std::unique_ptr< MetricsContext > Default()</div><div class="ttdoc">Create a new DefaultMetricsContext.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1MetricsContext_html_a269394fb5a0537eef70b54f8d10781b0"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html#a269394fb5a0537eef70b54f8d10781b0">iceberg::MetricsContext::GetTimer</a></div><div class="ttdeci">virtual std::shared_ptr< Timer > GetTimer(std::string_view name, TimerUnit unit)=0</div><div class="ttdoc">Get or create a named Timer with an explicit unit.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1MetricsContext_html_a6dacd2ba7d895ff58c7870a7c2a86eab"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html#a6dacd2ba7d895ff58c7870a7c2a86eab">iceberg::MetricsContext::GetTimer</a></div><div class="ttdeci">std::shared_ptr< Timer > GetTimer(std::string_view name)</div><div class="ttdoc">Get or create a nanosecond-precision Timer by name.</div><div class="ttdef"><b>Definition</b> metrics_context.h:56</div></div> |
| <div class="ttc" id="aclassiceberg_1_1MetricsContext_html_ad0691fd499918d833d9fe0158245e51a"><div class="ttname"><a href="classiceberg_1_1MetricsContext.html#ad0691fd499918d833d9fe0158245e51a">iceberg::MetricsContext::GetCounter</a></div><div class="ttdeci">std::shared_ptr< Counter > GetCounter(std::string_view name)</div><div class="ttdoc">Get or create a count-unit Counter by name.</div><div class="ttdef"><b>Definition</b> metrics_context.h:46</div></div> |
| <div class="ttc" id="acounter_8h_html"><div class="ttname"><a href="counter_8h.html">counter.h</a></div><div class="ttdoc">Define metrics counters.</div></div> |
| <div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a392862e5026f65af0f58105ede04659a"><div class="ttname"><a href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">iceberg::TimerUnit</a></div><div class="ttdeci">TimerUnit</div><div class="ttdoc">Time units supported by Timer.</div><div class="ttdef"><b>Definition</b> timer.h:39</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_ab43be837ffa520a0d8a9186d90edac43"><div class="ttname"><a href="namespaceiceberg.html#ab43be837ffa520a0d8a9186d90edac43">iceberg::CounterUnit</a></div><div class="ttdeci">CounterUnit</div><div class="ttdoc">Unit for a Counter metric.</div><div class="ttdef"><b>Definition</b> counter.h:38</div></div> |
| <div class="ttc" id="atimer_8h_html"><div class="ttname"><a href="timer_8h.html">timer.h</a></div><div class="ttdoc">Define metrics timers.</div></div> |
| </div><!-- fragment --></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> |
