Revision 2fa8f963

b/INSTALL
163 163

  
164 164
Optionally, more functionality can be enabled if your build machine has
165 165
a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
166
(``--enable-confd``) and the monitoring agent
167
(``--enable-monitoring``). The list of extra dependencies for these is:
166
(``--enable-confd``) and the monitoring daemon
167
(``--enable-mond``). The list of extra dependencies for these is:
168 168

  
169 169
- `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
170 170
  above (note that Debian Squeeze only has version 1.0.9)
......
177 177
  bindings for the ``pcre`` library
178 178
- `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
179 179
- `vector <http://hackage.haskell.org/package/vector>`_
180
- `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
181
  0.8.1 and above.
180 182

  
181 183
These libraries are available in Debian Wheezy (but not in Squeeze, with
182 184
the exception of curl), so you can use either apt::
183 185

  
184 186
  $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
185 187
                    libghc-hinotify-dev libghc-regex-pcre-dev \
186
                    libghc-attoparsec-dev libghc-vector-dev
188
                    libghc-attoparsec-dev libghc-vector-dev \
189
                    libghc-snap-server-dev
187 190

  
188 191
or ``cabal``::
189 192

  
190 193
  $ cabal install hslogger Crypto text hinotify regex-pcre \
191
                  attoparsec vector
194
                  attoparsec vector snap-server
192 195

  
193 196
to install them.
194 197

  
198
In case you still use ghc-6.12, note that ``cabal`` would automatically try to
199
install newer versions of some of the libraries snap-server depends on, that
200
cannot be compiled with ghc-6.12, so you have to install snap-server on its
201
own, esplicitly forcing the installation of compatible versions::
202

  
203
  $ cabal install MonadCatchIO-transformers==0.2.2.0 mtl==2.0.1.0 \
204
                  hashable==1.1.2.0 case-insensitive==0.3 parsec==3.0.1 \
205
                  network==2.3 snap-server==0.8.1
206

  
195 207
The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
196 208
need to be installed using ``cabal``, if desired. The other packages can
197 209
be installed via ``yum``::
b/man/ganeti-mond.rst
6 6

  
7 7
ganeti-mond - Ganeti monitoring daemon
8 8

  
9
Synopsis
10
--------
11

  
12
**ganeti-mond** [-d] [-f] [--no-user-checks] [-p PORT]
13

  
14
DESCRIPTION
15
-----------
16

  
17
**ganeti-mond** is the daemon providing the Ganeti monitoring
18
functionality. It is responsible for running the data collectors and to
19
provide the collected information through a HTTP interface.
20

  
21
For testing purposes, you can give the ``-f`` option and the
22
program won't detach from the running terminal.
23

  
24
Debug-level message can be activated by giving the ``-d`` option.
25

  
26
The **ganeti-mond** daemon listens to port 1815 TCP, on all interfaces,
27
by default. The port can be overridden by an entry the services database
28
by passing the ``-p`` option.
29
The daemon will refuse to start if the user and group do not match the
30
one defined at build time; this behaviour can be overridden by the
31
``--no-user-checks`` option.
32

  
33
COMMUNICATION PROTOCOL
34
~~~~~~~~~~~~~~~~~~~~~~
35

  
36
The queries to the monitoring agent will be HTTP GET requests on port 1815.
37
The answer will be encoded in JSON format and will depend on the specific
38
accessed resource.
39

  
40
If a request is sent to a non-existing resource, a 404 error will be returned by
41
the HTTP server.
42

  
43
``/``
44
+++++
45
The root resource. It will return the list of the supported protocol version
46
numbers.
47

  
48
``/1/list/collectors``
49
++++++++++++++++++++++
50
Returns a list of tuples (kind, category, name) showing all the collectors
51
available in the system.
52

  
53
``/1/report/all``
54
+++++++++++++++++
55
A list of the reports of all the data collectors, as described in the section
56
`Format of the report`_.
57

  
58
`Status reporting collectors`_ will provide their output in non-verbose format.
59
The verbose format can be requested by adding the parameter ``verbose=1`` to the
60
request.
61

  
62
``/1/report/[category]/[collector_name]``
63
+++++++++++++++++++++++++++++++++++++++++
64
Returns the report of the collector ``[collector_name]`` that belongs to the
65
specified ``[category]``.
66

  
67
If a collector does not belong to any category, ``collector`` will be used as
68
the value for ``[category]``.
69

  
70
`Status reporting collectors`_ will provide their output in non-verbose format.
71
The verbose format can be requested by adding the parameter ``verbose=1`` to the
72
request.
73

  
74
Further information can be found in the Ganeti Monitoring Agent
75
design document.
76

  
9 77
.. vim: set textwidth=72 :
10 78
.. Local Variables:
11 79
.. mode: rst

Also available in: Unified diff