From ea322c2790fe1bb8cd1a3660462ee81b295f0d9a Mon Sep 17 00:00:00 2001 From: Michele Tartara <mtartara@google.com> Date: Thu, 21 Feb 2013 09:30:21 +0100 Subject: [PATCH] Describe format of the monitoring agent HTTP queries The previous patch was incomplete when erroneously pushed. This patch, originally intended as part of the previous one, fixes it. Signed-off-by: Michele Tartara <mtartara@google.com> Reviewed-by: Iustin Pop <iustin@google.com> --- doc/design-monitoring-agent.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/design-monitoring-agent.rst b/doc/design-monitoring-agent.rst index 8bf691e5a..5099017c4 100644 --- a/doc/design-monitoring-agent.rst +++ b/doc/design-monitoring-agent.rst @@ -590,17 +590,22 @@ version 1. If requested through GET, the null JSON value will be returned. -``/1/full`` -+++++++++++ -The full report of all the data collectors, as described in the section +``/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. -``/[category]/[collector_name]`` -++++++++++++++++++++++++++++++++ +``/1/report/[category]/[collector_name]`` ++++++++++++++++++++++++++++++++++++++++++ Returns the report of the collector ``[collector_name]`` that belongs to the specified ``[category]``. @@ -689,7 +694,6 @@ impact functionality. The libekg library should be looked at for easily providing metrics in json format. - Implementation order -------------------- -- GitLab