.\" Man page generated from reStructuredText.
.
.TH VARNISHSTAT 1 "" "" ""
.SH NAME
varnishstat \- Varnish Cache statistics
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
varnishstat [\-1] [\-f <glob>] [\-h] [\-I <glob>] [\-j] [\-l] [\-n <dir>] [\-t <seconds|off>] [\-V] [\-X <glob>] [\-x]
.SH DESCRIPTION
.sp
The varnishstat utility displays statistics from a running varnishd(1) instance.
.sp
The following options are available:
.INDENT 0.0
.TP
.B \-1
Instead of presenting a continuously updated display, print the statistics to stdout.
.TP
.BI \-f \ <glob>
Legacy field filtering glob. Use backslash to escape characters. If the argument starts with \(aq^\(aq it is used as an exclusive glob. Multiple \-f arguments may be given. Legacy filtering globs are run along with inclusion globs (\-I arguments) and exclusion globs (\-X arguments) in order on a first\-match basis.
.TP
.B \-h
Print program usage and exit
.TP
.BI \-I \ <glob>
Field inclusion glob. Use backslash to escape characters. Multiple \-I  arguments may be given. Exclusion globs are run in order along with exclusion globs (\-X arguments) and legacy filtering globs (\-f arguments) on a first\-match basis.
.TP
.B \-j
Print statistics to stdout as JSON.
.TP
.B \-l
Lists the available fields to use with the \-f option.
.TP
.BI \-n \ <dir>
Specify the varnishd working directory (also known as instance name) to get logs from. If \-n is not specified, the host name is used.
.TP
.BI \-t \ <seconds|off>
Timeout before returning error on initial VSM connection. If set the VSM connection is retried every 0.5 seconds for this many seconds. If zero the connection is attempted only once and will fail immediately if unsuccessful. If set to "off", the connection will not fail, allowing the utility to start and wait indefinetely for the Varnish instance to appear.  Defaults to 5 seconds.
.TP
.B \-V
Print version information and exit.
.TP
.BI \-X \ <glob>
Field exclusion glob. Use backslash to escape characters. Multiple \-X  arguments may be given. Exclusion globs are run in order along with inclusion globs (\-I arguments) and legacy filtering globs (\-f arguments) on a first\-match basis.
.TP
.B \-x
Print statistics to stdout as XML.
.TP
.B \-\-optstring
Print the optstring parameter to \fBgetopt(3)\fP to help writing wrapper scripts.
.UNINDENT
.SH CURSES MODE
.sp
When neither \-1, \-j nor \-x options are given, the application starts up
in curses mode. This shows a continuously updated view of the counter
values, along with their description.
.sp
The top area shows process uptime information.
.sp
The center area shows a list of counter values.
.sp
The bottom area shows the description of the currently selected
counter.
.sp
On startup, only counters at INFO level are shown.
.SS Columns
.sp
The following columns are displayed, from left to right:
.INDENT 0.0
.TP
.B Name
The name of the counter
.TP
.B Current
The current value of the counter.
.TP
.B Change
The average per second change over the last update interval.
.TP
.B Average
The average value of this counter over the runtime of the
Varnish daemon, or a period if the counter can\(aqt be averaged.
.TP
.B Avg_10
The moving average over the last 10 update intervals.
.TP
.B Avg_100
The moving average over the last 100 update intervals.
.TP
.B Avg_1000
The moving average over the last 1000 update intervals.
.UNINDENT
.SS Key bindings
.INDENT 0.0
.TP
.B <h>
Toggle the help screen.
.TP
.B <UP> or <k>
Navigate the counter list one line up.
.TP
.B <DOWN> or <j>
Navigate the counter list one line down.
.TP
.B <PAGEUP> or <b> or <CTRL\-B>
Navigate the counter list one page up.
.TP
.B <PAGEDOWN> or <SPACE> or <CTRL\-F>
Navigate the counter list one page down.
.TP
.B <HOME> or <g>
Navigate the counter list to the top.
.TP
.B <END> or <G>
Navigate the counter list to the bottom.
.TP
.B <d>
Toggle between showing and hiding unseen counters. Unseen
counters are those that has been zero for the entire runtime
of varnishstat. Defaults to hide unseen counters.
.TP
.B <e>
Toggle scaling of values.
.TP
.B <v>
Increase verbosity. Defaults to only showing informational
counters.
.TP
.B <V>
Decrease verbosity. Defaults to only showing informational
counters.
.TP
.B <q>
Quit.
.TP
.B <CTRL+T>
Sample now.
.TP
.B <+>
Increase refresh interval.
.TP
.B <\->
Decrease refresh interval.
.UNINDENT
.SH OUTPUTS
.sp
The XML output format is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<varnishstat timestamp="YYYY\-MM\-DDTHH:mm:SS">
  <stat>
    <name>FIELD NAME</name>
    <value>FIELD VALUE</value>
    <flag>FIELD SEMANTICS</flag>
    <format>FIELD DISPLAY FORMAT</format>
    <description>FIELD DESCRIPTION</description>
  </stat>
  [..]
</varnishstat>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The JSON output format is:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
  "timestamp": "YYYY\-MM\-DDTHH:mm:SS",
  "FIELD NAME": {
    "description": "FIELD DESCRIPTION",
    "flag": "FIELD SEMANTICS", "format": "FIELD DISPLAY FORMAT",
    "value": FIELD VALUE
  },
  "FIELD NAME": {
    "description": "FIELD DESCRIPTION",
    "flag": "FIELD SEMANTICS", "format": "FIELD DISPLAY FORMAT",
    "value": FIELD VALUE
  },
  [..]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Timestamp is the time when the report was generated by varnishstat.
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
\fIvarnishd(1)\fP
.IP \(bu 2
\fIvarnishhist(1)\fP
.IP \(bu 2
\fIvarnishlog(1)\fP
.IP \(bu 2
\fIvarnishncsa(1)\fP
.IP \(bu 2
\fIvarnishtop(1)\fP
.IP \(bu 2
curses(3)
.IP \(bu 2
\fIvarnish\-counters(7)\fP
.UNINDENT
.SH AUTHORS
.sp
This manual page was written by Dag\-Erling Smørgrav, Per Buer,
Lasse Karstensen and Martin Blix Grydeland.
.\" Generated by docutils manpage writer.
.