Statistics
| Branch: | Tag: | Revision:

root / man / ganeti-mond.rst @ 560ef132

History | View | Annotate | Download (2.5 kB)

1 13cc7b84 Michele Tartara
ganeti-mond(8) Ganeti | Version @GANETI_VERSION@
2 13cc7b84 Michele Tartara
=================================================
3 13cc7b84 Michele Tartara
4 13cc7b84 Michele Tartara
Name
5 13cc7b84 Michele Tartara
----
6 13cc7b84 Michele Tartara
7 13cc7b84 Michele Tartara
ganeti-mond - Ganeti monitoring daemon
8 13cc7b84 Michele Tartara
9 2fa8f963 Michele Tartara
Synopsis
10 2fa8f963 Michele Tartara
--------
11 2fa8f963 Michele Tartara
12 2fa8f963 Michele Tartara
**ganeti-mond** [-d] [-f] [--no-user-checks] [-p PORT]
13 2fa8f963 Michele Tartara
14 2fa8f963 Michele Tartara
DESCRIPTION
15 2fa8f963 Michele Tartara
-----------
16 2fa8f963 Michele Tartara
17 2fa8f963 Michele Tartara
**ganeti-mond** is the daemon providing the Ganeti monitoring
18 2fa8f963 Michele Tartara
functionality. It is responsible for running the data collectors and to
19 2fa8f963 Michele Tartara
provide the collected information through a HTTP interface.
20 2fa8f963 Michele Tartara
21 2fa8f963 Michele Tartara
For testing purposes, you can give the ``-f`` option and the
22 2fa8f963 Michele Tartara
program won't detach from the running terminal.
23 2fa8f963 Michele Tartara
24 2fa8f963 Michele Tartara
Debug-level message can be activated by giving the ``-d`` option.
25 2fa8f963 Michele Tartara
26 2fa8f963 Michele Tartara
The **ganeti-mond** daemon listens to port 1815 TCP, on all interfaces,
27 2fa8f963 Michele Tartara
by default. The port can be overridden by an entry the services database
28 2fa8f963 Michele Tartara
by passing the ``-p`` option.
29 c82166a2 Petr Pudlak
The ``-b`` option can be used to specify the address to bind to
30 c82166a2 Petr Pudlak
(defaults to ``0.0.0.0``).
31 2fa8f963 Michele Tartara
The daemon will refuse to start if the user and group do not match the
32 2fa8f963 Michele Tartara
one defined at build time; this behaviour can be overridden by the
33 2fa8f963 Michele Tartara
``--no-user-checks`` option.
34 2fa8f963 Michele Tartara
35 2fa8f963 Michele Tartara
COMMUNICATION PROTOCOL
36 2fa8f963 Michele Tartara
~~~~~~~~~~~~~~~~~~~~~~
37 2fa8f963 Michele Tartara
38 2fa8f963 Michele Tartara
The queries to the monitoring agent will be HTTP GET requests on port 1815.
39 2fa8f963 Michele Tartara
The answer will be encoded in JSON format and will depend on the specific
40 2fa8f963 Michele Tartara
accessed resource.
41 2fa8f963 Michele Tartara
42 2fa8f963 Michele Tartara
If a request is sent to a non-existing resource, a 404 error will be returned by
43 2fa8f963 Michele Tartara
the HTTP server.
44 2fa8f963 Michele Tartara
45 2fa8f963 Michele Tartara
``/``
46 2fa8f963 Michele Tartara
+++++
47 2fa8f963 Michele Tartara
The root resource. It will return the list of the supported protocol version
48 2fa8f963 Michele Tartara
numbers.
49 2fa8f963 Michele Tartara
50 2fa8f963 Michele Tartara
``/1/list/collectors``
51 2fa8f963 Michele Tartara
++++++++++++++++++++++
52 2fa8f963 Michele Tartara
Returns a list of tuples (kind, category, name) showing all the collectors
53 2fa8f963 Michele Tartara
available in the system.
54 2fa8f963 Michele Tartara
55 2fa8f963 Michele Tartara
``/1/report/all``
56 2fa8f963 Michele Tartara
+++++++++++++++++
57 011a19bf Michele Tartara
A list of the reports of all the data collectors.
58 2fa8f963 Michele Tartara
59 011a19bf Michele Tartara
`Status reporting collectors` will provide their output in non-verbose format.
60 2fa8f963 Michele Tartara
The verbose format can be requested by adding the parameter ``verbose=1`` to the
61 2fa8f963 Michele Tartara
request.
62 2fa8f963 Michele Tartara
63 2fa8f963 Michele Tartara
``/1/report/[category]/[collector_name]``
64 2fa8f963 Michele Tartara
+++++++++++++++++++++++++++++++++++++++++
65 2fa8f963 Michele Tartara
Returns the report of the collector ``[collector_name]`` that belongs to the
66 2fa8f963 Michele Tartara
specified ``[category]``.
67 2fa8f963 Michele Tartara
68 2fa8f963 Michele Tartara
If a collector does not belong to any category, ``collector`` will be used as
69 2fa8f963 Michele Tartara
the value for ``[category]``.
70 2fa8f963 Michele Tartara
71 011a19bf Michele Tartara
`Status reporting collectors` will provide their output in non-verbose format.
72 2fa8f963 Michele Tartara
The verbose format can be requested by adding the parameter ``verbose=1`` to the
73 2fa8f963 Michele Tartara
request.
74 2fa8f963 Michele Tartara
75 2fa8f963 Michele Tartara
Further information can be found in the Ganeti Monitoring Agent
76 2fa8f963 Michele Tartara
design document.
77 2fa8f963 Michele Tartara
78 13cc7b84 Michele Tartara
.. vim: set textwidth=72 :
79 13cc7b84 Michele Tartara
.. Local Variables:
80 13cc7b84 Michele Tartara
.. mode: rst
81 13cc7b84 Michele Tartara
.. fill-column: 72
82 13cc7b84 Michele Tartara
.. End: