.. This file is automatically updated at build time from man/mon-collector.gen.
.. Do not edit.

mon-collector
==========================================

NAME
----

mon-collector - Command line interface for the data collectors of the
monitoring system

SYNOPSIS
--------

**mon-collector** {collector}

DESCRIPTION
-----------

``mon-collector`` is a suite of tools designed to provide a command line
interface to the data collectors implemented by the ganeti monitoring system.
``mon-collector`` is also the generic binary that must be invoked specifying,
as the first command line parameter, the name of the actual desired data
collector to be run.

When executed, ``mon-collector`` will run the specified collector and will
print its output to stdout, in JSON format.

COLLECTORS
----------

DISKSTATS
~~~~~~~~~

| diskstats [ [ **-f** | **\--file** ] = *input-file* ]

Collects the information about the status of the disks of the system, as listed
by /proc/diskstats, or by an alternate file with the same syntax specified on
the command line.

The options that can be passed to the DRBD collector are as follows:

-f *input-file*, \--file=*input-file*
  Where to read the data from. Default if not specified: /proc/diskstats

DRBD
~~~~

| drbd [ [ **-s** | **\--drbd-status** ] = *status-file* ] [ [ **-p** |
  **\--drbd-pairing**] = *pairing-file* ]

Collects the information about the version and status of the DRBD kernel
module, and of the disks it is managing.

If *status-file* and *pairing-file* are specified, the status and the
instance-minor paring information will be read from those files.
Otherwise, the collector will read them, respectively, from /proc/drbd
and from the Confd server.

The options that can be passed to the DRBD collector are as follows:

-s *status-file*, \--drbd-status=*status-file*
  Read the DRBD status from the specified file instead of /proc/drbd.

-p *pairing-file*, \--drbd-pairing=*pairing-file*
  Read the information about the pairing between instances and DRBD minors
  from the specified file instead of asking the Confd servers for them.

INSTANCE STATUS
~~~~~~~~~~~~~~~

| inst-status-xen [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** |
  **\--port** ] = *port-number* ]

Collects the information about the status of the instances of the current node.
In order to perform this task, it needs to connect to the ConfD daemon to fetch
some configuration information. The following parameters allow the user to
specify the position where the daemon is listening, in case it's not the default
one:

-a *ip-address*, \--address=*ip-address*
  The IP address the ConfD daemon is listening on.

-p *port-number*, \--port=*port-number*
  The port the ConfD deamon is listening on.

LOGICAL VOLUMES
~~~~~~~~~~~~~~~

| lv [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** | **\--port** ]
  = *port-number* ] [ [ **-f** | **\--file** ] = *input-file* ]
  [ [ **-i** | **\--instances** ] = *instances-file* ]

Collects the information about the logical volumes of the current node.

In order to perform this task, it needs to interact with the ``lvs`` command
line tool and to connect to the ConfD daemon to fetch some configuration
information. The following parameters allow the user to specify the position
where the daemon is listening, in case it's not the default one:

-a *ip-address*, \--address=*ip-address*
  The IP address the ConfD daemon is listening on.

-p *port-number*, \--port=*port-number*
  The port the ConfD deamon is listening on.

Instead of accessing the live data on the cluster, the tool can also read data
serialized on files (mainly for testing purposes). Namely:

-f *input-file*, \--file *input-file*
  The name of the file containing a recorded output of the ``lvs`` tool.

-i *instances-file*, \--instances=*instances-file*
  The name of the file containing a JSON serialization of instances the
  current node is primary and secondary for, listed as::

    ([Instance], [Instance])

  where the first list contains the instances the node is primary for, the
  second list those the node is secondary for.