From: Pierre-Yves Ritschard <pyr@spootnik.org>
Date: Thu, 20 Nov 2014 12:29:44 +0000 (+0100)
Subject: Add documentation bits.
X-Git-Tag: collectd-5.5.0~129^2
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=14b2132d678efb03775a64722eaac0112af17d49;p=collectd.git

Add documentation bits.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 03871a4b..eb94fa37 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -5333,6 +5333,10 @@ which configures the connection parameters for this node.
         Host "localhost"
         Port "6379"
         Timeout 2000
+        <Query "LLEN myqueue">
+          Type "queue_length"
+          Instance "myqueue"
+        <Query>
     </Node>
   </Plugin>
 
@@ -5370,6 +5374,22 @@ read function is blocking, you should keep this value as low as possible. Keep
 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
 than B<Interval> defined globally.
 
+=item B<Query> I<Querystring>
+
+The B<Query> block identifies a query to execute against the redis server.
+There may be an arbitrary number of queries to execute.
+
+=item B<Type> I<Collectd type>
+
+Within a query definition, a valid collectd type to use as when submitting
+the result of the query. When not supplied, will default to B<gauge>.
+
+=item B<Instance> I<Type instance>
+
+Within a query definition, an optional type instance to use when submitting
+the result of the query. When not supplied will default to the escaped
+command, up to 64 chars.
+
 =back
 
 =head2 Plugin C<rrdcached>