From: Florian Forster <octo@huhu.verplant.org>
Date: Sun, 8 Aug 2010 12:30:50 +0000 (+0200)
Subject: collectd.conf(5): Finish documenting the AMQP plugin.
X-Git-Tag: collectd-5.0.0-beta0~28^2~7
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=770c3bc953340c1d0a49571b928f82ba26d8de2b;p=collectd.git

collectd.conf(5): Finish documenting the AMQP plugin.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 25c899bd..37fe95bf 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -255,17 +255,36 @@ used to filter messages when using a "topic" exchange. If you're only
 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
 for example.
 
-=item B<Persistent>
+=item B<Persistent> B<true>|B<false> (Publish only)
+Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
+mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
+default), the I<transient> delivery mode will be used, i.e. messages may be
+lost due to high load, overflowing queues or similar issues.
 
-B<TODO!>
+=item B<Format> B<Command>|B<JSON> (Publish only)
 
-=item B<Format>
+Selects the format in which messages are sent to the broker. If set to
+B<Command> (the default), values are sent as C<PUTVAL> commands which are
+identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
+case, the C<Content-Type> header field will be set to C<text/collectd>.
 
-B<TODO!>
+If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
+an easy and straight forward exchange format. The C<Content-Type> header field
+will be set to C<application/json>.
 
-=item B<StoreRates>
+A subscribing client I<should> use the C<Content-Type> header field to
+determine how to decode the values. Currently, the I<AMQP plugin> itself can
+only decode the B<Command> format.
 
-B<TODO!>
+=item B<StoreRates> B<true>|B<false> (Publish only)
+
+Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
+are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
+default), no conversion is performed. Otherwise the conversion is performed
+using the internal value cache.
+
+Please note that currently this option is only used if the B<Format> option has
+been set to B<JSON>.
 
 =back