~ubuntu-branches/debian/sid/varnish/sid

« back to all changes in this revision

Viewing changes to doc/sphinx/=build/html/reference/varnishlog.html

  • Committer: Package Import Robot
  • Author(s): Stig Sandbeck Mathisen
  • Date: 2011-10-29 15:23:24 UTC
  • mfrom: (0.1.15)
  • Revision ID: package-import@ubuntu.com-20111029152324-tdtlsurrv22ysknj
Tags: 3.0.2-1
* New upstream release
* Build from upstream tarball instead of git tag
* debian/watch: more specific regular expression

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
 
 
3
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
4
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
5
 
 
6
<html xmlns="http://www.w3.org/1999/xhtml">
 
7
  <head>
 
8
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
9
    
 
10
    <title>varnishlog &mdash; Varnish version 3.0.2 documentation</title>
 
11
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
 
12
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
13
    <script type="text/javascript">
 
14
      var DOCUMENTATION_OPTIONS = {
 
15
        URL_ROOT:    '../',
 
16
        VERSION:     '3.0.2',
 
17
        COLLAPSE_INDEX: false,
 
18
        FILE_SUFFIX: '.html',
 
19
        HAS_SOURCE:  true
 
20
      };
 
21
    </script>
 
22
    <script type="text/javascript" src="../_static/jquery.js"></script>
 
23
    <script type="text/javascript" src="../_static/underscore.js"></script>
 
24
    <script type="text/javascript" src="../_static/doctools.js"></script>
 
25
    <link rel="top" title="Varnish version 3.0.2 documentation" href="../index.html" />
 
26
    <link rel="up" title="The Varnish Reference Manual" href="index.html" />
 
27
    <link rel="next" title="varnishncsa" href="varnishncsa.html" />
 
28
    <link rel="prev" title="varnishhist" href="varnishhist.html" /> 
 
29
  </head>
 
30
  <body>
 
31
    <div class="related">
 
32
      <h3>Navigation</h3>
 
33
      <ul>
 
34
        <li class="right" style="margin-right: 10px">
 
35
          <a href="../genindex.html" title="General Index"
 
36
             accesskey="I">index</a></li>
 
37
        <li class="right" >
 
38
          <a href="varnishncsa.html" title="varnishncsa"
 
39
             accesskey="N">next</a> |</li>
 
40
        <li class="right" >
 
41
          <a href="varnishhist.html" title="varnishhist"
 
42
             accesskey="P">previous</a> |</li>
 
43
        <li><a href="../index.html">Varnish version 3.0.2 documentation</a> &raquo;</li>
 
44
          <li><a href="index.html" accesskey="U">The Varnish Reference Manual</a> &raquo;</li> 
 
45
      </ul>
 
46
    </div>  
 
47
 
 
48
    <div class="document">
 
49
      <div class="documentwrapper">
 
50
        <div class="bodywrapper">
 
51
          <div class="body">
 
52
            
 
53
  <div class="section" id="varnishlog">
 
54
<h1>varnishlog<a class="headerlink" href="#varnishlog" title="Permalink to this headline">¶</a></h1>
 
55
<div class="section" id="display-varnish-logs">
 
56
<h2>Display Varnish logs<a class="headerlink" href="#display-varnish-logs" title="Permalink to this headline">¶</a></h2>
 
57
<table class="docutils field-list" frame="void" rules="none">
 
58
<col class="field-name" />
 
59
<col class="field-body" />
 
60
<tbody valign="top">
 
61
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Dag-Erling Smørgrav</td>
 
62
</tr>
 
63
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Per Buer</td>
 
64
</tr>
 
65
<tr class="field"><th class="field-name">Date:</th><td class="field-body">2010-05-31</td>
 
66
</tr>
 
67
<tr class="field"><th class="field-name">Version:</th><td class="field-body">0.2</td>
 
68
</tr>
 
69
<tr class="field"><th class="field-name">Manual section:</th><td class="field-body">1</td>
 
70
</tr>
 
71
</tbody>
 
72
</table>
 
73
<div class="section" id="synopsis">
 
74
<h3>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h3>
 
75
<p>varnishlog [-a] [-b] [-C] [-c] [-D] [-d] [-I regex] [-i tag] [-k keep]
 
76
[-n varnish_name] [-o] [-O] [-m <a class="reference external" href="tag:regex">tag:regex</a> ...] [-P file] [-r file] [-s num] [-u] [-V]
 
77
[-w file] [-X regex] [-x tag]</p>
 
78
</div>
 
79
<div class="section" id="description">
 
80
<h3>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h3>
 
81
<p>The varnishlog utility reads and presents varnishd(1) shared memory logs.</p>
 
82
<p>The following options are available:</p>
 
83
<table class="docutils option-list" frame="void" rules="none">
 
84
<col class="option" />
 
85
<col class="description" />
 
86
<tbody valign="top">
 
87
<tr><td class="option-group">
 
88
<kbd><span class="option">-a</span></kbd></td>
 
89
<td>When writing to a file, append to it rather than overwrite it.</td></tr>
 
90
<tr><td class="option-group">
 
91
<kbd><span class="option">-b</span></kbd></td>
 
92
<td>Include log entries which result from communication with a backend server.
 
93
If neither -b nor -c is specified, varnishlog acts as if they both were.</td></tr>
 
94
<tr><td class="option-group">
 
95
<kbd><span class="option">-C</span></kbd></td>
 
96
<td>Ignore case when matching regular expressions.</td></tr>
 
97
<tr><td class="option-group">
 
98
<kbd><span class="option">-c</span></kbd></td>
 
99
<td>Include log entries which result from communication with a client.
 
100
If neither -b nor -c is specified, varnishlog acts as if they both were.</td></tr>
 
101
<tr><td class="option-group">
 
102
<kbd><span class="option">-D</span></kbd></td>
 
103
<td>Daemonize.</td></tr>
 
104
<tr><td class="option-group">
 
105
<kbd><span class="option">-d</span></kbd></td>
 
106
<td>Process old log entries on startup.  Normally, varnishlog will only process entries
 
107
which are written to the log after it starts.</td></tr>
 
108
<tr><td class="option-group">
 
109
<kbd><span class="option">-I <var>regex</var></span></kbd></td>
 
110
<td>Include log entries which match the specified regular expression.  If
 
111
neither -I nor -i is specified, all log entries are included.</td></tr>
 
112
<tr><td class="option-group">
 
113
<kbd><span class="option">-i <var>tag</var></span></kbd></td>
 
114
<td>Include log entries with the specified tag.  If neither -I nor -i is specified,
 
115
all log entries are included.</td></tr>
 
116
<tr><td class="option-group">
 
117
<kbd><span class="option">-k <var>num</var></span></kbd></td>
 
118
<td>Only show the first num log records.</td></tr>
 
119
</tbody>
 
120
</table>
 
121
<dl class="docutils">
 
122
<dt>-m <a class="reference external" href="tag:regex">tag:regex</a> only list transactions where tag matches regex. Multiple</dt>
 
123
<dd>-m options are AND-ed together.  Can not be combined with -O</dd>
 
124
</dl>
 
125
<table class="docutils option-list" frame="void" rules="none">
 
126
<col class="option" />
 
127
<col class="description" />
 
128
<tbody valign="top">
 
129
<tr><td class="option-group">
 
130
<kbd><span class="option">-n</span></kbd></td>
 
131
<td>Specifies the name of the varnishd instance to get logs from.  If -n is not
 
132
specified, the host name is used.</td></tr>
 
133
<tr><td class="option-group">
 
134
<kbd><span class="option">-o</span></kbd></td>
 
135
<td>Ignored for compatibility with earlier versions.</td></tr>
 
136
<tr><td class="option-group">
 
137
<kbd><span class="option">-O</span></kbd></td>
 
138
<td>Do not group log entries by request ID.  Can not be
 
139
combined with -m.</td></tr>
 
140
<tr><td class="option-group">
 
141
<kbd><span class="option">-P <var>file</var></span></kbd></td>
 
142
<td>Write the process's PID to the specified file.</td></tr>
 
143
<tr><td class="option-group">
 
144
<kbd><span class="option">-r <var>file</var></span></kbd></td>
 
145
<td>Read log entries from file instead of shared memory.</td></tr>
 
146
<tr><td class="option-group">
 
147
<kbd><span class="option">-s <var>num</var></span></kbd></td>
 
148
<td>Skip the first num log records.</td></tr>
 
149
<tr><td class="option-group">
 
150
<kbd><span class="option">-u</span></kbd></td>
 
151
<td>Unbuffered output.</td></tr>
 
152
<tr><td class="option-group">
 
153
<kbd><span class="option">-V</span></kbd></td>
 
154
<td>Display the version number and exit.</td></tr>
 
155
<tr><td class="option-group">
 
156
<kbd><span class="option">-w <var>file</var></span></kbd></td>
 
157
<td>Write log entries to file instead of displaying them.  The file
 
158
will be overwritten unless the -a option was specified. If
 
159
varnishlog receives a SIGHUP while writing to a file, it will
 
160
reopen the file, allowing the old one to be rotated away.</td></tr>
 
161
<tr><td class="option-group">
 
162
<kbd><span class="option">-X <var>regex</var></span></kbd></td>
 
163
<td>Exclude log entries which match the specified regular expression.</td></tr>
 
164
<tr><td class="option-group">
 
165
<kbd><span class="option">-x <var>tag</var></span></kbd></td>
 
166
<td>Exclude log entries with the specified tag.</td></tr>
 
167
</tbody>
 
168
</table>
 
169
</div>
 
170
<div class="section" id="tags">
 
171
<h3>TAGS<a class="headerlink" href="#tags" title="Permalink to this headline">¶</a></h3>
 
172
<p>The following log entry tags are currently defined:</p>
 
173
<ul class="simple">
 
174
<li>Backend</li>
 
175
<li>BackendClose</li>
 
176
<li>BackendOpen</li>
 
177
<li>BackendReuse</li>
 
178
<li>BackendXID</li>
 
179
<li>CLI</li>
 
180
<li>ClientAddr</li>
 
181
<li>Debug</li>
 
182
<li>Error</li>
 
183
<li>ExpBan</li>
 
184
<li>ExpKill</li>
 
185
<li>ExpPick</li>
 
186
<li>Hit</li>
 
187
<li>HitPass</li>
 
188
<li>HttpError</li>
 
189
<li>HttpGarbage</li>
 
190
<li>Length</li>
 
191
<li>ObjHeader</li>
 
192
<li>ObjLostHeader</li>
 
193
<li>ObjProtocol</li>
 
194
<li>ObjRequest</li>
 
195
<li>ObjResponse</li>
 
196
<li>ObjStatus</li>
 
197
<li>ObjURL</li>
 
198
<li>ReqEnd</li>
 
199
<li>ReqStart</li>
 
200
<li>RxHeader</li>
 
201
<li>RxLostHeader</li>
 
202
<li>RxProtocol</li>
 
203
<li>RxRequest</li>
 
204
<li>RxResponse</li>
 
205
<li>RxStatus</li>
 
206
<li>RxURL</li>
 
207
<li>SessionClose</li>
 
208
<li>SessionOpen</li>
 
209
<li>StatAddr</li>
 
210
<li>StatSess</li>
 
211
<li>TTL</li>
 
212
<li>TxHeader</li>
 
213
<li>TxLostHeader</li>
 
214
<li>TxProtocol</li>
 
215
<li>TxRequest</li>
 
216
<li>TxResponse</li>
 
217
<li>TxStatus</li>
 
218
<li>TxURL</li>
 
219
<li>VCL_acl</li>
 
220
<li>VCL_call</li>
 
221
<li>VCL_return</li>
 
222
<li>VCL_trace</li>
 
223
<li>WorkThread</li>
 
224
</ul>
 
225
</div>
 
226
<div class="section" id="examples">
 
227
<h3>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
 
228
<p>The following command line simply copies all log entries to a log file::</p>
 
229
<div class="highlight-python"><pre>$ varnishlog -w /var/log/varnish.log</pre>
 
230
</div>
 
231
<p>The following command line reads that same log file and displays requests for the front page::</p>
 
232
<div class="highlight-python"><pre>$ varnishlog -r /var/log/varnish.log -c -m 'RxURL:^/$'</pre>
 
233
</div>
 
234
</div>
 
235
<div class="section" id="see-also">
 
236
<h3>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h3>
 
237
<ul class="simple">
 
238
<li>varnishd(1)</li>
 
239
<li>varnishhist(1)</li>
 
240
<li>varnishncsa(1)</li>
 
241
<li>varnishstat(1)</li>
 
242
<li>varnishtop(1)</li>
 
243
</ul>
 
244
</div>
 
245
<div class="section" id="history">
 
246
<h3>HISTORY<a class="headerlink" href="#history" title="Permalink to this headline">¶</a></h3>
 
247
<p>The varnishlog utility was developed by Poul-Henning Kamp ⟨phk&#64;phk.freebsd.dk⟩ in cooperation with Verdens Gang
 
248
AS, Varnish Software AS and Varnish Software.  This manual page was initially written by Dag-Erling Smørgrav.</p>
 
249
</div>
 
250
<div class="section" id="copyright">
 
251
<h3>COPYRIGHT<a class="headerlink" href="#copyright" title="Permalink to this headline">¶</a></h3>
 
252
<p>This document is licensed under the same licence as Varnish
 
253
itself. See LICENCE for details.</p>
 
254
<ul class="simple">
 
255
<li>Copyright (c) 2006 Verdens Gang AS</li>
 
256
<li>Copyright (c) 2006-2011 Varnish Software AS</li>
 
257
</ul>
 
258
</div>
 
259
</div>
 
260
</div>
 
261
 
 
262
 
 
263
          </div>
 
264
        </div>
 
265
      </div>
 
266
      <div class="sphinxsidebar">
 
267
        <div class="sphinxsidebarwrapper">
 
268
  <h3><a href="../index.html">Table Of Contents</a></h3>
 
269
  <ul>
 
270
<li><a class="reference internal" href="#">varnishlog</a><ul>
 
271
<li><a class="reference internal" href="#display-varnish-logs">Display Varnish logs</a><ul>
 
272
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
 
273
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
 
274
<li><a class="reference internal" href="#tags">TAGS</a></li>
 
275
<li><a class="reference internal" href="#examples">EXAMPLES</a></li>
 
276
<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
 
277
<li><a class="reference internal" href="#history">HISTORY</a></li>
 
278
<li><a class="reference internal" href="#copyright">COPYRIGHT</a></li>
 
279
</ul>
 
280
</li>
 
281
</ul>
 
282
</li>
 
283
</ul>
 
284
 
 
285
  <h4>Previous topic</h4>
 
286
  <p class="topless"><a href="varnishhist.html"
 
287
                        title="previous chapter">varnishhist</a></p>
 
288
  <h4>Next topic</h4>
 
289
  <p class="topless"><a href="varnishncsa.html"
 
290
                        title="next chapter">varnishncsa</a></p>
 
291
  <h3>This Page</h3>
 
292
  <ul class="this-page-menu">
 
293
    <li><a href="../_sources/reference/varnishlog.txt"
 
294
           rel="nofollow">Show Source</a></li>
 
295
  </ul>
 
296
<div id="searchbox" style="display: none">
 
297
  <h3>Quick search</h3>
 
298
    <form class="search" action="../search.html" method="get">
 
299
      <input type="text" name="q" size="18" />
 
300
      <input type="submit" value="Go" />
 
301
      <input type="hidden" name="check_keywords" value="yes" />
 
302
      <input type="hidden" name="area" value="default" />
 
303
    </form>
 
304
    <p class="searchtip" style="font-size: 90%">
 
305
    Enter search terms or a module, class or function name.
 
306
    </p>
 
307
</div>
 
308
<script type="text/javascript">$('#searchbox').show(0);</script>
 
309
        </div>
 
310
      </div>
 
311
      <div class="clearer"></div>
 
312
    </div>
 
313
    <div class="related">
 
314
      <h3>Navigation</h3>
 
315
      <ul>
 
316
        <li class="right" style="margin-right: 10px">
 
317
          <a href="../genindex.html" title="General Index"
 
318
             >index</a></li>
 
319
        <li class="right" >
 
320
          <a href="varnishncsa.html" title="varnishncsa"
 
321
             >next</a> |</li>
 
322
        <li class="right" >
 
323
          <a href="varnishhist.html" title="varnishhist"
 
324
             >previous</a> |</li>
 
325
        <li><a href="../index.html">Varnish version 3.0.2 documentation</a> &raquo;</li>
 
326
          <li><a href="index.html" >The Varnish Reference Manual</a> &raquo;</li> 
 
327
      </ul>
 
328
    </div>
 
329
    <div class="footer">
 
330
        &copy; Copyright 2010, Varnish Project.
 
331
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
 
332
    </div>
 
333
  </body>
 
334
</html>
 
 
b'\\ No newline at end of file'