RubyGems - passenger - Versions diffs - 3.0.4 → 3.0.5 - Mend

passenger 3.0.4 → 3.0.5

Potentially problematic release.

This version of passenger might be problematic. Click here for more details.

Files changed (571) hide show

data/doc/cxxapi/Logging_8h_source.html ADDED

@@ -0,0 +1,796 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: Logging.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</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 class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>Logging.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00006"></a>00006 <span class="comment"> *</span>
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_LOGGING_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_LOGGING_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;oxt/system_calls.hpp&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;oxt/backtrace.hpp&gt;</span>
+<a name="l00031"></a>00031
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;sys/time.h&gt;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;sys/file.h&gt;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;sys/resource.h&gt;</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;fcntl.h&gt;</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include &lt;pthread.h&gt;</span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;map&gt;</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;ostream&gt;</span>
+<a name="l00042"></a>00042 <span class="preprocessor">#include &lt;sstream&gt;</span>
+<a name="l00043"></a>00043 <span class="preprocessor">#include &lt;cstdio&gt;</span>
+<a name="l00044"></a>00044 <span class="preprocessor">#include &lt;ctime&gt;</span>
+<a name="l00045"></a>00045
+<a name="l00046"></a>00046 <span class="preprocessor">#include &quot;RandomGenerator.h&quot;</span>
+<a name="l00047"></a>00047 <span class="preprocessor">#include &quot;FileDescriptor.h&quot;</span>
+<a name="l00048"></a>00048 <span class="preprocessor">#include &quot;MessageClient.h&quot;</span>
+<a name="l00049"></a>00049 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
+<a name="l00050"></a>00050 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
+<a name="l00051"></a>00051 <span class="preprocessor">#include &quot;Utils.h&quot;</span>
+<a name="l00052"></a>00052 <span class="preprocessor">#include &quot;Utils/StrIntUtils.h&quot;</span>
+<a name="l00053"></a>00053 <span class="preprocessor">#include &quot;Utils/MD5.h&quot;</span>
+<a name="l00054"></a>00054 <span class="preprocessor">#include &quot;Utils/SystemTime.h&quot;</span>
+<a name="l00055"></a>00055
+<a name="l00056"></a>00056
+<a name="l00057"></a>00057 <span class="keyword">namespace </span>Passenger {
+<a name="l00058"></a>00058
+<a name="l00059"></a>00059 <span class="keyword">using namespace </span>std;
+<a name="l00060"></a>00060 <span class="keyword">using namespace </span>boost;
+<a name="l00061"></a>00061 <span class="keyword">using namespace </span>oxt;
+<a name="l00062"></a>00062
+<a name="l00063"></a>00063
+<a name="l00064"></a>00064 <span class="comment">/********** Debug logging facilities **********/</span>
+<a name="l00065"></a>00065
+<a name="l00066"></a>00066 <span class="keyword">extern</span> <span class="keywordtype">int</span> _logLevel;
+<a name="l00067"></a>00067 <span class="keyword">extern</span> ostream *_logStream;
+<a name="l00068"></a>00068
+<a name="l00069"></a>00069 <span class="keywordtype">int</span> getLogLevel();
+<a name="l00070"></a>00070 <span class="keywordtype">void</span> setLogLevel(<span class="keywordtype">int</span> value);
+<a name="l00071"></a>00071 <span class="keywordtype">void</span> setDebugFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *logFile = NULL);
+<a name="l00072"></a>00072 <span class="comment"></span>
+<a name="l00073"></a>00073 <span class="comment">/**</span>
+<a name="l00074"></a>00074 <span class="comment"> * Write the given expression to the given stream.</span>
+<a name="l00075"></a>00075 <span class="comment"> *</span>
+<a name="l00076"></a>00076 <span class="comment"> * @param expr The expression to write.</span>
+<a name="l00077"></a>00077 <span class="comment"> * @param stream A pointer to an object that accepts the &#39;&lt;&lt;&#39; operator.</span>
+<a name="l00078"></a>00078 <span class="comment"> */</span>
+<a name="l00079"></a>00079 <span class="preprocessor">#define P_LOG_TO(level, expr, stream) \</span>
+<a name="l00080"></a>00080 <span class="preprocessor">        do { \</span>
+<a name="l00081"></a>00081 <span class="preprocessor">                if (stream != 0 &amp;&amp; Passenger::_logLevel &gt;= level) { \</span>
+<a name="l00082"></a>00082 <span class="preprocessor">                        time_t the_time;                        \</span>
+<a name="l00083"></a>00083 <span class="preprocessor">                        struct tm the_tm;                       \</span>
+<a name="l00084"></a>00084 <span class="preprocessor">                        char datetime_buf[60];                  \</span>
+<a name="l00085"></a>00085 <span class="preprocessor">                        struct timeval tv;                      \</span>
+<a name="l00086"></a>00086 <span class="preprocessor">                        std::stringstream sstream;              \</span>
+<a name="l00087"></a>00087 <span class="preprocessor">                                                                \</span>
+<a name="l00088"></a>00088 <span class="preprocessor">                        the_time = time(NULL);                  \</span>
+<a name="l00089"></a>00089 <span class="preprocessor">                        localtime_r(&amp;the_time, &amp;the_tm);        \</span>
+<a name="l00090"></a>00090 <span class="preprocessor">                        strftime(datetime_buf, sizeof(datetime_buf), &quot;%F %H:%M:%S&quot;, &amp;the_tm); \</span>
+<a name="l00091"></a>00091 <span class="preprocessor">                        gettimeofday(&amp;tv, NULL); \</span>
+<a name="l00092"></a>00092 <span class="preprocessor">                        sstream &lt;&lt; \</span>
+<a name="l00093"></a>00093 <span class="preprocessor">                                &quot;[ pid=&quot; &lt;&lt; ((unsigned long) getpid()) &lt;&lt;  \</span>
+<a name="l00094"></a>00094 <span class="preprocessor">                                &quot; thr=&quot; &lt;&lt; pthread_self() &lt;&lt; \</span>
+<a name="l00095"></a>00095 <span class="preprocessor">                                &quot; file=&quot; &lt;&lt; __FILE__ &lt;&lt; &quot;:&quot; &lt;&lt; (unsigned long) __LINE__ &lt;&lt; \</span>
+<a name="l00096"></a>00096 <span class="preprocessor">                                &quot; time=&quot; &lt;&lt; datetime_buf &lt;&lt; &quot;.&quot; &lt;&lt; (unsigned long) (tv.tv_usec / 1000) &lt;&lt; \</span>
+<a name="l00097"></a>00097 <span class="preprocessor">                                &quot; ]: &quot; &lt;&lt; \</span>
+<a name="l00098"></a>00098 <span class="preprocessor">                                expr &lt;&lt; std::endl;      \</span>
+<a name="l00099"></a>00099 <span class="preprocessor">                        *stream &lt;&lt; sstream.str();               \</span>
+<a name="l00100"></a>00100 <span class="preprocessor">                        stream-&gt;flush();                        \</span>
+<a name="l00101"></a>00101 <span class="preprocessor">                } \</span>
+<a name="l00102"></a>00102 <span class="preprocessor">        } while (false)</span>
+<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00104"></a>00104 <span class="comment">/**</span>
+<a name="l00105"></a>00105 <span class="comment"> * Write the given expression to the log stream.</span>
+<a name="l00106"></a>00106 <span class="comment"> */</span>
+<a name="l00107"></a>00107 <span class="preprocessor">#define P_LOG(level, expr) P_LOG_TO(level, expr, Passenger::_logStream)</span>
+<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00109"></a>00109 <span class="comment">/**</span>
+<a name="l00110"></a>00110 <span class="comment"> * Write the given expression, which represents a warning,</span>
+<a name="l00111"></a>00111 <span class="comment"> * to the log stream.</span>
+<a name="l00112"></a>00112 <span class="comment"> */</span>
+<a name="l00113"></a>00113 <span class="preprocessor">#define P_WARN(expr) P_LOG(0, expr)</span>
+<a name="l00114"></a>00114 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00115"></a>00115 <span class="comment">/**</span>
+<a name="l00116"></a>00116 <span class="comment"> * Write the given expression, which represents an error,</span>
+<a name="l00117"></a>00117 <span class="comment"> * to the log stream.</span>
+<a name="l00118"></a>00118 <span class="comment"> */</span>
+<a name="l00119"></a>00119 <span class="preprocessor">#define P_ERROR(expr) P_LOG(-1, expr)</span>
+<a name="l00120"></a>00120 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00121"></a>00121 <span class="comment">/**</span>
+<a name="l00122"></a>00122 <span class="comment"> * Write the given expression, which represents a debugging message,</span>
+<a name="l00123"></a>00123 <span class="comment"> * to the log stream.</span>
+<a name="l00124"></a>00124 <span class="comment"> */</span>
+<a name="l00125"></a>00125 <span class="preprocessor">#define P_DEBUG(expr) P_TRACE(1, expr)</span>
+<a name="l00126"></a>00126 <span class="preprocessor"></span>
+<a name="l00127"></a>00127 <span class="preprocessor">#ifdef PASSENGER_DEBUG</span>
+<a name="l00128"></a>00128 <span class="preprocessor"></span><span class="preprocessor">        #define P_TRACE(level, expr) P_LOG_TO(level, expr, Passenger::_logStream)</span>
+<a name="l00129"></a>00129 <span class="preprocessor"></span>
+<a name="l00130"></a>00130 <span class="preprocessor">        #define P_ASSERT(expr, result_if_failed, message) \</span>
+<a name="l00131"></a>00131 <span class="preprocessor">                do { \</span>
+<a name="l00132"></a>00132 <span class="preprocessor">                        if (!(expr)) { \</span>
+<a name="l00133"></a>00133 <span class="preprocessor">                                P_ERROR(&quot;Assertion failed: &quot; &lt;&lt; message); \</span>
+<a name="l00134"></a>00134 <span class="preprocessor">                                return result_if_failed; \</span>
+<a name="l00135"></a>00135 <span class="preprocessor">                        } \</span>
+<a name="l00136"></a>00136 <span class="preprocessor">                } while (false)</span>
+<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="preprocessor">        #define P_ASSERT_WITH_VOID_RETURN(expr, message) \</span>
+<a name="l00138"></a>00138 <span class="preprocessor">                do { \</span>
+<a name="l00139"></a>00139 <span class="preprocessor">                        if (!(expr)) { \</span>
+<a name="l00140"></a>00140 <span class="preprocessor">                                P_ERROR(&quot;Assertion failed: &quot; &lt;&lt; message); \</span>
+<a name="l00141"></a>00141 <span class="preprocessor">                                return; \</span>
+<a name="l00142"></a>00142 <span class="preprocessor">                        } \</span>
+<a name="l00143"></a>00143 <span class="preprocessor">                } while (false)</span>
+<a name="l00144"></a>00144 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00145"></a>00145 <span class="preprocessor"></span><span class="preprocessor">        #define P_TRACE(level, expr) do { </span><span class="comment">/* nothing */</span> } while (false)
+<a name="l00146"></a>00146
+<a name="l00147"></a>00147 <span class="preprocessor">        #define P_ASSERT(expr, result_if_failed, message) do { </span><span class="comment">/* nothing */</span> } while (false)
+<a name="l00148"></a>00148 <span class="preprocessor">        #define P_ASSERT_WITH_VOID_RETURN(expr, message) do { </span><span class="comment">/* nothing */</span> } while (false)
+<a name="l00149"></a>00149 <span class="preprocessor">#endif</span>
+<a name="l00150"></a>00150 <span class="preprocessor"></span>
+<a name="l00151"></a>00151
+<a name="l00152"></a>00152 <span class="comment">/********** Transaction logging facilities *********/</span>
+<a name="l00153"></a>00153
+<a name="l00154"></a>00154 <span class="keyword">struct </span>AnalyticsLoggerSharedData {
+<a name="l00155"></a>00155         boost::mutex lock;
+<a name="l00156"></a>00156         MessageClient client;
+<a name="l00157"></a>00157
+<a name="l00158"></a>00158         <span class="keywordtype">void</span> disconnect(<span class="keywordtype">bool</span> checkErrorResponse = <span class="keyword">false</span>) {
+<a name="l00159"></a>00159                 <span class="keywordflow">if</span> (checkErrorResponse &amp;&amp; client.connected()) {
+<a name="l00160"></a>00160                         <span class="comment">// Maybe the server sent us an error message and closed</span>
+<a name="l00161"></a>00161                         <span class="comment">// the connection. Let&#39;s check.</span>
+<a name="l00162"></a>00162                         TRACE_POINT();
+<a name="l00163"></a>00163                         vector&lt;string&gt; args;
+<a name="l00164"></a>00164                         <span class="keywordtype">bool</span> hasData = <span class="keyword">true</span>;
+<a name="l00165"></a>00165
+<a name="l00166"></a>00166                         <span class="keywordflow">try</span> {
+<a name="l00167"></a>00167                                 hasData = client.read(args);
+<a name="l00168"></a>00168                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;e) {
+<a name="l00169"></a>00169                                 <span class="keywordflow">if</span> (e.code() != ECONNRESET) {
+<a name="l00170"></a>00170                                         <span class="keywordflow">throw</span>;
+<a name="l00171"></a>00171                                 }
+<a name="l00172"></a>00172                         }
+<a name="l00173"></a>00173
+<a name="l00174"></a>00174                         UPDATE_TRACE_POINT();
+<a name="l00175"></a>00175                         client.disconnect();
+<a name="l00176"></a>00176                         <span class="keywordflow">if</span> (hasData) {
+<a name="l00177"></a>00177                                 <span class="keywordflow">if</span> (args[0] == <span class="stringliteral">&quot;error&quot;</span>) {
+<a name="l00178"></a>00178                                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The logging server responded with an error: &quot;</span> + args[1]);
+<a name="l00179"></a>00179                                 } <span class="keywordflow">else</span> {
+<a name="l00180"></a>00180                                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The logging server sent an unexpected reply.&quot;</span>);
+<a name="l00181"></a>00181                                 }
+<a name="l00182"></a>00182                         }
+<a name="l00183"></a>00183                 } <span class="keywordflow">else</span> {
+<a name="l00184"></a>00184                         client.disconnect();
+<a name="l00185"></a>00185                 }
+<a name="l00186"></a>00186         }
+<a name="l00187"></a>00187 };
+<a name="l00188"></a>00188 <span class="keyword">typedef</span> shared_ptr&lt;AnalyticsLoggerSharedData&gt; AnalyticsLoggerSharedDataPtr;
+<a name="l00189"></a>00189
+<a name="l00190"></a>00190 <span class="keyword">class </span>AnalyticsLog {
+<a name="l00191"></a>00191 <span class="keyword">private</span>:
+<a name="l00192"></a>00192         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> INT64_STR_BUFSIZE = 22; <span class="comment">// Long enough for a 64-bit number.</span>
+<a name="l00193"></a>00193
+<a name="l00194"></a>00194         AnalyticsLoggerSharedDataPtr sharedData;
+<a name="l00195"></a>00195         <span class="keywordtype">string</span> txnId;
+<a name="l00196"></a>00196         <span class="keywordtype">string</span> groupName;
+<a name="l00197"></a>00197         <span class="keywordtype">string</span> category;
+<a name="l00198"></a>00198         <span class="keywordtype">string</span> unionStationKey;
+<a name="l00199"></a>00199         <span class="keywordtype">bool</span> shouldFlushToDiskAfterClose;
+<a name="l00200"></a>00200         <span class="comment"></span>
+<a name="l00201"></a>00201 <span class="comment">        /**</span>
+<a name="l00202"></a>00202 <span class="comment">         * Buffer must be at least txnId.size() + 1 + INT64_STR_BUFSIZE + 1 bytes.</span>
+<a name="l00203"></a>00203 <span class="comment">         */</span>
+<a name="l00204"></a>00204         <span class="keywordtype">char</span> *insertTxnIdAndTimestamp(<span class="keywordtype">char</span> *buffer) {
+<a name="l00205"></a>00205                 <span class="keywordtype">int</span> size;
+<a name="l00206"></a>00206
+<a name="l00207"></a>00207                 <span class="comment">// &quot;txn-id-here&quot;</span>
+<a name="l00208"></a>00208                 memcpy(buffer, txnId.c_str(), txnId.size());
+<a name="l00209"></a>00209                 buffer += txnId.size();
+<a name="l00210"></a>00210
+<a name="l00211"></a>00211                 <span class="comment">// &quot;txn-id-here &quot;</span>
+<a name="l00212"></a>00212                 *buffer = <span class="charliteral">&#39; &#39;</span>;
+<a name="l00213"></a>00213                 buffer++;
+<a name="l00214"></a>00214
+<a name="l00215"></a>00215                 <span class="comment">// &quot;txn-id-here 123456&quot;</span>
+<a name="l00216"></a>00216                 size = snprintf(buffer, INT64_STR_BUFSIZE, <span class="stringliteral">&quot;%llu&quot;</span>, SystemTime::getUsec());
+<a name="l00217"></a>00217                 <span class="keywordflow">if</span> (size &gt;= INT64_STR_BUFSIZE) {
+<a name="l00218"></a>00218                         <span class="comment">// The buffer is too small.</span>
+<a name="l00219"></a>00219                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;Cannot format a new transaction log message timestamp.&quot;</span>);
+<a name="l00220"></a>00220                 }
+<a name="l00221"></a>00221                 buffer += size;
+<a name="l00222"></a>00222
+<a name="l00223"></a>00223                 <span class="comment">// &quot;txn-id-here 123456 &quot;</span>
+<a name="l00224"></a>00224                 *buffer = <span class="charliteral">&#39; &#39;</span>;
+<a name="l00225"></a>00225
+<a name="l00226"></a>00226                 <span class="keywordflow">return</span> buffer + 1;
+<a name="l00227"></a>00227         }
+<a name="l00228"></a>00228
+<a name="l00229"></a>00229 <span class="keyword">public</span>:
+<a name="l00230"></a>00230         AnalyticsLog() { }
+<a name="l00231"></a>00231
+<a name="l00232"></a>00232         AnalyticsLog(<span class="keyword">const</span> AnalyticsLoggerSharedDataPtr &amp;sharedData, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;txnId,
+<a name="l00233"></a>00233                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;groupName, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;category, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;unionStationKey)
+<a name="l00234"></a>00234         {
+<a name="l00235"></a>00235                 this-&gt;sharedData = sharedData;
+<a name="l00236"></a>00236                 this-&gt;txnId      = txnId;
+<a name="l00237"></a>00237                 this-&gt;groupName  = groupName;
+<a name="l00238"></a>00238                 this-&gt;category   = category;
+<a name="l00239"></a>00239                 this-&gt;unionStationKey = unionStationKey;
+<a name="l00240"></a>00240                 shouldFlushToDiskAfterClose = <span class="keyword">false</span>;
+<a name="l00241"></a>00241         }
+<a name="l00242"></a>00242
+<a name="l00243"></a>00243         ~AnalyticsLog() {
+<a name="l00244"></a>00244                 <span class="keywordflow">if</span> (sharedData != NULL) {
+<a name="l00245"></a>00245                         lock_guard&lt;boost::mutex&gt; l(sharedData-&gt;lock);
+<a name="l00246"></a>00246                         <span class="keywordflow">if</span> (sharedData-&gt;client.connected()) {
+<a name="l00247"></a>00247                                 <span class="keywordflow">try</span> {
+<a name="l00248"></a>00248                                         <span class="keywordtype">char</span> timestamp[2 * <span class="keyword">sizeof</span>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) + 1];
+<a name="l00249"></a>00249                                         integerToHexatri&lt;unsigned long long&gt;(SystemTime::getUsec(),
+<a name="l00250"></a>00250                                                 timestamp);
+<a name="l00251"></a>00251                                         sharedData-&gt;client.write(<span class="stringliteral">&quot;closeTransaction&quot;</span>,
+<a name="l00252"></a>00252                                                 txnId.c_str(), timestamp, NULL);
+<a name="l00253"></a>00253                                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;e) {
+<a name="l00254"></a>00254                                         <span class="keywordflow">if</span> (e.code() == EPIPE || e.code() == ECONNRESET) {
+<a name="l00255"></a>00255                                                 TRACE_POINT();
+<a name="l00256"></a>00256                                                 sharedData-&gt;disconnect(<span class="keyword">true</span>);
+<a name="l00257"></a>00257                                         } <span class="keywordflow">else</span> {
+<a name="l00258"></a>00258                                                 <span class="keywordflow">throw</span>;
+<a name="l00259"></a>00259                                         }
+<a name="l00260"></a>00260                                 }
+<a name="l00261"></a>00261
+<a name="l00262"></a>00262                                 <span class="keywordflow">if</span> (shouldFlushToDiskAfterClose) {
+<a name="l00263"></a>00263                                         vector&lt;string&gt; args;
+<a name="l00264"></a>00264                                         sharedData-&gt;client.write(<span class="stringliteral">&quot;flush&quot;</span>, NULL);
+<a name="l00265"></a>00265                                         sharedData-&gt;client.read(args);
+<a name="l00266"></a>00266                                 }
+<a name="l00267"></a>00267                         }
+<a name="l00268"></a>00268                 }
+<a name="l00269"></a>00269         }
+<a name="l00270"></a>00270
+<a name="l00271"></a>00271         <span class="keywordtype">void</span> message(<span class="keyword">const</span> StaticString &amp;text) {
+<a name="l00272"></a>00272                 <span class="keywordflow">if</span> (sharedData != NULL) {
+<a name="l00273"></a>00273                         lock_guard&lt;boost::mutex&gt; l(sharedData-&gt;lock);
+<a name="l00274"></a>00274                         <span class="keywordflow">if</span> (sharedData-&gt;client.connected()) {
+<a name="l00275"></a>00275                                 <span class="keywordtype">char</span> timestamp[2 * <span class="keyword">sizeof</span>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) + 1];
+<a name="l00276"></a>00276                                 integerToHexatri&lt;unsigned long long&gt;(SystemTime::getUsec(), timestamp);
+<a name="l00277"></a>00277                                 sharedData-&gt;client.write(<span class="stringliteral">&quot;log&quot;</span>, txnId.c_str(),
+<a name="l00278"></a>00278                                         timestamp, NULL);
+<a name="l00279"></a>00279                                 sharedData-&gt;client.writeScalar(text);
+<a name="l00280"></a>00280                         }
+<a name="l00281"></a>00281                 }
+<a name="l00282"></a>00282         }
+<a name="l00283"></a>00283
+<a name="l00284"></a>00284         <span class="keywordtype">void</span> abort(<span class="keyword">const</span> StaticString &amp;text) {
+<a name="l00285"></a>00285                 <span class="keywordflow">if</span> (sharedData != NULL) {
+<a name="l00286"></a>00286                         lock_guard&lt;boost::mutex&gt; l(sharedData-&gt;lock);
+<a name="l00287"></a>00287                         <span class="keywordflow">if</span> (sharedData-&gt;client.connected()) {
+<a name="l00288"></a>00288                                 message(<span class="stringliteral">&quot;ABORT&quot;</span>);
+<a name="l00289"></a>00289                         }
+<a name="l00290"></a>00290                 }
+<a name="l00291"></a>00291         }
+<a name="l00292"></a>00292
+<a name="l00293"></a>00293         <span class="keywordtype">void</span> flushToDiskAfterClose(<span class="keywordtype">bool</span> value) {
+<a name="l00294"></a>00294                 shouldFlushToDiskAfterClose = value;
+<a name="l00295"></a>00295         }
+<a name="l00296"></a>00296
+<a name="l00297"></a>00297         <span class="keywordtype">bool</span> isNull()<span class="keyword"> const </span>{
+<a name="l00298"></a>00298                 <span class="keywordflow">return</span> sharedData == NULL;
+<a name="l00299"></a>00299         }
+<a name="l00300"></a>00300
+<a name="l00301"></a>00301         <span class="keywordtype">string</span> getTxnId()<span class="keyword"> const </span>{
+<a name="l00302"></a>00302                 <span class="keywordflow">return</span> txnId;
+<a name="l00303"></a>00303         }
+<a name="l00304"></a>00304
+<a name="l00305"></a>00305         <span class="keywordtype">string</span> getGroupName()<span class="keyword"> const </span>{
+<a name="l00306"></a>00306                 <span class="keywordflow">return</span> groupName;
+<a name="l00307"></a>00307         }
+<a name="l00308"></a>00308
+<a name="l00309"></a>00309         <span class="keywordtype">string</span> getCategory()<span class="keyword"> const </span>{
+<a name="l00310"></a>00310                 <span class="keywordflow">return</span> category;
+<a name="l00311"></a>00311         }
+<a name="l00312"></a>00312
+<a name="l00313"></a>00313         <span class="keywordtype">string</span> getUnionStationKey()<span class="keyword"> const </span>{
+<a name="l00314"></a>00314                 <span class="keywordflow">return</span> unionStationKey;
+<a name="l00315"></a>00315         }
+<a name="l00316"></a>00316 };
+<a name="l00317"></a>00317
+<a name="l00318"></a>00318 <span class="keyword">typedef</span> shared_ptr&lt;AnalyticsLog&gt; AnalyticsLogPtr;
+<a name="l00319"></a>00319
+<a name="l00320"></a>00320 <span class="keyword">class </span>AnalyticsScopeLog {
+<a name="l00321"></a>00321 <span class="keyword">private</span>:
+<a name="l00322"></a>00322         AnalyticsLog *log;
+<a name="l00323"></a>00323         <span class="keyword">enum</span> {
+<a name="l00324"></a>00324                 NAME,
+<a name="l00325"></a>00325                 GRANULAR
+<a name="l00326"></a>00326         } type;
+<a name="l00327"></a>00327         <span class="keyword">union </span>{
+<a name="l00328"></a>00328                 <span class="keyword">const</span> <span class="keywordtype">char</span> *name;
+<a name="l00329"></a>00329                 <span class="keyword">struct </span>{
+<a name="l00330"></a>00330                         <span class="keyword">const</span> <span class="keywordtype">char</span> *endMessage;
+<a name="l00331"></a>00331                         <span class="keyword">const</span> <span class="keywordtype">char</span> *abortMessage;
+<a name="l00332"></a>00332                 } granular;
+<a name="l00333"></a>00333         } data;
+<a name="l00334"></a>00334         <span class="keywordtype">bool</span> ok;
+<a name="l00335"></a>00335
+<a name="l00336"></a>00336         <span class="keyword">static</span> <span class="keywordtype">string</span> timevalToString(<span class="keyword">struct</span> timeval &amp;tv) {
+<a name="l00337"></a>00337                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> i = (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) tv.tv_sec * 1000000 + tv.tv_usec;
+<a name="l00338"></a>00338                 <span class="keywordflow">return</span> usecToString(i);
+<a name="l00339"></a>00339         }
+<a name="l00340"></a>00340
+<a name="l00341"></a>00341         <span class="keyword">static</span> <span class="keywordtype">string</span> usecToString(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> usec) {
+<a name="l00342"></a>00342                 <span class="keywordtype">char</span> timestamp[2 * <span class="keyword">sizeof</span>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) + 1];
+<a name="l00343"></a>00343                 integerToHexatri&lt;unsigned long long&gt;(usec, timestamp);
+<a name="l00344"></a>00344                 <span class="keywordflow">return</span> timestamp;
+<a name="l00345"></a>00345         }
+<a name="l00346"></a>00346
+<a name="l00347"></a>00347 <span class="keyword">public</span>:
+<a name="l00348"></a>00348         AnalyticsScopeLog(<span class="keyword">const</span> AnalyticsLogPtr &amp;log, <span class="keyword">const</span> <span class="keywordtype">char</span> *name) {
+<a name="l00349"></a>00349                 this-&gt;log = log.get();
+<a name="l00350"></a>00350                 type = NAME;
+<a name="l00351"></a>00351                 data.name = name;
+<a name="l00352"></a>00352                 ok = <span class="keyword">false</span>;
+<a name="l00353"></a>00353                 <span class="keywordflow">if</span> (log != NULL &amp;&amp; !log-&gt;isNull()) {
+<a name="l00354"></a>00354                         <span class="keywordtype">string</span> message;
+<a name="l00355"></a>00355                         <span class="keyword">struct </span>rusage usage;
+<a name="l00356"></a>00356
+<a name="l00357"></a>00357                         message.reserve(150);
+<a name="l00358"></a>00358                         message.append(<span class="stringliteral">&quot;BEGIN: &quot;</span>);
+<a name="l00359"></a>00359                         message.append(name);
+<a name="l00360"></a>00360                         message.append(<span class="stringliteral">&quot; (&quot;</span>);
+<a name="l00361"></a>00361                         message.append(usecToString(SystemTime::getUsec()));
+<a name="l00362"></a>00362                         message.append(<span class="stringliteral">&quot;,&quot;</span>);
+<a name="l00363"></a>00363                         <span class="keywordflow">if</span> (getrusage(RUSAGE_SELF, &amp;usage) == -1) {
+<a name="l00364"></a>00364                                 <span class="keywordtype">int</span> e = errno;
+<a name="l00365"></a>00365                                 <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">&quot;getrusage() failed&quot;</span>, e);
+<a name="l00366"></a>00366                         }
+<a name="l00367"></a>00367                         message.append(timevalToString(usage.ru_utime));
+<a name="l00368"></a>00368                         message.append(<span class="stringliteral">&quot;,&quot;</span>);
+<a name="l00369"></a>00369                         message.append(timevalToString(usage.ru_stime));
+<a name="l00370"></a>00370                         message.append(<span class="stringliteral">&quot;) &quot;</span>);
+<a name="l00371"></a>00371                         log-&gt;message(message);
+<a name="l00372"></a>00372                 }
+<a name="l00373"></a>00373         }
+<a name="l00374"></a>00374
+<a name="l00375"></a>00375         AnalyticsScopeLog(<span class="keyword">const</span> AnalyticsLogPtr &amp;log, <span class="keyword">const</span> <span class="keywordtype">char</span> *beginMessage,
+<a name="l00376"></a>00376                           <span class="keyword">const</span> <span class="keywordtype">char</span> *endMessage, <span class="keyword">const</span> <span class="keywordtype">char</span> *abortMessage = NULL
+<a name="l00377"></a>00377         ) {
+<a name="l00378"></a>00378                 this-&gt;log = log.get();
+<a name="l00379"></a>00379                 <span class="keywordflow">if</span> (log != NULL) {
+<a name="l00380"></a>00380                         type = GRANULAR;
+<a name="l00381"></a>00381                         data.granular.endMessage = endMessage;
+<a name="l00382"></a>00382                         data.granular.abortMessage = abortMessage;
+<a name="l00383"></a>00383                         ok = abortMessage == NULL;
+<a name="l00384"></a>00384                         log-&gt;message(beginMessage);
+<a name="l00385"></a>00385                 }
+<a name="l00386"></a>00386         }
+<a name="l00387"></a>00387
+<a name="l00388"></a>00388         ~AnalyticsScopeLog() {
+<a name="l00389"></a>00389                 <span class="keywordflow">if</span> (log == NULL) {
+<a name="l00390"></a>00390                         <span class="keywordflow">return</span>;
+<a name="l00391"></a>00391                 }
+<a name="l00392"></a>00392                 <span class="keywordflow">if</span> (type == NAME) {
+<a name="l00393"></a>00393                         <span class="keywordflow">if</span> (!log-&gt;isNull()) {
+<a name="l00394"></a>00394                                 <span class="keywordtype">string</span> message;
+<a name="l00395"></a>00395                                 <span class="keyword">struct </span>rusage usage;
+<a name="l00396"></a>00396
+<a name="l00397"></a>00397                                 message.reserve(150);
+<a name="l00398"></a>00398                                 <span class="keywordflow">if</span> (ok) {
+<a name="l00399"></a>00399                                         message.append(<span class="stringliteral">&quot;END: &quot;</span>);
+<a name="l00400"></a>00400                                 } <span class="keywordflow">else</span> {
+<a name="l00401"></a>00401                                         message.append(<span class="stringliteral">&quot;FAIL: &quot;</span>);
+<a name="l00402"></a>00402                                 }
+<a name="l00403"></a>00403                                 message.append(data.name);
+<a name="l00404"></a>00404                                 message.append(<span class="stringliteral">&quot; (&quot;</span>);
+<a name="l00405"></a>00405                                 message.append(usecToString(SystemTime::getUsec()));
+<a name="l00406"></a>00406                                 message.append(<span class="stringliteral">&quot;,&quot;</span>);
+<a name="l00407"></a>00407                                 <span class="keywordflow">if</span> (getrusage(RUSAGE_SELF, &amp;usage) == -1) {
+<a name="l00408"></a>00408                                         <span class="keywordtype">int</span> e = errno;
+<a name="l00409"></a>00409                                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">&quot;getrusage() failed&quot;</span>, e);
+<a name="l00410"></a>00410                                 }
+<a name="l00411"></a>00411                                 message.append(timevalToString(usage.ru_utime));
+<a name="l00412"></a>00412                                 message.append(<span class="stringliteral">&quot;,&quot;</span>);
+<a name="l00413"></a>00413                                 message.append(timevalToString(usage.ru_stime));
+<a name="l00414"></a>00414                                 message.append(<span class="stringliteral">&quot;)&quot;</span>);
+<a name="l00415"></a>00415                                 log-&gt;message(message);
+<a name="l00416"></a>00416                         }
+<a name="l00417"></a>00417                 } <span class="keywordflow">else</span> {
+<a name="l00418"></a>00418                         <span class="keywordflow">if</span> (ok) {
+<a name="l00419"></a>00419                                 log-&gt;message(data.granular.endMessage);
+<a name="l00420"></a>00420                         } <span class="keywordflow">else</span> {
+<a name="l00421"></a>00421                                 log-&gt;message(data.granular.abortMessage);
+<a name="l00422"></a>00422                         }
+<a name="l00423"></a>00423                 }
+<a name="l00424"></a>00424         }
+<a name="l00425"></a>00425
+<a name="l00426"></a>00426         <span class="keywordtype">void</span> success() {
+<a name="l00427"></a>00427                 ok = <span class="keyword">true</span>;
+<a name="l00428"></a>00428         }
+<a name="l00429"></a>00429 };
+<a name="l00430"></a>00430
+<a name="l00431"></a>00431 <span class="keyword">class </span>AnalyticsLogger {
+<a name="l00432"></a>00432 <span class="keyword">private</span>:<span class="comment"></span>
+<a name="l00433"></a>00433 <span class="comment">        /** A special lock type for AnalyticsLoggerSharedData that also</span>
+<a name="l00434"></a>00434 <span class="comment">         * keeps a smart pointer to the data structure so that the mutex</span>
+<a name="l00435"></a>00435 <span class="comment">         * is not destroyed prematurely.</span>
+<a name="l00436"></a>00436 <span class="comment">         */</span>
+<a name="l00437"></a>00437         <span class="keyword">struct </span>SharedDataLock {
+<a name="l00438"></a>00438                 AnalyticsLoggerSharedDataPtr sharedData;
+<a name="l00439"></a>00439                 <span class="keywordtype">bool</span> locked;
+<a name="l00440"></a>00440
+<a name="l00441"></a>00441                 SharedDataLock(<span class="keyword">const</span> AnalyticsLoggerSharedDataPtr &amp;d)
+<a name="l00442"></a>00442                         : sharedData(d)
+<a name="l00443"></a>00443                 {
+<a name="l00444"></a>00444                         d-&gt;lock.lock();
+<a name="l00445"></a>00445                         locked = <span class="keyword">true</span>;
+<a name="l00446"></a>00446                 }
+<a name="l00447"></a>00447
+<a name="l00448"></a>00448                 ~SharedDataLock() {
+<a name="l00449"></a>00449                         <span class="keywordflow">if</span> (locked) {
+<a name="l00450"></a>00450                                 sharedData-&gt;lock.unlock();
+<a name="l00451"></a>00451                         }
+<a name="l00452"></a>00452                 }
+<a name="l00453"></a>00453
+<a name="l00454"></a>00454                 <span class="keywordtype">void</span> reset(<span class="keyword">const</span> AnalyticsLoggerSharedDataPtr &amp;d, <span class="keywordtype">bool</span> lockNow = <span class="keyword">true</span>) {
+<a name="l00455"></a>00455                         <span class="keywordflow">if</span> (locked) {
+<a name="l00456"></a>00456                                 sharedData-&gt;lock.unlock();
+<a name="l00457"></a>00457                         }
+<a name="l00458"></a>00458                         sharedData = d;
+<a name="l00459"></a>00459                         <span class="keywordflow">if</span> (lockNow) {
+<a name="l00460"></a>00460                                 sharedData-&gt;lock.lock();
+<a name="l00461"></a>00461                                 locked = <span class="keyword">true</span>;
+<a name="l00462"></a>00462                         } <span class="keywordflow">else</span> {
+<a name="l00463"></a>00463                                 locked = <span class="keyword">false</span>;
+<a name="l00464"></a>00464                         }
+<a name="l00465"></a>00465                 }
+<a name="l00466"></a>00466
+<a name="l00467"></a>00467                 <span class="keywordtype">void</span> lock() {
+<a name="l00468"></a>00468                         assert(!locked);
+<a name="l00469"></a>00469                         sharedData-&gt;lock.lock();
+<a name="l00470"></a>00470                         locked = <span class="keyword">true</span>;
+<a name="l00471"></a>00471                 }
+<a name="l00472"></a>00472         };
+<a name="l00473"></a>00473
+<a name="l00474"></a>00474         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> RETRY_SLEEP = 200000; <span class="comment">// microseconds</span>
+<a name="l00475"></a>00475
+<a name="l00476"></a>00476         <span class="keywordtype">string</span> serverAddress;
+<a name="l00477"></a>00477         <span class="keywordtype">string</span> username;
+<a name="l00478"></a>00478         <span class="keywordtype">string</span> password;
+<a name="l00479"></a>00479         <span class="keywordtype">string</span> nodeName;
+<a name="l00480"></a>00480         RandomGenerator randomGenerator;
+<a name="l00481"></a>00481         <span class="comment"></span>
+<a name="l00482"></a>00482 <span class="comment">        /** Lock protecting the fields that follow, but not the contents of the shared data. */</span>
+<a name="l00483"></a>00483         <span class="keyword">mutable</span> boost::mutex lock;
+<a name="l00484"></a>00484
+<a name="l00485"></a>00485         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxConnectTries;
+<a name="l00486"></a>00486         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> reconnectTimeout;
+<a name="l00487"></a>00487         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> nextReconnectTime;<span class="comment"></span>
+<a name="l00488"></a>00488 <span class="comment">        /** @invariant sharedData != NULL */</span>
+<a name="l00489"></a>00489         AnalyticsLoggerSharedDataPtr sharedData;
+<a name="l00490"></a>00490
+<a name="l00491"></a>00491         <span class="keywordtype">bool</span> connected()<span class="keyword"> const </span>{
+<a name="l00492"></a>00492                 <span class="keywordflow">return</span> sharedData-&gt;client.connected();
+<a name="l00493"></a>00493         }
+<a name="l00494"></a>00494
+<a name="l00495"></a>00495         <span class="keywordtype">void</span> connect() {
+<a name="l00496"></a>00496                 TRACE_POINT();
+<a name="l00497"></a>00497                 vector&lt;string&gt; args;
+<a name="l00498"></a>00498
+<a name="l00499"></a>00499                 sharedData-&gt;client.connect(serverAddress, username, password);
+<a name="l00500"></a>00500                 sharedData-&gt;client.write(<span class="stringliteral">&quot;init&quot;</span>, nodeName.c_str(), NULL);
+<a name="l00501"></a>00501                 <span class="keywordflow">if</span> (!sharedData-&gt;client.read(args)) {
+<a name="l00502"></a>00502                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">&quot;Cannot connect to logging server&quot;</span>, ECONNREFUSED);
+<a name="l00503"></a>00503                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1) {
+<a name="l00504"></a>00504                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;Logging server returned an invalid reply for the &#39;init&#39; command&quot;</span>);
+<a name="l00505"></a>00505                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args[0] == <span class="stringliteral">&quot;server shutting down&quot;</span>) {
+<a name="l00506"></a>00506                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">&quot;Cannot connect to server&quot;</span>, ECONNREFUSED);
+<a name="l00507"></a>00507                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args[0] != <span class="stringliteral">&quot;ok&quot;</span>) {
+<a name="l00508"></a>00508                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;Logging server returned an invalid reply for the &#39;init&#39; command&quot;</span>);
+<a name="l00509"></a>00509                 }
+<a name="l00510"></a>00510
+<a name="l00511"></a>00511                 <span class="comment">// Upon a write() error we want to attempt to read() the error</span>
+<a name="l00512"></a>00512                 <span class="comment">// message before closing the socket.</span>
+<a name="l00513"></a>00513                 sharedData-&gt;client.setAutoDisconnect(<span class="keyword">false</span>);
+<a name="l00514"></a>00514         }
+<a name="l00515"></a>00515
+<a name="l00516"></a>00516         <span class="keywordtype">void</span> disconnect(<span class="keywordtype">bool</span> checkErrorResponse = <span class="keyword">false</span>) {
+<a name="l00517"></a>00517                 sharedData-&gt;disconnect(checkErrorResponse);
+<a name="l00518"></a>00518                 <span class="comment">// We create a new SharedData here so that existing AnalyticsLog</span>
+<a name="l00519"></a>00519                 <span class="comment">// objects still refer to the old client object and don&#39;t interfere</span>
+<a name="l00520"></a>00520                 <span class="comment">// with any newly-established connections.</span>
+<a name="l00521"></a>00521                 sharedData.reset(<span class="keyword">new</span> AnalyticsLoggerSharedData());
+<a name="l00522"></a>00522         }
+<a name="l00523"></a>00523
+<a name="l00524"></a>00524         <span class="keywordtype">bool</span> isNetworkError(<span class="keywordtype">int</span> code)<span class="keyword"> const </span>{
+<a name="l00525"></a>00525                 <span class="keywordflow">return</span> code == EPIPE || code == ECONNREFUSED || code == ECONNRESET
+<a name="l00526"></a>00526                         || code == EHOSTUNREACH || code == ENETDOWN || code == ENETUNREACH
+<a name="l00527"></a>00527                         || code == ETIMEDOUT;
+<a name="l00528"></a>00528         }
+<a name="l00529"></a>00529
+<a name="l00530"></a>00530 <span class="keyword">public</span>:
+<a name="l00531"></a>00531         AnalyticsLogger() { }
+<a name="l00532"></a>00532
+<a name="l00533"></a>00533         AnalyticsLogger(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;serverAddress, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;username,
+<a name="l00534"></a>00534                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;password, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;nodeName = <span class="stringliteral">&quot;&quot;</span>)
+<a name="l00535"></a>00535         {
+<a name="l00536"></a>00536                 this-&gt;serverAddress  = serverAddress;
+<a name="l00537"></a>00537                 this-&gt;username       = username;
+<a name="l00538"></a>00538                 this-&gt;password       = password;
+<a name="l00539"></a>00539                 <span class="keywordflow">if</span> (nodeName.empty()) {
+<a name="l00540"></a>00540                         this-&gt;nodeName = <a class="code" href="namespacePassenger.html#a1d0a66b0e207c46dc6124ff3b2f331e6" title="Returns the system&amp;#39;s host name.">getHostName</a>();
+<a name="l00541"></a>00541                 } <span class="keywordflow">else</span> {
+<a name="l00542"></a>00542                         this-&gt;nodeName = nodeName;
+<a name="l00543"></a>00543                 }
+<a name="l00544"></a>00544                 <span class="keywordflow">if</span> (!serverAddress.empty()) {
+<a name="l00545"></a>00545                         sharedData.reset(<span class="keyword">new</span> AnalyticsLoggerSharedData());
+<a name="l00546"></a>00546                 }
+<a name="l00547"></a>00547                 <span class="keywordflow">if</span> (isLocalSocketAddress(serverAddress)) {
+<a name="l00548"></a>00548                         maxConnectTries = 10;
+<a name="l00549"></a>00549                 } <span class="keywordflow">else</span> {
+<a name="l00550"></a>00550                         maxConnectTries = 1;
+<a name="l00551"></a>00551                 }
+<a name="l00552"></a>00552                 maxConnectTries   = 10;
+<a name="l00553"></a>00553                 reconnectTimeout  = 60 * 1000000;
+<a name="l00554"></a>00554                 nextReconnectTime = 0;
+<a name="l00555"></a>00555         }
+<a name="l00556"></a>00556
+<a name="l00557"></a>00557         AnalyticsLogPtr newTransaction(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;groupName, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;category = <span class="stringliteral">&quot;requests&quot;</span>,
+<a name="l00558"></a>00558                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;unionStationKey = <span class="keywordtype">string</span>(),
+<a name="l00559"></a>00559                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;filters = <span class="keywordtype">string</span>())
+<a name="l00560"></a>00560         {
+<a name="l00561"></a>00561                 <span class="keywordflow">if</span> (serverAddress.empty()) {
+<a name="l00562"></a>00562                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog());
+<a name="l00563"></a>00563                 }
+<a name="l00564"></a>00564
+<a name="l00565"></a>00565                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timestamp = SystemTime::getUsec();
+<a name="l00566"></a>00566                 <span class="keywordtype">char</span> txnId[
+<a name="l00567"></a>00567                         2 * <span class="keyword">sizeof</span>(<span class="keywordtype">unsigned</span> int) +    <span class="comment">// max hex timestamp size</span>
+<a name="l00568"></a>00568                         11 +                          <span class="comment">// space for a random identifier</span>
+<a name="l00569"></a>00569                         1                             <span class="comment">// null terminator</span>
+<a name="l00570"></a>00570                 ];
+<a name="l00571"></a>00571                 <span class="keywordtype">char</span> *end;
+<a name="l00572"></a>00572                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timestampSize;
+<a name="l00573"></a>00573                 <span class="keywordtype">char</span> timestampStr[2 * <span class="keyword">sizeof</span>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) + 1];
+<a name="l00574"></a>00574
+<a name="l00575"></a>00575                 <span class="comment">// &quot;[timestamp]&quot;</span>
+<a name="l00576"></a>00576                 <span class="comment">// Our timestamp is like a Unix timestamp but with minutes</span>
+<a name="l00577"></a>00577                 <span class="comment">// resolution instead of seconds. 32 bits will last us for</span>
+<a name="l00578"></a>00578                 <span class="comment">// about 8000 years.</span>
+<a name="l00579"></a>00579                 timestampSize = integerToHexatri&lt;unsigned int&gt;(timestamp / 1000000 / 60,
+<a name="l00580"></a>00580                         txnId);
+<a name="l00581"></a>00581                 end = txnId + timestampSize;
+<a name="l00582"></a>00582
+<a name="l00583"></a>00583                 <span class="comment">// &quot;[timestamp]-&quot;</span>
+<a name="l00584"></a>00584                 *end = <span class="charliteral">&#39;-&#39;</span>;
+<a name="l00585"></a>00585                 end++;
+<a name="l00586"></a>00586
+<a name="l00587"></a>00587                 <span class="comment">// &quot;[timestamp]-[random id]&quot;</span>
+<a name="l00588"></a>00588                 randomGenerator.generateAsciiString(end, 11);
+<a name="l00589"></a>00589                 end += 11;
+<a name="l00590"></a>00590                 *end = <span class="charliteral">&#39;\0&#39;</span>;
+<a name="l00591"></a>00591
+<a name="l00592"></a>00592                 integerToHexatri&lt;unsigned long long&gt;(timestamp, timestampStr);
+<a name="l00593"></a>00593
+<a name="l00594"></a>00594                 unique_lock&lt;boost::mutex&gt; l(lock);
+<a name="l00595"></a>00595                 SharedDataLock sl(sharedData);
+<a name="l00596"></a>00596
+<a name="l00597"></a>00597                 <span class="keywordflow">if</span> (SystemTime::getUsec() &gt;= nextReconnectTime) {
+<a name="l00598"></a>00598                         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> tryCount = 0;
+<a name="l00599"></a>00599
+<a name="l00600"></a>00600                         <span class="keywordflow">while</span> (tryCount &lt; maxConnectTries) {
+<a name="l00601"></a>00601                                 <span class="keywordflow">try</span> {
+<a name="l00602"></a>00602                                         <span class="keywordflow">if</span> (!connected()) {
+<a name="l00603"></a>00603                                                 TRACE_POINT();
+<a name="l00604"></a>00604                                                 connect();
+<a name="l00605"></a>00605                                         }
+<a name="l00606"></a>00606                                         sharedData-&gt;client.write(<span class="stringliteral">&quot;openTransaction&quot;</span>,
+<a name="l00607"></a>00607                                                 txnId,
+<a name="l00608"></a>00608                                                 groupName.c_str(),
+<a name="l00609"></a>00609                                                 <span class="stringliteral">&quot;&quot;</span>,
+<a name="l00610"></a>00610                                                 category.c_str(),
+<a name="l00611"></a>00611                                                 timestampStr,
+<a name="l00612"></a>00612                                                 unionStationKey.c_str(),
+<a name="l00613"></a>00613                                                 <span class="stringliteral">&quot;true&quot;</span>,
+<a name="l00614"></a>00614                                                 <span class="stringliteral">&quot;true&quot;</span>,
+<a name="l00615"></a>00615                                                 filters.c_str(),
+<a name="l00616"></a>00616                                                 NULL);
+<a name="l00617"></a>00617
+<a name="l00618"></a>00618                                         vector&lt;string&gt; args;
+<a name="l00619"></a>00619                                         sharedData-&gt;client.read(args);
+<a name="l00620"></a>00620                                         <span class="keywordflow">if</span> (args.size() == 2 &amp;&amp; args[0] == <span class="stringliteral">&quot;error&quot;</span>) {
+<a name="l00621"></a>00621                                                 disconnect();
+<a name="l00622"></a>00622                                                 <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The logging server responded with an error: &quot;</span> + args[1]);
+<a name="l00623"></a>00623                                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.empty() || args[0] != <span class="stringliteral">&quot;ok&quot;</span>) {
+<a name="l00624"></a>00624                                                 disconnect();
+<a name="l00625"></a>00625                                                 <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The logging server sent an unexpected reply.&quot;</span>);
+<a name="l00626"></a>00626                                         }
+<a name="l00627"></a>00627
+<a name="l00628"></a>00628                                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog(sharedData,
+<a name="l00629"></a>00629                                                 <span class="keywordtype">string</span>(txnId, end - txnId),
+<a name="l00630"></a>00630                                                 groupName, category,
+<a name="l00631"></a>00631                                                 unionStationKey));
+<a name="l00632"></a>00632                                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;e) {
+<a name="l00633"></a>00633                                         TRACE_POINT();
+<a name="l00634"></a>00634                                         <span class="keywordflow">if</span> (e.code() == ENOENT || isNetworkError(e.code())) {
+<a name="l00635"></a>00635                                                 tryCount++;
+<a name="l00636"></a>00636                                                 disconnect(<span class="keyword">true</span>);
+<a name="l00637"></a>00637                                                 sl.reset(sharedData, <span class="keyword">false</span>);
+<a name="l00638"></a>00638                                                 l.unlock();
+<a name="l00639"></a>00639                                                 <span class="keywordflow">if</span> (tryCount &lt; maxConnectTries) {
+<a name="l00640"></a>00640                                                         syscalls::usleep(RETRY_SLEEP);
+<a name="l00641"></a>00641                                                 }
+<a name="l00642"></a>00642                                                 l.lock();
+<a name="l00643"></a>00643                                                 sl.lock();
+<a name="l00644"></a>00644                                         } <span class="keywordflow">else</span> {
+<a name="l00645"></a>00645                                                 disconnect();
+<a name="l00646"></a>00646                                                 <span class="keywordflow">throw</span>;
+<a name="l00647"></a>00647                                         }
+<a name="l00648"></a>00648                                 }
+<a name="l00649"></a>00649
+<a name="l00650"></a>00650                                 <span class="comment">// Failed to connect.</span>
+<a name="l00651"></a>00651                                 P_WARN(<span class="stringliteral">&quot;Cannot connect to the logging agent (&quot;</span> &lt;&lt; serverAddress &lt;&lt; <span class="stringliteral">&quot;); &quot;</span> &lt;&lt;
+<a name="l00652"></a>00652                                         <span class="stringliteral">&quot;retrying in &quot;</span> &lt;&lt; reconnectTimeout / 1000000 &lt;&lt; <span class="stringliteral">&quot; seconds.&quot;</span>);
+<a name="l00653"></a>00653                                 nextReconnectTime = SystemTime::getUsec() + reconnectTimeout;
+<a name="l00654"></a>00654                         }
+<a name="l00655"></a>00655                 }
+<a name="l00656"></a>00656                 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog());
+<a name="l00657"></a>00657         }
+<a name="l00658"></a>00658
+<a name="l00659"></a>00659         AnalyticsLogPtr continueTransaction(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;txnId, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;groupName,
+<a name="l00660"></a>00660                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;category = <span class="stringliteral">&quot;requests&quot;</span>, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;unionStationKey = <span class="keywordtype">string</span>())
+<a name="l00661"></a>00661         {
+<a name="l00662"></a>00662                 <span class="keywordflow">if</span> (serverAddress.empty() || txnId.empty()) {
+<a name="l00663"></a>00663                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog());
+<a name="l00664"></a>00664                 }
+<a name="l00665"></a>00665
+<a name="l00666"></a>00666                 <span class="keywordtype">char</span> timestampStr[2 * <span class="keyword">sizeof</span>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) + 1];
+<a name="l00667"></a>00667                 integerToHexatri&lt;unsigned long long&gt;(SystemTime::getUsec(), timestampStr);
+<a name="l00668"></a>00668
+<a name="l00669"></a>00669                 unique_lock&lt;boost::mutex&gt; l(lock);
+<a name="l00670"></a>00670                 SharedDataLock sl(sharedData);
+<a name="l00671"></a>00671
+<a name="l00672"></a>00672                 <span class="keywordflow">if</span> (SystemTime::getUsec() &gt;= nextReconnectTime) {
+<a name="l00673"></a>00673                         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> tryCount = 0;
+<a name="l00674"></a>00674
+<a name="l00675"></a>00675                         <span class="keywordflow">while</span> (tryCount &lt; maxConnectTries) {
+<a name="l00676"></a>00676                                 <span class="keywordflow">try</span> {
+<a name="l00677"></a>00677                                         <span class="keywordflow">if</span> (!connected()) {
+<a name="l00678"></a>00678                                                 TRACE_POINT();
+<a name="l00679"></a>00679                                                 connect();
+<a name="l00680"></a>00680                                         }
+<a name="l00681"></a>00681                                         sharedData-&gt;client.write(<span class="stringliteral">&quot;openTransaction&quot;</span>,
+<a name="l00682"></a>00682                                                 txnId.c_str(),
+<a name="l00683"></a>00683                                                 groupName.c_str(),
+<a name="l00684"></a>00684                                                 <span class="stringliteral">&quot;&quot;</span>,
+<a name="l00685"></a>00685                                                 category.c_str(),
+<a name="l00686"></a>00686                                                 timestampStr,
+<a name="l00687"></a>00687                                                 unionStationKey.c_str(),
+<a name="l00688"></a>00688                                                 <span class="stringliteral">&quot;true&quot;</span>,
+<a name="l00689"></a>00689                                                 NULL);
+<a name="l00690"></a>00690                                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog(sharedData,
+<a name="l00691"></a>00691                                                 txnId, groupName, category,
+<a name="l00692"></a>00692                                                 unionStationKey));
+<a name="l00693"></a>00693                                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;e) {
+<a name="l00694"></a>00694                                         TRACE_POINT();
+<a name="l00695"></a>00695                                         <span class="keywordflow">if</span> (e.code() == EPIPE || isNetworkError(e.code())) {
+<a name="l00696"></a>00696                                                 tryCount++;
+<a name="l00697"></a>00697                                                 disconnect(<span class="keyword">true</span>);
+<a name="l00698"></a>00698                                                 sl.reset(sharedData, <span class="keyword">false</span>);
+<a name="l00699"></a>00699                                                 l.unlock();
+<a name="l00700"></a>00700                                                 <span class="keywordflow">if</span> (tryCount &lt; maxConnectTries) {
+<a name="l00701"></a>00701                                                         syscalls::usleep(RETRY_SLEEP);
+<a name="l00702"></a>00702                                                 }
+<a name="l00703"></a>00703                                                 l.lock();
+<a name="l00704"></a>00704                                                 sl.lock();
+<a name="l00705"></a>00705                                         } <span class="keywordflow">else</span> {
+<a name="l00706"></a>00706                                                 disconnect();
+<a name="l00707"></a>00707                                                 <span class="keywordflow">throw</span>;
+<a name="l00708"></a>00708                                         }
+<a name="l00709"></a>00709                                 }
+<a name="l00710"></a>00710                         }
+<a name="l00711"></a>00711
+<a name="l00712"></a>00712                         <span class="comment">// Failed to connect.</span>
+<a name="l00713"></a>00713                         P_WARN(<span class="stringliteral">&quot;Cannot connect to the logging agent (&quot;</span> &lt;&lt; serverAddress &lt;&lt; <span class="stringliteral">&quot;); &quot;</span> &lt;&lt;
+<a name="l00714"></a>00714                                 <span class="stringliteral">&quot;retrying in &quot;</span> &lt;&lt; reconnectTimeout / 1000000 &lt;&lt; <span class="stringliteral">&quot; seconds.&quot;</span>);
+<a name="l00715"></a>00715                         nextReconnectTime = SystemTime::getUsec() + reconnectTimeout;
+<a name="l00716"></a>00716                 }
+<a name="l00717"></a>00717                 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#ga41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog());
+<a name="l00718"></a>00718         }
+<a name="l00719"></a>00719
+<a name="l00720"></a>00720         <span class="keywordtype">void</span> setMaxConnectTries(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> value) {
+<a name="l00721"></a>00721                 lock_guard&lt;boost::mutex&gt; l(lock);
+<a name="l00722"></a>00722                 maxConnectTries = value;
+<a name="l00723"></a>00723         }
+<a name="l00724"></a>00724
+<a name="l00725"></a>00725         <span class="keywordtype">void</span> setReconnectTimeout(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> usec) {
+<a name="l00726"></a>00726                 lock_guard&lt;boost::mutex&gt; l(lock);
+<a name="l00727"></a>00727                 reconnectTimeout = usec;
+<a name="l00728"></a>00728         }
+<a name="l00729"></a>00729
+<a name="l00730"></a>00730         <span class="keywordtype">bool</span> isNull()<span class="keyword"> const </span>{
+<a name="l00731"></a>00731                 <span class="keywordflow">return</span> serverAddress.empty();
+<a name="l00732"></a>00732         }
+<a name="l00733"></a>00733
+<a name="l00734"></a>00734         <span class="keywordtype">string</span> getAddress()<span class="keyword"> const </span>{
+<a name="l00735"></a>00735                 <span class="keywordflow">return</span> serverAddress;
+<a name="l00736"></a>00736         }
+<a name="l00737"></a>00737
+<a name="l00738"></a>00738         <span class="keywordtype">string</span> getUsername()<span class="keyword"> const </span>{
+<a name="l00739"></a>00739                 <span class="keywordflow">return</span> username;
+<a name="l00740"></a>00740         }
+<a name="l00741"></a>00741
+<a name="l00742"></a>00742         <span class="keywordtype">string</span> getPassword()<span class="keyword"> const </span>{
+<a name="l00743"></a>00743                 <span class="keywordflow">return</span> password;
+<a name="l00744"></a>00744         }
+<a name="l00745"></a>00745
+<a name="l00746"></a>00746         FileDescriptor getConnection()<span class="keyword"> const </span>{
+<a name="l00747"></a>00747                 lock_guard&lt;boost::mutex&gt; l(lock);
+<a name="l00748"></a>00748                 lock_guard&lt;boost::mutex&gt; l2(sharedData-&gt;lock);
+<a name="l00749"></a>00749                 <span class="keywordflow">return</span> sharedData-&gt;client.getConnection();
+<a name="l00750"></a>00750         }
+<a name="l00751"></a>00751         <span class="comment"></span>
+<a name="l00752"></a>00752 <span class="comment">        /**</span>
+<a name="l00753"></a>00753 <span class="comment">         * @post !result.empty()</span>
+<a name="l00754"></a>00754 <span class="comment">         */</span>
+<a name="l00755"></a>00755         <span class="keywordtype">string</span> getNodeName()<span class="keyword"> const </span>{
+<a name="l00756"></a>00756                 <span class="keywordflow">return</span> nodeName;
+<a name="l00757"></a>00757         }
+<a name="l00758"></a>00758 };
+<a name="l00759"></a>00759
+<a name="l00760"></a>00760 <span class="keyword">typedef</span> shared_ptr&lt;AnalyticsLogger&gt; AnalyticsLoggerPtr;
+<a name="l00761"></a>00761
+<a name="l00762"></a>00762 } <span class="comment">// namespace Passenger</span>
+<a name="l00763"></a>00763
+<a name="l00764"></a>00764 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_LOGGING_H_ */</span>
+<a name="l00765"></a>00765
+</pre></div></div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>