Revision 431ff2c1
| b/doc/design-monitoring-agent.rst | ||
|---|---|---|
| 556 | 556 |
Format of the query |
| 557 | 557 |
------------------- |
| 558 | 558 |
|
| 559 |
The queries to the monitoring agent will be HTTP GET requests on port 1815. |
|
| 560 |
The answer will be encoded in JSON format and will depend on the specific |
|
| 561 |
accessed resource. |
|
| 562 |
|
|
| 563 |
If a request is sent to a non-existing resource, a 404 error will be returned by |
|
| 564 |
the HTTP server. |
|
| 565 |
|
|
| 566 |
The following paragraphs will present the existing resources supported by the |
|
| 567 |
current protocol version, that is version 1. |
|
| 568 |
|
|
| 569 |
``/`` |
|
| 570 |
+++++ |
|
| 571 |
The root resource. It will return the list of the supported protocol version |
|
| 572 |
numbers. |
|
| 573 |
|
|
| 574 |
Currently, this will include only version 1. |
|
| 575 |
|
|
| 576 |
``/1`` |
|
| 577 |
++++++ |
|
| 578 |
Not an actual resource per-se, it is the root of all the resources of protocol |
|
| 579 |
version 1. |
|
| 580 |
|
|
| 581 |
If requested through GET, the null JSON value will be returned. |
|
| 582 |
|
|
| 583 |
``/1/list/collectors`` |
|
| 584 |
++++++++++++++++++++++ |
|
| 585 |
Returns a list of tuples (kind, category, name) showing all the collectors |
|
| 586 |
available in the system. |
|
| 587 |
|
|
| 588 |
``/1/report/all`` |
|
| 589 |
+++++++++++++++++ |
|
| 590 |
A list of the reports of all the data collectors, as described in the section |
|
| 591 |
`Format of the report`_. |
|
| 592 |
|
|
| 593 |
`Status reporting collectors`_ will provide their output in non-verbose format. |
|
| 594 |
The verbose format can be requested by adding the parameter ``verbose=1`` to the |
|
| 595 |
request. |
|
| 596 |
|
|
| 597 |
``/1/report/[category]/[collector_name]`` |
|
| 598 |
+++++++++++++++++++++++++++++++++++++++++ |
|
| 599 |
Returns the report of the collector ``[collector_name]`` that belongs to the |
|
| 600 |
specified ``[category]``. |
|
| 601 |
|
|
| 602 |
The ``category`` has to be written in lowercase. |
|
| 603 |
|
|
| 604 |
If a collector does not belong to any category, ``default`` will have to be |
|
| 605 |
used as the value for ``[category]``. |
|
| 606 |
|
|
| 607 |
`Status reporting collectors`_ will provide their output in non-verbose format. |
|
| 608 |
The verbose format can be requested by adding the parameter ``verbose=1`` to the |
|
| 609 |
request. |
|
| 559 |
.. include:: monitoring-query-format.rst |
|
| 610 | 560 |
|
| 611 | 561 |
Instance disk status propagation |
| 612 | 562 |
-------------------------------- |
| b/doc/index.rst | ||
|---|---|---|
| 59 | 59 |
design-virtual-clusters.rst |
| 60 | 60 |
design-network.rst |
| 61 | 61 |
design-linuxha.rst |
| 62 |
monitoring-query-format.rst |
|
| 62 | 63 |
|
| 63 | 64 |
Also see the :ref:`search`. |
| 64 | 65 |
|
| b/doc/monitoring-query-format.rst | ||
|---|---|---|
| 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. |
|
Also available in: Unified diff