From: Florian Forster <octo@collectd.org>
Date: Sun, 2 Sep 2012 10:58:30 +0000 (+0200)
Subject: collectd.conf(5): Document the memcached plugin.
X-Git-Tag: collectd-5.2.0~70
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=dd8742254f3aa8fe90d49136bfe1c50558010072;p=collectd.git

collectd.conf(5): Document the memcached plugin.

The Instance blocks and Socket option were missing.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 5eb3af47..492071f4 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1964,6 +1964,17 @@ The C<memcached plugin> connects to a memcached server and queries statistics
 about cache utilization, memory and bandwidth used.
 L<http://www.danga.com/memcached/>
 
+ <Plugin "memcached">
+   <Instance "name">
+     Host "memcache.example.com"
+     Port 11211
+   </Instance>
+ </Plugin>
+
+The plugin configuration consists of one or more B<Instance> blocks which
+specify one I<memcached> connection each. Within the B<Instance> blocks, the
+following options are allowed:
+
 =over 4
 
 =item B<Host> I<Hostname>
@@ -1974,6 +1985,11 @@ Hostname to connect to. Defaults to B<127.0.0.1>.
 
 TCP-Port to connect to. Defaults to B<11211>.
 
+=item B<Socket> I<Path>
+
+Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
+setting is given, the B<Host> and B<Port> settings are ignored.
+
 =back
 
 =head2 Plugin C<modbus>