| <!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/logging/logger.h File 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_e261caeeda3f8e02492ad86220e1178e.html">logging</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> | |
| <a href="#var-members">Variables</a> </div> |
| <div class="headertitle"><div class="title">logger.h File Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Pluggable logging interface and the process-global default logger. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <concepts></code><br /> |
| <code>#include <cstdlib></code><br /> |
| <code>#include <format></code><br /> |
| <code>#include <functional></code><br /> |
| <code>#include <memory></code><br /> |
| <code>#include <source_location></code><br /> |
| <code>#include <string></code><br /> |
| <code>#include <string_view></code><br /> |
| <code>#include <type_traits></code><br /> |
| <code>#include <unordered_map></code><br /> |
| <code>#include <utility></code><br /> |
| <code>#include <vector></code><br /> |
| <code>#include "<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>"</code><br /> |
| <code>#include "<a class="el" href="log__level_8h_source.html">iceberg/logging/log_level.h</a>"</code><br /> |
| <code>#include "<a class="el" href="result_8h_source.html">iceberg/result.h</a>"</code><br /> |
| </div> |
| <p><a href="logger_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1LogAttribute.html">iceberg::LogAttribute</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A structured key/value attribute attached to a log record. <a href="structiceberg_1_1LogAttribute.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1LogMessage.html">iceberg::LogMessage</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A single log record handed to a <a class="el" href="classiceberg_1_1Logger.html" title="Pluggable logging sink.">Logger</a>. <a href="structiceberg_1_1LogMessage.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Logger.html">iceberg::Logger</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Pluggable logging sink. <a href="classiceberg_1_1Logger.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ScopedLogger.html">iceberg::ScopedLogger</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Bind a logger for the current thread until this object leaves scope. <a href="classiceberg_1_1ScopedLogger.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr> |
| <tr class="memdesc:namespaceiceberg"><td class="mdescLeft"> </td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:a5fa767a899da421ad16b1fd321c5cb23" id="r_a5fa767a899da421ad16b1fd321c5cb23"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a5fa767a899da421ad16b1fd321c5cb23">iceberg::FatalHandler</a> = std::function< void(const std::source_location &, std::string_view message)></td></tr> |
| <tr class="memdesc:a5fa767a899da421ad16b1fd321c5cb23"><td class="mdescLeft"> </td><td class="mdescRight">A hook invoked on the fatal-log path just before std::abort(). <br /></td></tr> |
| <tr class="separator:a5fa767a899da421ad16b1fd321c5cb23"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ae57e7ff8b112264aeee1c3f1a3699368" id="r_ae57e7ff8b112264aeee1c3f1a3699368"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT std::shared_ptr< <a class="el" href="classiceberg_1_1Logger.html">Logger</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#ae57e7ff8b112264aeee1c3f1a3699368">iceberg::GetDefaultLogger</a> ()</td></tr> |
| <tr class="memdesc:ae57e7ff8b112264aeee1c3f1a3699368"><td class="mdescLeft"> </td><td class="mdescRight">Return the process-global default logger (never null). <br /></td></tr> |
| <tr class="separator:ae57e7ff8b112264aeee1c3f1a3699368"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71a0404fee81a92cc327ce2cec8c4290" id="r_a71a0404fee81a92cc327ce2cec8c4290"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT std::shared_ptr< <a class="el" href="classiceberg_1_1Logger.html">Logger</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a71a0404fee81a92cc327ce2cec8c4290">iceberg::GetCurrentLogger</a> ()</td></tr> |
| <tr class="memdesc:a71a0404fee81a92cc327ce2cec8c4290"><td class="mdescLeft"> </td><td class="mdescRight">Return the effective logger for this thread (never null): the active <a class="el" href="classiceberg_1_1ScopedLogger.html" title="Bind a logger for the current thread until this object leaves scope.">ScopedLogger</a> binding if any, else the global default. <br /></td></tr> |
| <tr class="separator:a71a0404fee81a92cc327ce2cec8c4290"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a35cc2730ee5d98264ab5d13080f8ad85" id="r_a35cc2730ee5d98264ab5d13080f8ad85"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a35cc2730ee5d98264ab5d13080f8ad85">iceberg::SetDefaultLogger</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1Logger.html">Logger</a> > logger)</td></tr> |
| <tr class="memdesc:a35cc2730ee5d98264ab5d13080f8ad85"><td class="mdescLeft"> </td><td class="mdescRight">Install a new process-global default logger. <br /></td></tr> |
| <tr class="separator:a35cc2730ee5d98264ab5d13080f8ad85"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0b81ed84855eb9cd54fff60b220a6f01" id="r_a0b81ed84855eb9cd54fff60b220a6f01"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a0b81ed84855eb9cd54fff60b220a6f01">iceberg::SetDefaultLevel</a> (<a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> level)</td></tr> |
| <tr class="memdesc:a0b81ed84855eb9cd54fff60b220a6f01"><td class="mdescLeft"> </td><td class="mdescRight">Set the minimum level of the current default logger. <br /></td></tr> |
| <tr class="separator:a0b81ed84855eb9cd54fff60b220a6f01"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a537acb53df4906ad2c82c396806ba477" id="r_a537acb53df4906ad2c82c396806ba477"><td class="memItemLeft" align="right" valign="top">ICEBERG_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a537acb53df4906ad2c82c396806ba477">iceberg::SetFatalHandler</a> (<a class="el" href="namespaceiceberg.html#a5fa767a899da421ad16b1fd321c5cb23">FatalHandler</a> handler)</td></tr> |
| <tr class="memdesc:a537acb53df4906ad2c82c396806ba477"><td class="mdescLeft"> </td><td class="mdescRight">Install (or clear, with nullptr) the process-global fatal handler. <br /></td></tr> |
| <tr class="separator:a537acb53df4906ad2c82c396806ba477"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a02c78b12379222b1535bd2531e40b89b" id="r_a02c78b12379222b1535bd2531e40b89b"><td class="memItemLeft" align="right" valign="top"><a id="a02c78b12379222b1535bd2531e40b89b" name="a02c78b12379222b1535bd2531e40b89b"></a> |
| ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a5fa767a899da421ad16b1fd321c5cb23">FatalHandler</a> </td><td class="memItemRight" valign="bottom"><b>iceberg::GetFatalHandler</b> ()</td></tr> |
| <tr class="memdesc:a02c78b12379222b1535bd2531e40b89b"><td class="mdescLeft"> </td><td class="mdescRight">Return the installed fatal handler (empty if none). Used by the fatal logging path; thread-safe. <br /></td></tr> |
| <tr class="separator:a02c78b12379222b1535bd2531e40b89b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1aaf619fc9dbd574aa84dea9e41d3288" id="r_a1aaf619fc9dbd574aa84dea9e41d3288"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> |
| <tr class="memitem:a1aaf619fc9dbd574aa84dea9e41d3288"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a1aaf619fc9dbd574aa84dea9e41d3288">iceberg::Log</a> (<a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> level, internal::FmtWithLoc< std::type_identity_t< Args >... > fmt, Args &&... args) noexcept</td></tr> |
| <tr class="memdesc:a1aaf619fc9dbd574aa84dea9e41d3288"><td class="mdescLeft"> </td><td class="mdescRight">Log to the process-default logger, std::format style. Formats only if the level is enabled; never throws. <br /></td></tr> |
| <tr class="separator:a1aaf619fc9dbd574aa84dea9e41d3288"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74836705d924a88e5ce67dbfcd88a048" id="r_a74836705d924a88e5ce67dbfcd88a048"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> |
| <tr class="memitem:a74836705d924a88e5ce67dbfcd88a048"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a74836705d924a88e5ce67dbfcd88a048">iceberg::Log</a> (<a class="el" href="classiceberg_1_1Logger.html">Logger</a> &logger, <a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> level, internal::FmtWithLoc< std::type_identity_t< Args >... > fmt, Args &&... args) noexcept</td></tr> |
| <tr class="memdesc:a74836705d924a88e5ce67dbfcd88a048"><td class="mdescLeft"> </td><td class="mdescRight">Log to an explicit logger, std::format style. Formats only if enabled. <br /></td></tr> |
| <tr class="separator:a74836705d924a88e5ce67dbfcd88a048"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a> |
| Variables</h2></td></tr> |
| <tr class="memitem:a50de3c8be4e894522604dd11f33dbf92" id="r_a50de3c8be4e894522604dd11f33dbf92"><td class="memItemLeft" align="right" valign="top">constexpr std::string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a50de3c8be4e894522604dd11f33dbf92">iceberg::kLevelProperty</a> = "level"</td></tr> |
| <tr class="memdesc:a50de3c8be4e894522604dd11f33dbf92"><td class="mdescLeft"> </td><td class="mdescRight">Well-known <a class="el" href="classiceberg_1_1Logger.html#afb2309f921f8ebb7aa88ada353f37877" title="Property-based setup, called by Loggers::Load() before first use.">Logger::Initialize()</a> property keys. <br /></td></tr> |
| <tr class="separator:a50de3c8be4e894522604dd11f33dbf92"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abf8ff708e6ebaa64e5cdf68fe7303fa2" id="r_abf8ff708e6ebaa64e5cdf68fe7303fa2"><td class="memItemLeft" align="right" valign="top"><a id="abf8ff708e6ebaa64e5cdf68fe7303fa2" name="abf8ff708e6ebaa64e5cdf68fe7303fa2"></a> |
| constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>iceberg::kPatternProperty</b> = "pattern"</td></tr> |
| <tr class="separator:abf8ff708e6ebaa64e5cdf68fe7303fa2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Pluggable logging interface and the process-global default logger. </p> |
| <p>This header is backend-agnostic: it never includes the build-generated backend configuration header and never references the spdlog feature macro, so consumers see one stable API regardless of how the backend was configured. </p> |
| </div></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> |
