From fe3dc1b1d500cf1593009ef70487c3eb29cec57f Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Tue, 10 Aug 2010 11:18:42 +0200 Subject: [PATCH] collectd.conf(5): Improve the "Redis plugin" documentation a bit. --- src/collectd.conf.pod | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 4541870b..f16ebb1e 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -3753,13 +3753,12 @@ Defaults to B. =head2 Plugin C -The C plugin connect to a list of redis servers and gather -information about the server state. The C plugin support multiserver -configuration, each server configuration block is called node and identify -one redis instance (host and port). Here is a configuration example code: +The I connects to one or more Redis servers and gathers +information about each server's state. For each server there is a I block +which configures the connection parameters for this node. - + Host "localhost" Port "6379" Timeout 2000 @@ -3770,26 +3769,27 @@ one redis instance (host and port). Here is a configuration example code: =item B I -The B block identify a new redis node, that is a new redis instance -running in an specified host and port, the name for node is a canonical -identifier which is used as plugin instance, it's limited to 64 characters -length. +The B block identifies a new Redis node, that is a new Redis instance +running in an specified host and port. The name for node is a canonical +identifier which is used as I. It is limited to +64Echaracters in length. =item B I -The B option is the hostname or IP address (setting as string) where -redis instance is running on. +The B option is the hostname or IP-address where the Redis instance is +running on. =item B I -The B option is the TCP port where redis instance in IP address or -hostname setted in B option is running. +The B option is the TCP port on which the Redis instance accepts +connections. Either a service name of a port number may be given. Please note +that numerical port numbers must be given as a string, too. =item B I -The B option set the socket timeout for node response. Since the -redis read function is blocking, you may keep this value as low as possible. -Keep in mind that the sum of all Timeout values for all Nodes might be lower +The B option set the socket timeout for node response. Since the Redis +read function is blocking, you should keep this value as low as possible. Keep +in mind that the sum of all B values for all B should be lower than B defined globally. =back -- 2.11.0