Code

write_sensu: documentation wording, wrap long lines
authorMarc Fournier <marc.fournier@camptocamp.com>
Wed, 8 Apr 2015 22:27:13 +0000 (00:27 +0200)
committerMarc Fournier <marc.fournier@camptocamp.com>
Wed, 8 Apr 2015 22:27:13 +0000 (00:27 +0200)
Thanks to @jamtur01 for reviewing !

README
src/collectd.conf.pod

diff --git a/README b/README
index 25f2d5e1f6ded2933319111198121b8a4a044c7a..ded7538dbd40636311a3fce522e9a4076f8964cd 100644 (file)
--- a/README
+++ b/README
@@ -449,7 +449,8 @@ Features
       Sends data to Riemann, a stream processing and monitoring system.
 
     - write_sensu
-      Sends data to Sensu a stream processing and monitoring system, via sensu client local TCP socket.
+      Sends data to Sensu, a stream processing and monitoring system, via the
+      Sensu client local TCP socket.
 
   * Logging is, as everything in collectd, provided by plugins. The following
     plugins keep up informed about what's going on:
index d9721cefd8e71d7052ad9b338a67147bd53287b3..12ed82b565e67821a608508aa3db93799c13f9f4 100644 (file)
@@ -7531,10 +7531,11 @@ attribute for each metric being sent out to I<Riemann>.
 
 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
-a local I<sensu> client using a TCP socket. At the moment, write_sensu plugin
-does not send over a collectd_host parameter so it not possible to use
-one collectd instance as a gateway for other collectd: each collectd host
-must write to its own sensu client.
+a local I<Sensu> client using a TCP socket.
+
+At the moment, the I<write_sensu plugin> does not send over a collectd_host
+parameter so it is not possible to use one collectd instance as a gateway for
+others. Each collectd host must pair with one I<Sensu> client.
 
 Synopsis:
 
@@ -7562,7 +7563,7 @@ The following options are understood by the I<write_sensu plugin>:
 
 The plugin's configuration consists of one or more B<Node> blocks. Each block
 is given a unique I<Name> and specifies one connection to an instance of
-I<Sensu>. Indise the B<Node> block, the following per-connection options are
+I<Sensu>. Inside the B<Node> block, the following per-connection options are
 understood:
 
 =over 4
@@ -7580,9 +7581,9 @@ Service name or port number to connect to. Defaults to C<3030>.
 If set to B<true> (the default), convert counter values to rates. If set to
 B<false> counter values are stored as is, i.e. as an increasing integer number.
 
-This will be reflected in the C<collectd_data_source_type> tag: If B<StoreRates> is enabled,
-converted values will have "rate" appended to the data source type, e.g.
-C<collectd_data_source_type:derive:rate>.
+This will be reflected in the C<collectd_data_source_type> tag: If
+B<StoreRates> is enabled, converted values will have "rate" appended to the
+data source type, e.g.  C<collectd_data_source_type:derive:rate>.
 
 =item B<AlwaysAppendDS> B<false>|B<true>
 
@@ -7593,12 +7594,12 @@ only done when there is more than one DS.
 
 =item B<Notifications> B<false>|B<true>
 
-If set to B<true>, create sensu events for notifications. This is B<false>
+If set to B<true>, create I<Sensu> events for notifications. This is B<false>
 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
 
 =item B<Metrics> B<false>|B<true>
 
-If set to B<true>, create sensu events for metrics. This is B<false>
+If set to B<true>, create I<Sensu> events for metrics. This is B<false>
 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
 
 
@@ -7613,8 +7614,8 @@ several of them, one per line. Defaults to no handler.
 
 =item B<NotificationHandler> I<String>
 
-Add a handler that will be set when notifications are sent to I<Sensu>. You can add
-several of them, one per line. Defaults to no handler.
+Add a handler that will be set when notifications are sent to I<Sensu>. You can
+add several of them, one per line. Defaults to no handler.
 
 =item B<EventServicePrefix> I<String>