Revision b166dcfc

b/doc/design-monitoring-agent.rst
48 48
- Node OS resources report (memory, CPU, network interfaces)
49 49
- Information from a plugin system
50 50

  
51
Format of the query
52
-------------------
53

  
54
The query will be an HTTP GET request on a particular port. At the
55
beginning it will only be possible to query the full status report.
56

  
57 51
Format of the report
58 52
--------------------
59 53

  
......
569 563
plugin) but we can easily just report the information above, since it's
570 564
standard enough across all systems.
571 565

  
566
Format of the query
567
-------------------
568

  
569
The queries to the monitoring agent will be HTTP GET requests on port 1815.
570
The answer will be encoded in JSON format and will depend on the specific
571
accessed resource.
572

  
573
If a request is sent to a non-existing resource, a 404 error will be returned by
574
the HTTP server.
575

  
576
The following paragraphs will present the existing resources supported by the
577
current protocol version, that is version 1.
578

  
579
``/``
580
+++++
581
The root resource. It will return the list of the supported protocol version
582
numbers.
583

  
584
Currently, this will include only version 1.
585

  
586
``/1``
587
++++++
588
Not an actual resource per-se, it is the root of all the resources of protocol
589
version 1.
590

  
591
If requested through GET, the null JSON value will be returned.
592

  
593
``/1/full``
594
+++++++++++
595
The full report of all the data collectors, as described in the section
596
`Format of the report`_.
597

  
598
`Status reporting collectors`_ will provide their output in non-verbose format.
599
The verbose format can be requested by adding the parameter ``verbose=1`` to the
600
request.
601

  
602
``/[category]/[collector_name]``
603
++++++++++++++++++++++++++++++++
604
Returns the report of the collector ``[collector_name]`` that belongs to the
605
specified ``[category]``.
606

  
607
If a collector does not belong to any category, ``collector`` will be used as
608
the value for ``[category]``.
609

  
610
`Status reporting collectors`_ will provide their output in non-verbose format.
611
The verbose format can be requested by adding the parameter ``verbose=1`` to the
612
request.
613

  
572 614
Instance disk status propagation
573 615
--------------------------------
574 616

  

Also available in: Unified diff