Improve monitoring agent design document
authorMichele Tartara <mtartara@google.com>
Thu, 28 Mar 2013 09:13:08 +0000 (09:13 +0000)
committerMichele Tartara <mtartara@google.com>
Tue, 30 Apr 2013 07:55:19 +0000 (09:55 +0200)
Specify more precisely the format of the category names.

Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Helga Velroyen <helgav@google.com>

doc/design-monitoring-agent.rst

index 9957ac2..cdc80ae 100644 (file)
@@ -610,8 +610,10 @@ request.
 Returns the report of the collector ``[collector_name]`` that belongs to the
 specified ``[category]``.
 
-If a collector does not belong to any category, ``collector`` will be used as
-the value for ``[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