82 lines
20 KiB
HTML
82 lines
20 KiB
HTML
<!-- HTML header for doxygen 1.8.11-->
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>OnixS C++ CME Market Data Handler: Pages/LoggingMarketDataAndEvents.md 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="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="onixs-doxygen.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">
|
|
$(window).scroll(function() {
|
|
if ($(this).scrollTop() > 1)
|
|
{
|
|
$('header').addClass("sticky");
|
|
}
|
|
else
|
|
{
|
|
$('header').removeClass("sticky");
|
|
}
|
|
});
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><a href="http://www.onixs.biz"><img alt="Logo" src="onixs.svg"/></a></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">OnixS C++ CME Market Data Handler
|
|
 <span id="projectnumber">4.8.0.10</span>
|
|
</div>
|
|
<div id="projectbrief">API documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</header>
|
|
<div id="wrapper">
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Home</span></a></li>
|
|
<li><a href="modules.html"><span>Contents</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Pages/LoggingMarketDataAndEvents.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="LoggingMarketDataAndEvents_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> \addtogroup logging-options</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> \brief Describes Logger concept and logging services. </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> \section logger-abstraction Logger Abstraction</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> The logging services have been advanced in the SDK starting with </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> this major release. Now it exposes abstraction of logging services </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> defining the way for users to bring custom solutions more suitable </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> for their purposes.</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> Logger abstraction is based on two primary classes:</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> - The OnixS::CME::MDH::Logger which serves as a primary logging instrument, and</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> - The OnixS::CME::MDH::LogEntry which represents an abstraction of a logged entry.</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> The OnixS::CME::MDH::Logger defines an interface for adding entries </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> to the logger. The OnixS::CME::MDH::LogEntry in its turn defines an </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> interface of the entry being added to a log.</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> The SDK contains a few utility classes like OnixS::CME::MDH::LogEvent </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> and its descendants to improve the experience with using logging services.</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> A typical use-case for the logger inside the Handler looks like following:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> ~~~{.cpp}</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> using namespace OnixS::CME::MDH;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> if (LogEntry* entry =</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  logger.addEntry(LogSeverity::Important))</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  LogWarning warning(*entry, warningSource);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  static_cast<LogEvent&>(warning) << warningDescription;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> ~~~</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> Adding a new entry into a log is done by the </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> OnixS::CME::MD3::Logger::addEntry member. It returns </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> instance of OnixS::CME::MDH::Entry which should be </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> used to put information to be logged.</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> An important aspect of Logger abstraction is the fact Logger may </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> return NULL instance of OnixS::CME::MDH::LogEntry. That may happen </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> if the information, which is added to a log, has lower severity than </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> a logger configured with it. For example, an implementation may log </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> only important events and thus regular and debug information is ignored. </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> Therefore, when a caller of the OnixS::CME::MDH::Logger::addEntry supplies </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> a lower severity level, the member returns a NULL instance.</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> A valid (non-NULL) instance of the OnixS::CME::MDH::LogEntry class it can be </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> filled with any information. Once the entry is set up, information in it must be </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> committed to the log by invoking the OnixS::CME::MDH::LogEntry::commit member.</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> \note An instance of OnixS::CME::MDH::Logger successor can be bound </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> to multiple instances of OnixS:CME::MDH::Handler. Therefore, successors</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> of the Logger abstraction must take into consideration the fact the</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> OnixS::CME::MDH::Logger::addEntry member can be invoked simultaneously.</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> \warning It's up to the implementation to allow allocation of the new entries </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> while another entry is in the process of fulfilling with data to be logged. </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> However, the common rule while using a logger is to avoid adding multiple </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> entries at the same time as other implementations may not allow that.</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> \warning Logging issues should not affect market data processing and thus </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> should be exposed through own way. For example, the OnixS::CME::MDH::FileLogger </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> can be associated with an instance of the OnixS::CME::MDH::FileLoggerListener </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> class upon the instance construction. In case of failure like the inability </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> to log an event into a file, an issue is raised and delivered through the </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> OnixS::CME::MDH::FileLoggerListener::onFileLoggerIssue member. </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> \section logger-implementations Ready-to-use Logger Implementations</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> The SDK comes with a few ready-to-use implementations of the Logger </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> abstractions allowing the users to build their solutions quickly:</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> Logger Implementation | Description</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> ---------------------------|-------------------------------------------------------------</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> OnixS::CME:MDH::FileLogger | Implements logging services over text-based files. Logged data is stored into files which may be limited by size. Once volume reaches its limit, Logger detaches logged data, backs it up and starts a new volume.</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> OnixS::CME:MDH::NullLogger | Logs nothings. The Handler suppresses logging at all, if the instance of given class is bound to it. </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> \section bind-logger-to-handler Binding Logger to the Handler</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> The Handler logs important aspects of its execution with the help</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> of Logger abstraction explained above. Logging includes network data</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> received and processed by the Handler, states of books and, of course,</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> errors occurred at execution time.</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> The following example demonstrates how to configure</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> and bind file-based logger to the Handler:</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> ~~~{.cpp}</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> using namespace OnixS::CME::MDH;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> // Implementing logger listener to get notified on </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> // issues which are not raised through other ways. </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> struct FileLoggerIssueTracer</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> : FileLoggerListener</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  // Member is invoked when file logger experience </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  // issue solely beloning to logging subsystem. </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  void</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  onFileLoggerIssue(</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  const FileLogger& logger,</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  const Char* issue)</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  std::cout</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  << "ALERT!!! "</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  "Issue occurred while logging data. " </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  << issue</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  << std::endl;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  }</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> };</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> // Later, in code..</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> HandlerSettings handlerSettings;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> handlerSettings.channel(310);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> handlerSettings.feeds().connectivityConfigurationFile("config.xml");</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> handlerSettings.debugLogging().traceMessages(MessageTracing::SbeFormat);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> Handler handler(handlerSettings);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> FileLoggerSettings loggerSettings;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> loggerSettings.filename(makeLogFilename(handlerSettings.channel()));</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> loggerSettings.severityLevel(LogSeverity::Debug);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> FileLoggerIssueTracer loggerTracer;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> FileLogger logger(loggerSettings, &loggerTracer);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> handler.bindLogger(logger);</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> ~~~</div></div><!-- fragment --></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.11-->
|
|
<!-- start footer part -->
|
|
<footer>
|
|
<hr class="footer"/>
|
|
<address class="footer">
|
|
<small>© <a href="http://www.onixs.biz">Onix Solutions [On<span class="corporate-orange">i</span>x<span class="corporate-orange">S</span>]</a>. All rights reserved.</small>
|
|
</address>
|
|
</footer>
|
|
</div> <!-- wrapper -->
|
|
</body>
|
|
</html>
|