← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/sphinx/=build/html/reference/varnishstat.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:
doc/sphinx/=build/html/reference/varnishstat.html
 
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>varnishstat &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="varnishtest" href="varnishtest.html" />
 
28
    <link rel="prev" title="varnishsizes" href="varnishsizes.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="varnishtest.html" title="varnishtest"
 
39
             accesskey="N">next</a> |</li>
 
40
        <li class="right" >
 
41
          <a href="varnishsizes.html" title="varnishsizes"
 
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="varnishstat">
 
54
<span id="reference-varnishstat"></span><h1>varnishstat<a class="headerlink" href="#varnishstat" title="Permalink to this headline">¶</a></h1>
 
55
<div class="section" id="varnish-cache-statistics">
 
56
<h2>Varnish Cache statistics<a class="headerlink" href="#varnish-cache-statistics" 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-06-1</td>
 
66
</tr>
 
67
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.0</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>varnishstat [-1] [-x] [-f field_list] [-l] [-n varnish_name] [-V] [-w delay]</p>
 
76
</div>
 
77
<div class="section" id="description">
 
78
<h3>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h3>
 
79
<p>The varnishstat utility displays statistics from a running varnishd(1) instance.</p>
 
80
<p>The following options are available:</p>
 
81
<table class="docutils option-list" frame="void" rules="none">
 
82
<col class="option" />
 
83
<col class="description" />
 
84
<tbody valign="top">
 
85
<tr><td class="option-group">
 
86
<kbd><span class="option">-1</span></kbd></td>
 
87
<td>Instead of presenting of a continuously updated display, print the statistics once and exit.</td></tr>
 
88
<tr><td class="option-group">
 
89
<kbd><span class="option">-f</span></kbd></td>
 
90
<td>A comma separated list of the fields to display.  If it starts with '^' it is used as an exclusion
 
91
list.</td></tr>
 
92
<tr><td class="option-group">
 
93
<kbd><span class="option">-l</span></kbd></td>
 
94
<td>Lists the available fields to use with the -f option.</td></tr>
 
95
<tr><td class="option-group">
 
96
<kbd><span class="option">-n</span></kbd></td>
 
97
<td>Specifies the name of the varnishd instance to get logs from.  If -n is not specified, the host name
 
98
is used.</td></tr>
 
99
<tr><td class="option-group">
 
100
<kbd><span class="option">-V</span></kbd></td>
 
101
<td>Display the version number and exit.</td></tr>
 
102
<tr><td class="option-group">
 
103
<kbd><span class="option">-w <var>delay</var></span></kbd></td>
 
104
<td>Wait delay seconds between updates.  The default is 1.</td></tr>
 
105
<tr><td class="option-group">
 
106
<kbd><span class="option">-x</span></kbd></td>
 
107
<td>Displays the result as XML once.</td></tr>
 
108
</tbody>
 
109
</table>
 
110
<p>The columns in the main display are, from left to right:</p>
 
111
<ol class="arabic simple">
 
112
<li>Value</li>
 
113
<li>Per-second average in the period since last update, or a period if the value can not be averaged</li>
 
114
<li>Per-second average over process lifetime, or a period if the value can not be averaged</li>
 
115
<li>Descriptive text</li>
 
116
</ol>
 
117
<p>When using the -1 option, the columns in the output are, from left to right:</p>
 
118
<ol class="arabic simple">
 
119
<li>Symbolic entry name</li>
 
120
<li>Value</li>
 
121
<li>Per-second average over process lifetime, or a period if the value can not be averaged</li>
 
122
<li>Descriptive text</li>
 
123
</ol>
 
124
<p>When using the -x option, the output is:</p>
 
125
<div class="highlight-python"><pre>&lt;stat&gt;
 
126
  &lt;name&gt;FIELD NAME&lt;/name&gt;
 
127
  &lt;value&gt;FIELD VALUE&lt;/value&gt;
 
128
  &lt;description&gt;FIELD DESCRIPTION&lt;/description&gt;
 
129
&lt;/stat&gt;</pre>
 
130
</div>
 
131
</div>
 
132
<div class="section" id="see-also">
 
133
<h3>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h3>
 
134
<ul class="simple">
 
135
<li>varnishd(1)</li>
 
136
<li>varnishhist(1)</li>
 
137
<li>varnishlog(1)</li>
 
138
<li>varnishncsa(1)</li>
 
139
<li>varnishtop(1)</li>
 
140
<li>curses(3)</li>
 
141
</ul>
 
142
</div>
 
143
<div class="section" id="history">
 
144
<h3>HISTORY<a class="headerlink" href="#history" title="Permalink to this headline">¶</a></h3>
 
145
<p>The varnishstat utility was originally developed by Poul-Henning Kamp
 
146
⟨phk&#64;phk.freebsd.dk⟩ in cooperation with Verdens Gang AS, Varnish Software AS
 
147
and Varnish Software. Manual page written by Dag-Erling Smørgrav,
 
148
and Per Buer.</p>
 
149
</div>
 
150
<div class="section" id="copyright">
 
151
<h3>COPYRIGHT<a class="headerlink" href="#copyright" title="Permalink to this headline">¶</a></h3>
 
152
<p>This document is licensed under the same licence as Varnish
 
153
itself. See LICENCE for details.</p>
 
154
<ul class="simple">
 
155
<li>Copyright (c) 2006 Verdens Gang AS</li>
 
156
<li>Copyright (c) 2006-2008 Varnish Software AS</li>
 
157
</ul>
 
158
</div>
 
159
</div>
 
160
</div>
 
161
 
 
162
 
 
163
          </div>
 
164
        </div>
 
165
      </div>
 
166
      <div class="sphinxsidebar">
 
167
        <div class="sphinxsidebarwrapper">
 
168
  <h3><a href="../index.html">Table Of Contents</a></h3>
 
169
  <ul>
 
170
<li><a class="reference internal" href="#">varnishstat</a><ul>
 
171
<li><a class="reference internal" href="#varnish-cache-statistics">Varnish Cache statistics</a><ul>
 
172
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
 
173
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
 
174
<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
 
175
<li><a class="reference internal" href="#history">HISTORY</a></li>
 
176
<li><a class="reference internal" href="#copyright">COPYRIGHT</a></li>
 
177
</ul>
 
178
</li>
 
179
</ul>
 
180
</li>
 
181
</ul>
 
182
 
 
183
  <h4>Previous topic</h4>
 
184
  <p class="topless"><a href="varnishsizes.html"
 
185
                        title="previous chapter">varnishsizes</a></p>
 
186
  <h4>Next topic</h4>
 
187
  <p class="topless"><a href="varnishtest.html"
 
188
                        title="next chapter">varnishtest</a></p>
 
189
  <h3>This Page</h3>
 
190
  <ul class="this-page-menu">
 
191
    <li><a href="../_sources/reference/varnishstat.txt"
 
192
           rel="nofollow">Show Source</a></li>
 
193
  </ul>
 
194
<div id="searchbox" style="display: none">
 
195
  <h3>Quick search</h3>
 
196
    <form class="search" action="../search.html" method="get">
 
197
      <input type="text" name="q" size="18" />
 
198
      <input type="submit" value="Go" />
 
199
      <input type="hidden" name="check_keywords" value="yes" />
 
200
      <input type="hidden" name="area" value="default" />
 
201
    </form>
 
202
    <p class="searchtip" style="font-size: 90%">
 
203
    Enter search terms or a module, class or function name.
 
204
    </p>
 
205
</div>
 
206
<script type="text/javascript">$('#searchbox').show(0);</script>
 
207
        </div>
 
208
      </div>
 
209
      <div class="clearer"></div>
 
210
    </div>
 
211
    <div class="related">
 
212
      <h3>Navigation</h3>
 
213
      <ul>
 
214
        <li class="right" style="margin-right: 10px">
 
215
          <a href="../genindex.html" title="General Index"
 
216
             >index</a></li>
 
217
        <li class="right" >
 
218
          <a href="varnishtest.html" title="varnishtest"
 
219
             >next</a> |</li>
 
220
        <li class="right" >
 
221
          <a href="varnishsizes.html" title="varnishsizes"
 
222
             >previous</a> |</li>
 
223
        <li><a href="../index.html">Varnish version 3.0.2 documentation</a> &raquo;</li>
 
224
          <li><a href="index.html" >The Varnish Reference Manual</a> &raquo;</li> 
 
225
      </ul>
 
226
    </div>
 
227
    <div class="footer">
 
228
        &copy; Copyright 2010, Varnish Project.
 
229
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
 
230
    </div>
 
231
  </body>
 
232
</html>
 
 
b'\\ No newline at end of file'