..
	Copyright (c) 2010-2020 Varnish Software AS
	SPDX-License-Identifier: BSD-2-Clause
	See LICENSE file for full text of license

.. role:: ref(emphasis)

.. _vinylstat(1):

=========
vinylstat
=========

----------------------
Vinyl Cache statistics
----------------------

:Manual section: 1

SYNOPSIS
========

.. include:: ../include/vinylstat_synopsis.rst
vinylstat |synopsis|

DESCRIPTION
===========

The vinylstat utility displays statistics from a running vinyld(1) instance.

The following options are available:

.. include:: ../include/vinylstat_options.rst

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

.. include:: ../include/vinylstat_bindings.rst

OUTPUTS
=======

The XML output format is::

  <vinylstat 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>
    [..]
  </vinylstat>

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


SEE ALSO
========

* :ref:`vinyld(1)`
* :ref:`vinylhist(1)`
* :ref:`vinyllog(1)`
* :ref:`vinylncsa(1)`
* :ref:`vinyltop(1)`
* curses(3)
* :ref:`vinyl-counters(7)`


AUTHORS
=======

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