From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Sat, 6 Nov 2010 11:26:39 +0000 (+0100)
Subject: collectd.conf(5): Improve the documentation on the ZeroMQ plugin.
X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=c36dd28b622eb08aed3c9020d982a5989246d4f5

collectd.conf(5): Improve the documentation on the ZeroMQ plugin.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 5e48e492..d8eba29f 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -4697,33 +4697,6 @@ traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
 collect on-wire traffic you could, for example, use the logging facilities of
 iptables to feed data for the guest IPs into the iptables plugin.
 
-=head2 Plugin C<zeromq>
-
-This plugin acts as an alternative to the network plugin (you could also use both)
-the protocol used is the same as the network plugin but it uses zeromq as the
-transport layer with can brings interesting features like:
-- reliable communication (packets can be queued until network connection is
-  available again and dropped packets will be sent again)
-- protocol choice, zeromq can use tcp, pgm, ipc an inproc, check the zeromq
-  documentation for more informations on each one
-
-Synopsis:
-
-  <Plugin zeromq>
-    SendDataTo "tcp://localhost:6666"
-    ListenOn "tcp://*:6666"
-  </Plugin>
-
-=over 4
-
-=item B<SendDataTo> I<socket>
-
-Optional socket to send data to
-
-=item B<ListenOn> I<socket>
-
-Optional socket to listen on
-
 =head2 Plugin C<write_http>
 
 This output plugin submits values to an http server by POST them using the
@@ -4788,6 +4761,47 @@ number.
 
 =back
 
+=head2 Plugin C<zeromq>
+
+This plugin acts as an alternative to the I<Network plugin> (you could also use
+both). The protocol used is the same binary protocol used by the network
+plugin, but this plugin uses the ZeroMQ communication library with can brings
+interesting features like:
+
+=over 4
+
+=item
+
+Reliable communication: Packets can be queued until network connection is
+available again and dropped packets will be sent again.
+
+=item
+
+Protocol choice: ZeroMQ can use the TCP, PGM, IPC and "inproc" communication
+transports. Check the ZeroMQ documentation for more information on each
+transport.
+
+=back
+
+Synopsis:
+
+  <Plugin "zeromq">
+    SendDataTo "tcp://localhost:6666"
+    ListenOn "tcp://*:6666"
+  </Plugin>
+
+=over 4
+
+=item B<SendDataTo> I<socket>
+
+Optional socket to send data to
+
+=item B<ListenOn> I<socket>
+
+Optional socket to listen on
+
+=back
+
 =head1 THRESHOLD CONFIGURATION
 
 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that