code.grnet.gr Git - ganeti-local/blob - 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 DISKSTATS
  31 ~~~~~~~~~
  32
  33 | diskstats [ [ **-f** | **\--file** ] = *input-file* ]
  34
  35 Collects the information about the status of the disks of the system, as listed
  36 by /proc/diskstats, or by an alternate file with the same syntax specified on
  37 the command line.
  38
  39 The options that can be passed to the DRBD collector are as follows:
  40
  41 -f *input-file*, \--file=*input-file*
  42   Where to read the data from. Default if not specified: /proc/diskstats
  43
  44 DRBD
  45 ~~~~
  46
  47 | drbd [ [ **-s** | **\--drbd-status** ] = *status-file* ] [ [ **-p** |
  48   **\--drbd-pairing**] = *pairing-file* ]
  49
  50 Collects the information about the version and status of the DRBD kernel
  51 module, and of the disks it is managing.
  52
  53 If *status-file* and *pairing-file* are specified, the status and the
  54 instance-minor paring information will be read from those files.
  55 Otherwise, the collector will read them, respectively, from /proc/drbd
  56 and from the Confd server.
  57
  58 The options that can be passed to the DRBD collector are as follows:
  59
  60 -s *status-file*, \--drbd-status=*status-file*
  61   Read the DRBD status from the specified file instead of /proc/drbd.
  62
  63 -p *pairing-file*, \--drbd-pairing=*pairing-file*
  64   Read the information about the pairing between instances and DRBD minors
  65   from the specified file instead of asking the Confd servers for them.
  66
  67 INSTANCE STATUS
  68 ~~~~~~~~~~~~~~~
  69
  70 | inst-status-xen [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** |
  71   **\--port** ] = *port-number* ]
  72
  73 Collects the information about the status of the instances of the current node.
  74 In order to perform this task, it needs to connect to the ConfD daemon to fetch
  75 some configuration information. The following parameters allow the user to
  76 specify the position where the daemon is listening, in case it's not the default
  77 one:
  78
  79 -a *ip-address*, \--address=*ip-address*
  80   The IP address the ConfD daemon is listening on.
  81
  82 -p *port-number*, \--port=*port-number*
  83   The port the ConfD deamon is listening on.
  84
  85 LOGICAL VOLUMES
  86 ~~~~~~~~~~~~~~~
  87
  88 | lv [ [ **-a** | **\--address** ] = *ip-address* ] [ [ **-p** | **\--port** ]
  89   = *port-number* ] [ [ **-f** | **\--file** ] = *input-file* ]
  90   [ [ **-i** | **\--instances** ] = *instances-file* ]
  91
  92 Collects the information about the logical volumes of the current node.
  93
  94 In order to perform this task, it needs to interact with the ``lvs`` command
  95 line tool and to connect to the ConfD daemon to fetch some configuration
  96 information. The following parameters allow the user to specify the position
  97 where the daemon is listening, in case it's not the default one:
  98
  99 -a *ip-address*, \--address=*ip-address*
 100   The IP address the ConfD daemon is listening on.
 101
 102 -p *port-number*, \--port=*port-number*
 103   The port the ConfD deamon is listening on.
 104
 105 Instead of accessing the live data on the cluster, the tool can also read data
 106 serialized on files (mainly for testing purposes). Namely:
 107
 108 -f *input-file*, \--file *input-file*
 109   The name of the file containing a recorded output of the ``lvs`` tool.
 110
 111 -i *instances-file*, \--instances=*instances-file*
 112   The name of the file containing a JSON serialization of instances the
 113   current node is primary and secondary for, listed as::
 114
 115     ([Instance], [Instance])
 116
 117   where the first list contains the instances the node is primary for, the
 118   second list those the node is secondary for.