Factor out the API of the monitoring daemon
authorMichele Tartara <mtartara@google.com>
Mon, 3 Jun 2013 21:53:12 +0000 (21:53 +0000)
committerMichele Tartara <mtartara@google.com>
Tue, 4 Jun 2013 15:11:14 +0000 (11:11 -0400)
It will be included by both the design document and the user documentation.

Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Klaus Aehlig <aehlig@google.com>

doc/design-monitoring-agent.rst
doc/index.rst
doc/monitoring-query-format.rst [new file with mode: 0644]

index e21f332..8b5f05c 100644 (file)
@@ -556,57 +556,7 @@ standard enough across all systems.
 Format of the query
 -------------------
 
-The queries to the monitoring agent will be HTTP GET requests on port 1815.
-The answer will be encoded in JSON format and will depend on the specific
-accessed resource.
-
-If a request is sent to a non-existing resource, a 404 error will be returned by
-the HTTP server.
-
-The following paragraphs will present the existing resources supported by the
-current protocol version, that is version 1.
-
-``/``
-+++++
-The root resource. It will return the list of the supported protocol version
-numbers.
-
-Currently, this will include only version 1.
-
-``/1``
-++++++
-Not an actual resource per-se, it is the root of all the resources of protocol
-version 1.
-
-If requested through GET, the null JSON value will be returned.
-
-``/1/list/collectors``
-++++++++++++++++++++++
-Returns a list of tuples (kind, category, name) showing all the collectors
-available in the system.
-
-``/1/report/all``
-+++++++++++++++++
-A list of the reports of all the data collectors, as described in the section
-`Format of the report`_.
-
-`Status reporting collectors`_ will provide their output in non-verbose format.
-The verbose format can be requested by adding the parameter ``verbose=1`` to the
-request.
-
-``/1/report/[category]/[collector_name]``
-+++++++++++++++++++++++++++++++++++++++++
-Returns the report of the collector ``[collector_name]`` that belongs to the
-specified ``[category]``.
-
-The ``category`` has to be written in lowercase.
-
-If a collector does not belong to any category, ``default`` will have to be
-used as the value for ``[category]``.
-
-`Status reporting collectors`_ will provide their output in non-verbose format.
-The verbose format can be requested by adding the parameter ``verbose=1`` to the
-request.
+.. include:: monitoring-query-format.rst
 
 Instance disk status propagation
 --------------------------------
index 37629cd..72a95b1 100644 (file)
@@ -59,6 +59,7 @@ Contents:
    design-virtual-clusters.rst
    design-network.rst
    design-linuxha.rst
+   monitoring-query-format.rst
 
 Also see the :ref:`search`.
 
diff --git a/doc/monitoring-query-format.rst b/doc/monitoring-query-format.rst
new file mode 100644 (file)
index 0000000..af65fcb
--- /dev/null
@@ -0,0 +1,50 @@
+The queries to the monitoring agent will be HTTP GET requests on port 1815.
+The answer will be encoded in JSON format and will depend on the specific
+accessed resource.
+
+If a request is sent to a non-existing resource, a 404 error will be returned by
+the HTTP server.
+
+The following paragraphs will present the existing resources supported by the
+current protocol version, that is version 1.
+
+``/``
++++++
+The root resource. It will return the list of the supported protocol version
+numbers.
+
+Currently, this will include only version 1.
+
+``/1``
+++++++
+Not an actual resource per-se, it is the root of all the resources of protocol
+version 1.
+
+If requested through GET, the null JSON value will be returned.
+
+``/1/list/collectors``
+++++++++++++++++++++++
+Returns a list of tuples (kind, category, name) showing all the collectors
+available in the system.
+
+``/1/report/all``
++++++++++++++++++
+A list of the reports of all the data collectors, as a JSON list.
+
+Status reporting collectors will provide their output in non-verbose format.
+The verbose format can be requested by adding the parameter ``verbose=1`` to the
+request.
+
+``/1/report/[category]/[collector_name]``
++++++++++++++++++++++++++++++++++++++++++
+Returns the report of the collector ``[collector_name]`` that belongs to the
+specified ``[category]``.
+
+The ``category`` has to be written in lowercase.
+
+If a collector does not belong to any category, ``default`` will have to be
+used as the value for ``[category]``.
+
+Status reporting collectors will provide their output in non-verbose format.
+The verbose format can be requested by adding the parameter ``verbose=1`` to the
+request.