Statistics
| Branch: | Tag: | Revision:

root / doc / monitoring-query-format.rst @ 333bd799

History | View | Annotate | Download (1.6 kB)

1
The queries to the monitoring agent will be HTTP GET requests on port 1815.
2
The answer will be encoded in JSON format and will depend on the specific
3
accessed resource.
4

    
5
If a request is sent to a non-existing resource, a 404 error will be returned by
6
the HTTP server.
7

    
8
The following paragraphs will present the existing resources supported by the
9
current protocol version, that is version 1.
10

    
11
``/``
12
+++++
13
The root resource. It will return the list of the supported protocol version
14
numbers.
15

    
16
Currently, this will include only version 1.
17

    
18
``/1``
19
++++++
20
Not an actual resource per-se, it is the root of all the resources of protocol
21
version 1.
22

    
23
If requested through GET, the null JSON value will be returned.
24

    
25
``/1/list/collectors``
26
++++++++++++++++++++++
27
Returns a list of tuples (kind, category, name) showing all the collectors
28
available in the system.
29

    
30
``/1/report/all``
31
+++++++++++++++++
32
A list of the reports of all the data collectors, as a JSON list.
33

    
34
Status reporting collectors will provide their output in non-verbose format.
35
The verbose format can be requested by adding the parameter ``verbose=1`` to the
36
request.
37

    
38
``/1/report/[category]/[collector_name]``
39
+++++++++++++++++++++++++++++++++++++++++
40
Returns the report of the collector ``[collector_name]`` that belongs to the
41
specified ``[category]``.
42

    
43
The ``category`` has to be written in lowercase.
44

    
45
If a collector does not belong to any category, ``default`` will have to be
46
used as the value for ``[category]``.
47

    
48
Status reporting collectors will provide their output in non-verbose format.
49
The verbose format can be requested by adding the parameter ``verbose=1`` to the
50
request.