| <!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::LogMessage 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="structiceberg_1_1LogMessage.html">LogMessage</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structiceberg_1_1LogMessage-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::LogMessage Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>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></p> |
| |
| <p><code>#include <<a class="el" href="logger_8h_source.html">logger.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::LogMessage:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="structiceberg_1_1LogMessage.png" alt=""/> |
| </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:adbc2c729139ce776651e2c0778514ca8" id="r_adbc2c729139ce776651e2c0778514ca8"><td class="memItemLeft" align="right" valign="top"><a id="adbc2c729139ce776651e2c0778514ca8" name="adbc2c729139ce776651e2c0778514ca8"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Builder</b> (<a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> level, std::source_location location=std::source_location::current())</td></tr> |
| <tr class="separator:adbc2c729139ce776651e2c0778514ca8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae4dc68fcc2d7a4f560519a970c473544" id="r_ae4dc68fcc2d7a4f560519a970c473544"><td class="memItemLeft" align="right" valign="top"><a id="ae4dc68fcc2d7a4f560519a970c473544" name="ae4dc68fcc2d7a4f560519a970c473544"></a> |
| Builder & </td><td class="memItemRight" valign="bottom"><b>Message</b> (std::string message)</td></tr> |
| <tr class="memdesc:ae4dc68fcc2d7a4f560519a970c473544"><td class="mdescLeft"> </td><td class="mdescRight">Set the already-formatted message text. <br /></td></tr> |
| <tr class="separator:ae4dc68fcc2d7a4f560519a970c473544"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac07aa97063a1e2d64edbdeaa7024b3e9" id="r_ac07aa97063a1e2d64edbdeaa7024b3e9"><td class="memItemLeft" align="right" valign="top"><a id="ac07aa97063a1e2d64edbdeaa7024b3e9" name="ac07aa97063a1e2d64edbdeaa7024b3e9"></a> |
| Builder & </td><td class="memItemRight" valign="bottom"><b>Attribute</b> (std::string key, std::string value)</td></tr> |
| <tr class="memdesc:ac07aa97063a1e2d64edbdeaa7024b3e9"><td class="mdescLeft"> </td><td class="mdescRight">Append a structured key/value attribute. <br /></td></tr> |
| <tr class="separator:ac07aa97063a1e2d64edbdeaa7024b3e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0af92d415ebac01e9af51071c039c2a6" id="r_a0af92d415ebac01e9af51071c039c2a6"><td class="memItemLeft" align="right" valign="top"><a id="a0af92d415ebac01e9af51071c039c2a6" name="a0af92d415ebac01e9af51071c039c2a6"></a> |
| Builder & </td><td class="memItemRight" valign="bottom"><b>Location</b> (std::source_location location)</td></tr> |
| <tr class="memdesc:a0af92d415ebac01e9af51071c039c2a6"><td class="mdescLeft"> </td><td class="mdescRight">Override the record's source location (defaults to the build site). <br /></td></tr> |
| <tr class="separator:a0af92d415ebac01e9af51071c039c2a6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2409e275f406fd2cc0f3764dfc0da150" id="r_a2409e275f406fd2cc0f3764dfc0da150"><td class="memItemLeft" align="right" valign="top"><a id="a2409e275f406fd2cc0f3764dfc0da150" name="a2409e275f406fd2cc0f3764dfc0da150"></a> |
| <a class="el" href="structiceberg_1_1LogMessage.html">LogMessage</a> </td><td class="memItemRight" valign="bottom"><b>Build</b> ()</td></tr> |
| <tr class="memdesc:a2409e275f406fd2cc0f3764dfc0da150"><td class="mdescLeft"> </td><td class="mdescRight">Materialize the <a class="el" href="structiceberg_1_1LogMessage.html" title="A single log record handed to a Logger.">LogMessage</a>, moving the accumulated state out. <br /></td></tr> |
| <tr class="separator:a2409e275f406fd2cc0f3764dfc0da150"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:ab6decf28a1d461b21c448a2c4c97f31c" id="r_ab6decf28a1d461b21c448a2c4c97f31c"><td class="memItemLeft" align="right" valign="top"><a id="ab6decf28a1d461b21c448a2c4c97f31c" name="ab6decf28a1d461b21c448a2c4c97f31c"></a> |
| <a class="el" href="namespaceiceberg.html#ab9922ae0d07dc85678a1a86c872e387b">LogLevel</a> </td><td class="memItemRight" valign="bottom"><b>level</b> = LogLevel::kOff</td></tr> |
| <tr class="separator:ab6decf28a1d461b21c448a2c4c97f31c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af59dc3f8007ba1a799c999b5ea234400" id="r_af59dc3f8007ba1a799c999b5ea234400"><td class="memItemLeft" align="right" valign="top"><a id="af59dc3f8007ba1a799c999b5ea234400" name="af59dc3f8007ba1a799c999b5ea234400"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>message</b></td></tr> |
| <tr class="separator:af59dc3f8007ba1a799c999b5ea234400"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c6eacb7bfea82bfc9d9370d9e608102" id="r_a3c6eacb7bfea82bfc9d9370d9e608102"><td class="memItemLeft" align="right" valign="top"><a id="a3c6eacb7bfea82bfc9d9370d9e608102" name="a3c6eacb7bfea82bfc9d9370d9e608102"></a> |
| std::source_location </td><td class="memItemRight" valign="bottom"><b>location</b> = std::source_location::current()</td></tr> |
| <tr class="separator:a3c6eacb7bfea82bfc9d9370d9e608102"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af18bbe902d4e064033ef5c99a209f7ca" id="r_af18bbe902d4e064033ef5c99a209f7ca"><td class="memItemLeft" align="right" valign="top"><a id="af18bbe902d4e064033ef5c99a209f7ca" name="af18bbe902d4e064033ef5c99a209f7ca"></a> |
| std::vector< <a class="el" href="structiceberg_1_1LogAttribute.html">LogAttribute</a> > </td><td class="memItemRight" valign="bottom"><b>attributes</b></td></tr> |
| <tr class="separator:af18bbe902d4e064033ef5c99a209f7ca"><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 single log record handed to a <a class="el" href="classiceberg_1_1Logger.html" title="Pluggable logging sink.">Logger</a>. </p> |
| <p>Fluent builder for <a class="el" href="structiceberg_1_1LogMessage.html" title="A single log record handed to a Logger.">LogMessage</a>, the easy path to attach structured attributes.</p> |
| <p>The formatted message is owned (moved in when emitted), so a sink may safely retain the record beyond the <a class="el" href="namespaceiceberg.html#a1aaf619fc9dbd574aa84dea9e41d3288" title="Log to the process-default logger, std::format style. Formats only if the level is enabled; never thr...">Log()</a> call. The member set must not depend on the build's logging backend (the spdlog backend never appears here). Use LogMessage::Builder for a readable way to assemble one, especially with structured attributes.</p> |
| <p>Example: auto record = LogMessage::Builder(LogLevel::kInfo) .Message("scan finished") .Attribute("table", table_name) .Attribute("snapshot_id", std::to_string(id)) .<a class="el" href="structiceberg_1_1LogMessage.html#a2409e275f406fd2cc0f3764dfc0da150" title="Materialize the LogMessage, moving the accumulated state out.">Build()</a>; logger->Log(std::move(record));</p> |
| <p>The location defaults to the caller's construction site (captured via the constructor's default argument); override it with <a class="el" href="structiceberg_1_1LogMessage.html#a0af92d415ebac01e9af51071c039c2a6" title="Override the record's source location (defaults to the build site).">Location()</a> (e.g. to forward a caller's std::source_location). </p> |
| </div><hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/logging/<a class="el" href="logger_8h_source.html">logger.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> |
