1VARNISHSTAT(1)                                                  VARNISHSTAT(1)
2
3
4

NAME

6       varnishstat - Varnish Cache statistics
7

SYNOPSIS

9       varnishstat  [-1]  [-f  <glob>]  [-h]  [-j]  [-l]  [-n <dir>] [-t <sec‐
10       onds|off>] [-V] [-x]
11

DESCRIPTION

13       The varnishstat utility displays statistics from a running  varnishd(1)
14       instance.
15
16       The following options are available:
17
18       -1     Instead  of presenting a continuously updated display, print the
19              statistics to stdout.
20
21       -f <glob>
22              Field inclusion glob. Use backslash to escape characters. If the
23              argument starts with '^' it is used as an exclusive glob. Multi‐
24              ple -f arguments may be given. Inclusive globs are  accumulative
25              and are run before exclusive ones.
26
27       -h     Print program usage and exit
28
29       -j     Print statistics to stdout as JSON.
30
31       -l     Lists the available fields to use with the -f option.
32
33       -n <dir>
34              Specify  the  varnishd working directory (also known as instance
35              name) to get logs from. If -n is not specified, the host name is
36              used.
37
38       -t <seconds|off>
39              Timeout before returning error on initial VSM connection. If set
40              the VSM connection is retried every 0.5 seconds  for  this  many
41              seconds.  If zero the connection is attempted only once and will
42              fail immediately if unsuccessful. If set to "off",  the  connec‐
43              tion will not fail, allowing the utility to start and wait inde‐
44              finetely for the Varnish instance to appear.  Defaults to 5 sec‐
45              onds.
46
47       -V     Print version information and exit.
48
49       -x     Print statistics to stdout as XML.
50
51       --optstring
52              Print the optstring parameter to getopt(3) to help writing wrap‐
53              per scripts.
54

CURSES MODE

56       When neither -1, -j or -x options are given, the application starts  up
57       in  curses  mode. This shows a continuously updated view of the counter
58       values, along with their description.
59
60       The top area shows process uptime information.
61
62       The center area shows a list of counter values.
63
64       The bottom  area  shows  the  description  of  the  currently  selected
65       counter.
66
67   Columns
68       The following columns are displayed, from left to right:
69
70       Name   The name of the counter
71
72       Current
73              The current value of the counter.
74
75       Change The average per second change over the last update interval.
76
77       Average
78              The  average  value of this counter over the runtime of the Var‐
79              nish daemon, or a period if the counter can't be averaged.
80
81       Avg_10 The moving average over the last 10 update intervals.
82
83       Avg_100
84              The moving average over the last 100 update intervals.
85
86       Avg_1000
87              The moving average over the last 1000 update intervals.
88
89   Key bindings
90       The following keys control the interactive display:
91
92       <UP>   Navigate the counter list one line up.
93
94       <DOWN> Navigate the counter list one line down.
95
96       <PAGEUP> or <b>
97              Navigate the counter list one page up.
98
99       <PAGEDOWN> or <SPACE>
100              Navigate the counter list one page down.
101
102       <d>    Toggle between showing and hiding unseen counters. Unseen  coun‐
103              ters are those that has been zero for the entire runtime of var‐
104              nishstat. Defaults to hide unseen counters.
105
106       <e>    Toggle scaling of values.
107
108       <g>    Go to the top of the counter list.
109
110       <G>    Go to the bottom of the counter list.
111
112       <v>    Cycle through the verbosity levels.  Defaults  to  only  showing
113              informational counters.
114
115       <q>    Quit.
116
117       <CTRL+T>
118              Sample now.
119
120       <+>    Increase refresh interval.
121
122       <->    Decrease refresh interval.
123

OUTPUTS

125       The XML output format is:
126
127          <varnishstat timestamp="YYYY-MM-DDTHH:mm:SS">
128            <stat>
129              <name>FIELD NAME</name>
130              <value>FIELD VALUE</value>
131              <flag>FIELD SEMANTICS</flag>
132              <format>FIELD DISPLAY FORMAT</format>
133              <description>FIELD DESCRIPTION</description>
134            </stat>
135            [..]
136          </varnishstat>
137
138       The JSON output format is:
139
140          {
141            "timestamp": "YYYY-MM-DDTHH:mm:SS",
142            "FIELD NAME": {
143              "description": "FIELD DESCRIPTION",
144              "flag": "FIELD SEMANTICS", "format": "FIELD DISPLAY FORMAT",
145              "value": FIELD VALUE
146            },
147            "FIELD NAME": {
148              "description": "FIELD DESCRIPTION",
149              "flag": "FIELD SEMANTICS", "format": "FIELD DISPLAY FORMAT",
150              "value": FIELD VALUE
151            },
152            [..]
153          }
154
155       Timestamp is the time when the report was generated by varnishstat.
156

SEE ALSO

158       · varnishd(1)
159
160       · varnishhist(1)
161
162       · varnishlog(1)
163
164       · varnishncsa(1)
165
166       · varnishtop(1)
167
168       · curses(3)
169
170       · varnish-counters(7)
171

AUTHORS

173       This  manual  page  was written by Dag-Erling Smørgrav, Per Buer, Lasse
174       Karstensen and Martin Blix Grydeland.
175
176
177
178
179                                                                VARNISHSTAT(1)