X-Git-Url: https://git.octo.it/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcollectd-exec.pod;h=e95fac9f8de1a12508f8249558f26f8692313df0;hb=6b56d7219b34fe22ea80a5c8a570a1856f25a2c2;hp=fee83fb3d133126b85f93c88b001bb35a5036620;hpb=f4a528f0bc857a568cca1c1af589da8625b19e09;p=collectd.git

diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod
index fee83fb3..e95fac9f 100644
--- a/src/collectd-exec.pod
+++ b/src/collectd-exec.pod
@@ -11,22 +11,20 @@ collectd-exec - Documentation of collectd's C<exec plugin>
     Exec "myuser:mygroup" "myprog"
     Exec "otheruser" "/path/to/another/binary" "arg0" "arg1"
     NotificationExec "user" "/usr/lib/collectd/exec/handle_notification"
-    NagiosExec "nagios:nagios" "/usr/lib/nagios/plugins/check_something"
   </Plugin>
 
 =head1 DESCRIPTION
 
-The C<exec plugin> forks of an executable either to receive values, to dispatch
-notifications to the outside world or to be able to use Nagios plugins. The
-syntax of the configuration is explained in L<collectd.conf(5)> but summarized
-in the above synopsis.
+The C<exec plugin> forks of an executable either to receive values or to
+dispatch notifications to the outside world. The syntax of the configuration is
+explained in L<collectd.conf(5)> but summarized in the above synopsis.
 
 If you want/need better performance or more functionality you should take a
 long look at the C<perl plugin>, L<collectd-perl(5)>.
 
 =head1 EXECUTABLE TYPES
 
-There are currently three types of executables that can be executed by the
+There are currently two types of executables that can be executed by the
 C<exec plugin>:
 
 =over 4
@@ -57,6 +55,8 @@ run at once if multiple notifications are received.
 See L<NOTIFICATION DATA FORMAT> below for a description of the data passed to
 these programs.
 
+=begin comment
+
 =item C<NagiosExec>
 
 The executable is treated as a Nagios plugin. That means that the first line
@@ -68,6 +68,8 @@ For information on how to write Nagios plugins please refer to the Nagios
 documentation. If a plugin works with Nagios but not with collectd please
 complain on the collectd mailing list instead.
 
+=end comment
+
 =back
 
 =head1 EXEC DATA FORMAT
@@ -77,14 +79,14 @@ format is as follows:
 
 =over 4
 
-=item
+=item Comments
 
 Each line beginning with a C<#> (hash mark) is ignored.
 
-=item
+=item B<PUTVAL> I<Identifier> [I<OptionList>] I<Valuelist>
 
-Other lines must consist of an I<Identifier>, an optional I<Option-List> and a
-I<Value-List>, separated by a spaces. A description of these two parts follows:
+Submits one or more values (identified by I<Identifier>, see below) to the
+daemon which will dispatch it to all it's write-plugins.
 
 An I<Identifier> is of the form
 C<I<host>B</>I<plugin>B<->I<instance>B</>I<type>B<->I<instance>> with both
@@ -131,6 +133,62 @@ Since examples usually let one understand a lot better, here are some:
   leeloo/cpu-0/cpu-idle N:2299366
   alice/interface/if_octets-eth0 interval=10 1180647081:421465:479194
 
+Since this action was the only one supported with older versions of the C<exec
+plugin> all lines were treated as if they were prefixed with B<PUTVAL>. This is
+still the case to maintain backwards compatibility but deprecated.
+
+=item B<PUTNOTIF> [I<OptionList>] B<message=>I<Message>
+
+Submits a notification to the daemon which will then dispatch it to all plugins
+which have registered for receiving notifications. 
+
+The B<PUTNOTIF> if followed by a list of options which further describe the
+notification. The B<message> option is special in that it will consume the rest
+of the line as its value. The B<message>, B<severity>, and B<time> options are
+mandatory.
+
+Valid options are:
+
+=over 4
+
+=item B<message=>I<Message> (B<REQUIRED>)
+
+Sets the message of the notification. This is the message that will be made
+accessible to the user, so it should contain some useful information. This
+option must be the last option because the rest of the line will be its value,
+even if there are spaces and equal-signs following it! This option is
+mandatory.
+
+=item B<severity=failure>|B<warning>|B<okay> (B<REQUIRED>)
+
+Sets the severity of the notification. This option is mandatory.
+
+=item B<time=>I<Time> (B<REQUIRED>)
+
+Sets the time of the notification. The time is given as "epoch", i.E<nbsp>e. as
+seconds since January 1st, 1970, 00:00:00. This option is mandatory.
+
+=item B<host=>I<Hostname>
+
+=item B<plugin=>I<Plugin>
+
+=item B<plugin_instance=>I<Plugin-Instance>
+
+=item B<type=>I<Type>
+
+=item B<type_instance=>I<Type-Instance>
+
+These "associative" options establish a relation between this notification and
+collected performance data. This connection is purely informal, i.E<nbsp>e. the
+daemon itself doesn't do anything with this information. However, websites or
+GUIs may use this information to place notifications near the affected graph or
+table. All the options are optional, but B<plugin_instance> without B<plugin>
+or B<type_instance> without B<type> doesn't make much sense and should be
+avoided.
+
+Please note that this is the same format as used in the B<unixsock plugin>, see
+L<collectd-unixsock(5)>.
+
 =back
 
 When collectd exits it sends a B<SIGTERM> to all still running
@@ -142,17 +200,19 @@ The notification executables receive values rather than providing them. In
 fact, after the program is started C<STDOUT> is connected to C</dev/null>.
 
 The data is passed to the executables over C<STDIN> in a format very similar to
-HTTP-headers: There is one line per field. Every line consists of a field name,
-ended by a colon, and the associated value until end-of-line. The input is
-ended by two newlines immediately following another.
+HTTP: At first there is a "header" with one line per field. Every line consists
+of a field name, ended by a colon, and the associated value until end-of-line.
+The "header" is ended by two newlines immediately following another,
+i.E<nbsp>e. an empty line. The rest, basically the "body", is the message of
+the notification.
 
 The following is an example notification passed to a program:
 
   Severity: FAILURE
   Time: 1200928930
   Host: myhost.mydomain.org
-  Message: This is a test notification to demonstrate the format
-  <newline>
+  \n
+  This is a test notification to demonstrate the format
 
 The following header files are currently used. Please note, however, that you
 should ignore unknown header files to be as forward-compatible as possible.
@@ -169,12 +229,17 @@ The time in epoch, i.E<nbsp>e. as seconds since 1970-01-01 00:00:00 UTC.
 
 =item B<Host>
 
-Name of the host concerned.
+=item B<Plugin>
+
+=item B<PluginInstance>
+
+=item B<Type>
 
-=item B<Message>
+=item B<TypeInstance>
 
-Message of the notification. This message should be made accessible to the
-user somehow.
+Identification of the performance data this notification is associated with.
+All of these fields are optional because notifications do not B<need> to be
+associated with a certain value.
 
 =back