Statistics
| Branch: | Tag: | Revision:

root / doc / monitoring-query-format.rst @ 56c934da

History | View | Annotate | Download (1.6 kB)

1 431ff2c1 Michele Tartara
The queries to the monitoring agent will be HTTP GET requests on port 1815.
2 431ff2c1 Michele Tartara
The answer will be encoded in JSON format and will depend on the specific
3 431ff2c1 Michele Tartara
accessed resource.
4 431ff2c1 Michele Tartara
5 431ff2c1 Michele Tartara
If a request is sent to a non-existing resource, a 404 error will be returned by
6 431ff2c1 Michele Tartara
the HTTP server.
7 431ff2c1 Michele Tartara
8 431ff2c1 Michele Tartara
The following paragraphs will present the existing resources supported by the
9 431ff2c1 Michele Tartara
current protocol version, that is version 1.
10 431ff2c1 Michele Tartara
11 431ff2c1 Michele Tartara
``/``
12 431ff2c1 Michele Tartara
+++++
13 431ff2c1 Michele Tartara
The root resource. It will return the list of the supported protocol version
14 431ff2c1 Michele Tartara
numbers.
15 431ff2c1 Michele Tartara
16 431ff2c1 Michele Tartara
Currently, this will include only version 1.
17 431ff2c1 Michele Tartara
18 431ff2c1 Michele Tartara
``/1``
19 431ff2c1 Michele Tartara
++++++
20 431ff2c1 Michele Tartara
Not an actual resource per-se, it is the root of all the resources of protocol
21 431ff2c1 Michele Tartara
version 1.
22 431ff2c1 Michele Tartara
23 431ff2c1 Michele Tartara
If requested through GET, the null JSON value will be returned.
24 431ff2c1 Michele Tartara
25 431ff2c1 Michele Tartara
``/1/list/collectors``
26 431ff2c1 Michele Tartara
++++++++++++++++++++++
27 431ff2c1 Michele Tartara
Returns a list of tuples (kind, category, name) showing all the collectors
28 431ff2c1 Michele Tartara
available in the system.
29 431ff2c1 Michele Tartara
30 431ff2c1 Michele Tartara
``/1/report/all``
31 431ff2c1 Michele Tartara
+++++++++++++++++
32 431ff2c1 Michele Tartara
A list of the reports of all the data collectors, as a JSON list.
33 431ff2c1 Michele Tartara
34 431ff2c1 Michele Tartara
Status reporting collectors will provide their output in non-verbose format.
35 431ff2c1 Michele Tartara
The verbose format can be requested by adding the parameter ``verbose=1`` to the
36 431ff2c1 Michele Tartara
request.
37 431ff2c1 Michele Tartara
38 431ff2c1 Michele Tartara
``/1/report/[category]/[collector_name]``
39 431ff2c1 Michele Tartara
+++++++++++++++++++++++++++++++++++++++++
40 431ff2c1 Michele Tartara
Returns the report of the collector ``[collector_name]`` that belongs to the
41 431ff2c1 Michele Tartara
specified ``[category]``.
42 431ff2c1 Michele Tartara
43 431ff2c1 Michele Tartara
The ``category`` has to be written in lowercase.
44 431ff2c1 Michele Tartara
45 431ff2c1 Michele Tartara
If a collector does not belong to any category, ``default`` will have to be
46 431ff2c1 Michele Tartara
used as the value for ``[category]``.
47 431ff2c1 Michele Tartara
48 431ff2c1 Michele Tartara
Status reporting collectors will provide their output in non-verbose format.
49 431ff2c1 Michele Tartara
The verbose format can be requested by adding the parameter ``verbose=1`` to the
50 431ff2c1 Michele Tartara
request.