Editing Man/vzstats.8

== NAME ==

<p style="margin-left:11%; margin-top: 1em">vzstats &minus;
report OpenVZ usage statistics</p>

== SYNOPSIS ==

<p style="margin-left:11%; margin-top: 1em"><b>vzstats <br>
vzstats&nbsp;--view</b>|<b>--status <br>
vzstats&nbsp;--enable</b>|<b>--disable <br>
vzstats&nbsp;--help</b></p>

== DESCRIPTION ==

<p style="margin-left:11%; margin-top: 1em">Utility
<b>vzstats</b>, installed on an OpenVZ server, periodically
collects some usage statistics and sends it to the OpenVZ
stats server, <b>http://stats.openvz.org</b>, for processing
and analysis. Aggregated statistics from all reports are
available through the web interface.</p>

<p style="margin-left:11%; margin-top: 1em">Statistics
reported include some basic hardware information (CPU, RAM,
PCI information, file system and disk space usage for
<b>/vz</b>), software information (distribution version,
kernel version, OpenVZ software versions), and some
OpenVZ-specific information (number of containers
running/total, number of containers using <b>vswap</b> and
<b>ploop</b>, used OS templates etc.). Information
submission is anonymous; information that can be used to
directly identify a particular host (i.e. MAC or IP
addresses, hostnames etc.) is not being reported.</p>

<p style="margin-left:11%; margin-top: 1em">For the server
to anonymously identify reports from the same client, a
unique random ID (UUID v4) is requested from the server
during the first <b>vzstats</b> run. It is then saved
locally and used when sending reports.</p>

<p style="margin-left:11%; margin-top: 1em">If run without
any options and unless disabled, <b>vzstats</b> runs report
scripts found in <b>REPDIR</b> (defined in
<b>vzstats.conf</b>, default is <b>@REPDIR@</b>), collects
their output and sends it, as a tarball, to stats
server.</p>

== OPTIONS ==

<p style="margin-left:11%; margin-top: 1em">In case any
option is provided, no report is being send, instead an
action denoted by the option is performed.</p>

<p style="margin-left:11%; margin-top: 1em">The following
options are supported:</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">

<p><b>--view</b></p></td>
<td width="2%"></td>
<td width="78%">

<p>Collect but do not send report, giving a user an ability
to see what exact information would be send.</p></td></tr>
</table>

<p style="margin-left:11%;"><b>--config</b></p>

<p style="margin-left:22%;">Output current <b>vzstats</b>
configuration, including: <br>
&bull; current version number; <br>
&bull; status (enabled or disabled); <br>
&bull; an URL used to submit reports to; <br>
&bull; vzstats UUID; <br>
&bull; report scripts directory.</p>

<p style="margin-left:11%;"><b>--disable</b></p>

<p style="margin-left:22%;">Disable reporting. This is
performed by creating a marker file,
<b>@ETCDIR@/vzstats-disable</b>. <b>vzstats</b> checks this
file upon start, and exits if it is present.</p>

<p style="margin-left:11%;"><b>--enable</b></p>

<p style="margin-left:22%;">Re-enable reporting.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">

<p><b>--help</b></p></td>
<td width="2%"></td>
<td width="16%">

<p>Show usage.</p></td>
<td width="62%">
</td></tr>
</table>

== FILES ==

<pre style="margin-left:11%; margin-top: 1em">@ETCDIR@/vzstats.conf
@ETCDIR@/vzstats-disable
@REPDIR@/*</pre>

== SEE ALSO ==

<p style="margin-left:11%; margin-top: 1em">[[Man/vzlist.8|<b>vzlist</b>(8)]],
<b>http://stats.openvz.org/</b>,
<b>http://openvz.org/vzstats</b>.</p>

== LICENSE ==

<p style="margin-left:11%; margin-top: 1em">Copyright (C)
2013, Parallels, Inc. Licensed under GNU GPL.</p>