From: Pavel Rochnyack <pavel2000@ngs.ru>
Date: Sun, 17 Jun 2018 10:09:11 +0000 (+0700)
Subject: redis plugin: Update documentation
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=b6305bd1e78a0341f985976cebafad1203a5703d;p=collectd.git

redis plugin: Update documentation
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 6341574d..31a094d0 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -7281,9 +7281,11 @@ Defaults to B<false>.
 
 =head2 Plugin C<redis>
 
-The I<Redis plugin> connects to one or more Redis servers and gathers
-information about each server's state. For each server there is a I<Node> block
-which configures the connection parameters for this node.
+The I<Redis plugin> connects to one or more Redis servers, gathers
+information about each server's state and executes user-defined queries.
+For each server there is a I<Node> block which configures the connection
+parameters and set of user-defined queries for this node.
+Server state is requested by sending I<INFO> query.
 
   <Plugin redis>
     <Node "example">
@@ -7294,13 +7296,10 @@ which configures the connection parameters for this node.
           #Database 0
           Type "queue_length"
           Instance "myqueue"
-        <Query>
+        </Query>
     </Node>
   </Plugin>
 
-The information shown in the synopsis above is the I<default configuration>
-which is used by the plugin if no configuration is present.
-
 =over 4
 
 =item B<Node> I<Nodename>
@@ -7310,6 +7309,8 @@ running in an specified host and port. The name for node is a canonical
 identifier which is used as I<plugin instance>. It is limited to
 64E<nbsp>characters in length.
 
+When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
+
 =item B<Host> I<Hostname>
 
 The B<Host> option is the hostname or IP-address where the Redis instance is
@@ -7332,27 +7333,33 @@ 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.
 
+Defaults to 2000 (2 seconds).
+
 =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<Database> I<Index>
-
-This index selects the Redis logical database to use for query. Defaults
-to C<0>.
+There may be an arbitrary number of queries to execute. Each query should
+return single string or integer.
 
 =item B<Type> I<Collectd type>
 
-Within a query definition, a valid collectd type to use as when submitting
+Within a query definition, a valid I<collectd type> to use as when submitting
 the result of the query. When not supplied, will default to B<gauge>.
 
+Currently only types with one datasource are supported.
+See L<types.db(5)> for more details on types and their configuration.
+
 =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.
 
+=item B<Database> I<Index>
+
+This index selects the Redis logical database to use for query. Defaults
+to C<0>.
+
 =back
 
 =head2 Plugin C<rrdcached>