File: log.html

package info (click to toggle)
groonga 11.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 121,576 kB
  • sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (335 lines) | stat: -rw-r--r-- 13,371 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.23. Log &#8212; Groonga v10.1.1-31-g1e46ba6 documentation</title>
    <link rel="stylesheet" href="../_static/groonga.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/language_data.js"></script>
    
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="7.24. Tuning" href="tuning.html" />
    <link rel="prev" title="7.22. Sharding" href="sharding.html" /> 
  </head><body>
<div class="header">
  <h1 class="title">
    <a id="top-link" href="../index.html">
      <span class="project">groonga</span>
      <span class="separator">-</span>
      <span class="description">An open-source fulltext search engine and column store.</span>
    </a>
  </h1>

  <div class="other-language-links">
    <ul>
      <li><a href="../../../ja/html/reference/log.html">日本語</a></li>
    </ul>
  </div>
</div>
  

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="tuning.html" title="7.24. Tuning"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="sharding.html" title="7.22. Sharding"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../reference.html" accesskey="U"><span class="section-number">7. </span>Reference manual</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.23. </span>Log</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="log">
<h1><span class="section-number">7.23. </span>Log<a class="headerlink" href="#log" title="Permalink to this headline">¶</a></h1>
<p>Groonga has two log files. They are process log and query
log. Process log is for all of <a class="reference internal" href="executables/groonga.html"><span class="doc">groonga executable file</span></a>
works. Query log is just for query processing.</p>
<div class="section" id="process-log">
<span id="id1"></span><h2><span class="section-number">7.23.1. </span>Process log<a class="headerlink" href="#process-log" title="Permalink to this headline">¶</a></h2>
<p>Process log is enabled by default. Log path can be customized by
<a class="reference internal" href="executables/groonga.html#cmdoption-groonga-log-path"><code class="xref std std-option docutils literal notranslate"><span class="pre">groonga</span> <span class="pre">--log-path</span></code></a> option. Each log has its log level. If a
log is smaller than Groonga process’ log level, it’s not logged. Log
level can be customized by <a class="reference internal" href="executables/groonga.html#cmdoption-groonga-l"><code class="xref std std-option docutils literal notranslate"><span class="pre">groonga</span> <span class="pre">-l</span></code></a> or
<a class="reference internal" href="commands/log_level.html"><span class="doc">log_level</span></a>.</p>
<div class="section" id="format">
<h3><span class="section-number">7.23.1.1. </span>Format<a class="headerlink" href="#format" title="Permalink to this headline">¶</a></h3>
<p>Process log uses the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>#{TIME_STAMP}|#{L}| #{MESSAGE}
</pre></div>
</div>
<p>Some multi-process based applications such as
<a class="reference internal" href="executables/groonga-httpd.html"><span class="doc">groonga-httpd</span></a> and <a class="reference external" href="https://pgroonga.github.io/">PGroonga</a> use the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>#{TIME_STAMP}|#{L}|#{PID}: #{MESSAGE}
</pre></div>
</div>
<dl>
<dt>TIME_STAMP</dt><dd><p>It’s time stamp uses the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>YYYY-MM-DD hh:mm:ss.SSSSSS
</pre></div>
</div>
<dl class="simple">
<dt>YYYY</dt><dd><p>Year with four digits.</p>
</dd>
<dt>MM</dt><dd><p>Month with two digits.</p>
</dd>
<dt>DD</dt><dd><p>Day with two digits.</p>
</dd>
<dt>hh</dt><dd><p>Hour with two digits.</p>
</dd>
<dt>mm</dt><dd><p>Minute with two digits.</p>
</dd>
<dt>ss</dt><dd><p>Second with two digits.</p>
</dd>
<dt>SSSSSS</dt><dd><p>Microsecond with six digits.</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>2011-07-05 06:25:18.345734
</pre></div>
</div>
</dd>
<dt>L</dt><dd><p>Log level with a character. Here is a character and log
level map.</p>
<dl class="simple">
<dt>E</dt><dd><p>Emergency</p>
</dd>
<dt>A</dt><dd><p>Alert</p>
</dd>
<dt>C</dt><dd><p>Critical</p>
</dd>
<dt>e</dt><dd><p>Error</p>
</dd>
<dt>w</dt><dd><p>Warning</p>
</dd>
<dt>n</dt><dd><p>Notification</p>
</dd>
<dt>i</dt><dd><p>Information</p>
</dd>
<dt>d</dt><dd><p>Debug</p>
</dd>
<dt>-</dt><dd><p>Dump</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>E
</pre></div>
</div>
</dd>
<dt>PID</dt><dd><p>The process ID.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>1129
</pre></div>
</div>
</dd>
<dt>MESSAGE</dt><dd><p>Details about the log with free format.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>log opened.
</pre></div>
</div>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>2011-07-05 08:35:09.276421|n| grn_init
2011-07-05 08:35:09.276553|n| RLIMIT_NOFILE(4096,4096)
</pre></div>
</div>
<p>Example with PID:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>2011-07-05 08:35:09.276421|n|1129: grn_init
2011-07-05 08:35:09.276553|n|1129: RLIMIT_NOFILE(4096,4096)
</pre></div>
</div>
</div>
</div>
<div class="section" id="query-log">
<span id="id2"></span><h2><span class="section-number">7.23.2. </span>Query log<a class="headerlink" href="#query-log" title="Permalink to this headline">¶</a></h2>
<p>Query log is disabled by default. It can be enabled by
<a class="reference internal" href="executables/groonga.html#cmdoption-groonga-query-log-path"><code class="xref std std-option docutils literal notranslate"><span class="pre">groonga</span> <span class="pre">--query-log-path</span></code></a> option.</p>
<div class="section" id="id3">
<h3><span class="section-number">7.23.2.1. </span>Format<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>Query log uses the following formats:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>#{TIME_STAMP}|#{MESSAGE}
#{TIME_STAMP}|#{ID}|&gt;#{QUERY}
#{TIME_STAMP}|#{ID}|:#{ELAPSED_TIME} #{PROGRESS}
#{TIME_STAMP}|#{ID}|&lt;#{ELAPSED_TIME} #{RETURN_CODE}
</pre></div>
</div>
<dl>
<dt>TIME_STAMP</dt><dd><p>It’s time stamp uses the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>YYYY-MM-DD hh:mm:ss.SSSSSS
</pre></div>
</div>
<dl class="simple">
<dt>YYYY</dt><dd><p>Year with four digits.</p>
</dd>
<dt>MM</dt><dd><p>Month with two digits.</p>
</dd>
<dt>DD</dt><dd><p>Day with two digits.</p>
</dd>
<dt>hh</dt><dd><p>Hour with two digits.</p>
</dd>
<dt>mm</dt><dd><p>Minute with two digits.</p>
</dd>
<dt>ss</dt><dd><p>Second with two digits.</p>
</dd>
<dt>SSSSSS</dt><dd><p>Microsecond with six digits.</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>2011-07-05 06:25:18.345734
</pre></div>
</div>
</dd>
<dt>ID</dt><dd><p>ID of a thread. Groonga process creates threads to process
requests concurrently. Each thread outputs some logs for a
request. This ID can be used to extract a log sequence by
a thread.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>45ea3034
</pre></div>
</div>
</dd>
</dl>
<dl class="simple">
<dt>&gt;</dt><dd><p>A character that indicates query is started.</p>
</dd>
</dl>
<dl class="simple">
<dt>:</dt><dd><p>A character that indicates query is processing.</p>
</dd>
</dl>
<dl>
<dt>&lt;</dt><dd><p>A character that indicates query is finished.</p>
</dd>
<dt>MESSAGE</dt><dd><p>Details about the log with free format.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>query log opened.
</pre></div>
</div>
</dd>
<dt>QUERY</dt><dd><p>A query to be processed.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select users --match_columns hobby --query music
</pre></div>
</div>
</dd>
<dt>ELAPSED_TIME</dt><dd><p>Elapsed time in nanoseconds since query is started.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>000000000075770
(It means 75,770 nanoseconds.)
</pre></div>
</div>
</dd>
<dt>PROGRESS</dt><dd><p>A processed work at the time.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select(313401)
(It means that &#39;select&#39; is processed and 313,401 records are remained.)
</pre></div>
</div>
</dd>
<dt>RETURN_CODE</dt><dd><p>A return code for the query.</p>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>rc=0
(It means return code is 0. 0 means GRN_SUCCESS.)
</pre></div>
</div>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>2011-07-05 06:25:19.458756|45ea3034|&gt;select Properties --limit 0
2011-07-05 06:25:19.458829|45ea3034|:000000000072779 select(19)
2011-07-05 06:25:19.458856|45ea3034|:000000000099998 output(0)
2011-07-05 06:25:19.458875|45ea3034|&lt;000000000119062 rc=0
2011-07-05 06:25:19.458986|45ea3034|&gt;quit
</pre></div>
</div>
</div>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">7.23. Log</a><ul>
<li><a class="reference internal" href="#process-log">7.23.1. Process log</a><ul>
<li><a class="reference internal" href="#format">7.23.1.1. Format</a></li>
</ul>
</li>
<li><a class="reference internal" href="#query-log">7.23.2. Query log</a><ul>
<li><a class="reference internal" href="#id3">7.23.2.1. Format</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="sharding.html"
                        title="previous chapter"><span class="section-number">7.22. </span>Sharding</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="tuning.html"
                        title="next chapter"><span class="section-number">7.24. </span>Tuning</a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="tuning.html" title="7.24. Tuning"
             >next</a> |</li>
        <li class="right" >
          <a href="sharding.html" title="7.22. Sharding"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.23. </span>Log</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>