varnishstat

Varnish Cache statistics

SYNOPSIS

varnishstat [-1] [-c] [-f <glob>] [-h] [-I <glob>] [-j] [-l] [-n <workdir>] [-r] [-t <seconds|off>] [-V] [-X <glob>] [-x]

DESCRIPTION

The varnishstat utility displays statistics from a running varnishd(1) instance.

The following options are available:

CURSES MODE

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.

The top area shows process uptime information.

The center area shows a list of counter values.

The bottom area shows the description of the currently selected counter.

On startup, only counters at INFO level are shown.

Columns

The following columns are displayed, from left to right:

Name
The name of the counter
Current
The current value of the counter.
Change
The average per second change over the last update interval.
Average
The average value of this counter over the runtime of the Varnish daemon, or a period if the counter can’t be averaged.
Avg_10
The moving average over the last 10 update intervals.
Avg_100
The moving average over the last 100 update intervals.
Avg_1000
The moving average over the last 1000 update intervals.

Key bindings

<h>
Toggle the help screen.
<UP> or <k>
Navigate the counter list one line up.
<DOWN> or <j>
Navigate the counter list one line down.
<PAGEUP> or <b> or <CTRL-B>
Navigate the counter list one page up.
<PAGEDOWN> or <SPACE> or <CTRL-F>
Navigate the counter list one page down.
<HOME> or <g>
Navigate the counter list to the top.
<END> or <G>
Navigate the counter list to the bottom.
<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.
<r>
Toggle between showing raw and adjusted gauges. When a gauge is decremented faster than it is incremented, it may appear as a large integer with its most significant bit set. By default such values are adjusted to zero.
<e>
Toggle scaling of values.
<v>
Increase verbosity. Defaults to only showing informational counters.
<V>
Decrease verbosity. Defaults to only showing informational counters.
<q>
Quit.
<CTRL+T>
Sample now.
<0>
Reset averages.
<+>
Increase refresh interval.
<->
Decrease refresh interval.

OUTPUTS

The XML output format is:

<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>

The JSON output format is:

{
  "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
  },
  [..]
}

Timestamp is the time when the report was generated by varnishstat.

SEE ALSO

AUTHORS

This manual page was written by Dag-Erling Smørgrav, Per Buer, Lasse Karstensen and Martin Blix Grydeland.