Add design for diskstats data collector
[ganeti-local] / man / mon-collector.rst
1 mon-collector(7) Ganeti | Version @GANETI_VERSION@
2 ==================================================
3
4 NAME
5 ----
6
7 mon-collector - Command line interface for the data collectors of the
8 monitoring system
9
10 SYNOPSIS
11 --------
12
13 **mon-collector** {collector}
14
15 DESCRIPTION
16 -----------
17
18 ``mon-collector`` is a suite of tools designed to provide a command line
19 interface to the data collectors implemented by the ganeti monitoring system.
20 ``mon-collector`` is also the generic binary that must be invoked specifying,
21 as the first command line parameter, the name of the actual desired data
22 collector to be run.
23
24 When executed, ``mon-collector`` will run the specified collector and will
25 print its output to stdout, in JSON format.
26
27 COLLECTORS
28 ----------
29
30 DRBD
31 ~~~~
32
33 | drbd [ [ **-s** | **\--drbd-status** ] = *status-file* ] [ [ **-p** |
34   **\--drbd-pairing**] = *pairing-file* ]
35
36 Collects the information about the version and status of the DRBD kernel
37 module, and of the disks it is managing.
38
39 If *status-file* and *pairing-file* are specified, the status and the
40 instance-minor paring information will be read from those files.
41 Otherwise, the collector will read them, respectively, from /proc/drbd
42 and from the Confd server.
43
44 The options that can be passed to the DRBD collector are as follows:
45
46 -s *status-file*, \--drbd-status=*status-file*
47   Read the DRBD status from the specified file instead of /proc/drbd.
48
49 -p *pairing-file*, \--drbd-pairing=*pairing-file*
50   Read the information about the pairing between instances and DRBD minors
51   from the specified file instead of asking the Confd servers for them.
52
53 INSTANCE STATUS
54 ~~~~~~~~~~~~~~~
55
56 | inst-status-xen [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** |
57   **\--port** ] = *port-number* ]
58
59 Collects the information about the status of the instances of the current node.
60 In order to perform this task, it needs to connect to the ConfD daemon to fetch
61 some configuration information. The following parameters allow the user to
62 specify the position where the daemon is listening, in case it's not the default
63 one:
64
65 -a *ip-address*, \--address=*ip-address*
66   The IP address the ConfD daemon is listening on.
67
68 -p *port-number*, \--port=*port-number*
69   The port the ConfD deamon is listening on.