Changes
no edit summary
{{DISPLAYTITLE:vzstats}}
<languages />
<translate>
<!--T:1-->
'''vzstats''' is a tool to gather OpenVZ usage statistics. This page tries to explain it, mostly in form of questions and answers.
<!--T:2-->vzstats consists of a client and a server. Client A client (vzstats package) is installed on an OpenVZ server (hardware node), so there are many clients. Server There is only one server, it is deployed at stats.openvz.org, and .
== General ==<!--T:3-->
=== What is the purpose of vzstats? ===<!--T:4-->
<!--T:5-->
We, OpenVZ developers, are curious. We want to know more about our users. We want some stats.
<!--T:6-->
We would like to know how many OpenVZ servers are there in the wild. Since OpenVZ is free software available from many places, there is no easy way to find out.
<!--T:7-->
We want to know which OpenVZ kernels are our users run, say what is the proportion of RHEL5 to RHEL6 kernel user base.
<!--T:8-->
We would like to see how many people use new technologies such as [[ploop]] and [[vswap]].
<!--T:9-->
It would be good to know for how many CPU cores, or number of containers, or gigabytes of disk space, should we optimize.
<!--T:10-->
Finally, we share all that information back to you.
=== Why do I need to participate? ===<!--T:11-->
<!--T:12-->
Maybe because you want to help OpenVZ out just a bit. Because sharing is good. Or perhaps you are just a good person.
=== Why is it opt-out rather than opt-in? ===<!--T:13-->
<!--T:14-->
We just don't have a good place (such as installer or some GUI) to ask you for opt-in.
=== What about my privacy? ===<!--T:15-->
<!--T:16-->
We are trying to keep the client very simple, so you can see for yourself what information is gathered and how it is being sent.
<!--T:17-->
All submissions are anonymous and is not including your IPs, MAC addresses, host names etc.
<!--T:18-->
Except for the information gathered, server knows client's UUID and IP.
<!--T:19-->
UUID is random, it's only purpose to track each client as a separate distinct entity.
<!--T:20-->
Client IP address is naturally known to the server. It is stored in httpd server logs but is not used for statistics.
== Client ==<!--T:21-->
=== How the client works? ===<!--T:22-->
<!--T:23-->
When vzstats is executed, it does the following:
# checks if UUID is obtained; asks the server for one if it's not;
# sends this tarball together with UUID to the stats server, stats.openvz.org
=== What is UUIDWhere can I see client source code? ===<!--T:24-->
<!--T:25-->
Client is written in shell, so just check /usr/sbin/vzstats script.
<!--T:26-->
There is a git repository for client code, see http://git.openvz.org/?p=vzstats;a=summary
=== What is UUID? === <!--T:27-->
<!--T:28-->
It's just a unique random ID, in UUID v4 format [http://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_.28random.29]. This is an example of UUID: <code>285ad6e8-fe62-433c-be2a-643e1c54b315</code>
<!--T:29-->
When <code>vzstats</code> is executed for the first time, it checks that there is no UUID, asks the stats server for one and stores it locally.
=== What info is collected? ===<!--T:30-->
<!--T:31-->
For details, check the scripts in <code>/usr/libexec/vzstats</code> directory.
=== When it is run? Download ===<!--T:32--> <!--T:33-->For latest and previous versions of vzstats see [[Download/vzstats]]. === Source code === <!--T:34--> <!--T:35-->https://src.openvz.org/projects/OVZL/repos/vzstats/browse
=== When it is run? === <!--T:36-->
<!--T:37-->
vzstats run in the following cases
* Upon installation, if OpenVZ is already installed on the system
<!-- NOT IMPLEMENTED YET * During system boot, if OpenVZ is started (from vz initscript)-->
* When any of OpenVZ packages are updated (vzctl, vzquota, ploop, kernel)
* Periodically, once a month, from cron, if crond is running.
=== How to opt-out === <!--T:39-->
<!--T:40-->
You can completely disable vzstats client on a machine by executing the following command:
<!--T:42-->
If you want to re-enable vzstats, just do
<!--T:43-->rm -f /etc/vz/vzstats-disable == Server == <!--T:44--> <!--T:45-->Server consists of the following components:* database (MySQL)* trivial UUID generation script* submission receiver script, which just stores the received file* submission processing scripts, populating the database* web interface (http://stats.openvz.org/), showing statistics from the database
== Server See also ==<!--T:46-->
