From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Mon, 11 Feb 2008 11:47:18 +0000 (+0100)
Subject: exec plugin: Changed the format in which notifications are passed to the programs.
X-Git-Tag: collectd-4.3.0beta1
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=2d110844a03fcb32f39dc57af16a1134f75e1eb0;p=collectd.git

exec plugin: Changed the format in which notifications are passed to the programs.

Using a `Message:' header field restricts us to one-line messages, which is
probably not very farsighted.
---

diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod
index fe2fd630..e95fac9f 100644
--- a/src/collectd-exec.pod
+++ b/src/collectd-exec.pod
@@ -200,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.
@@ -227,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<Message>
+=item B<PluginInstance>
 
-Message of the notification. This message should be made accessible to the
-user somehow.
+=item B<Type>
+
+=item B<TypeInstance>
+
+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
 
diff --git a/src/exec.c b/src/exec.c
index ced03f29..44f03e33 100644
--- a/src/exec.c
+++ b/src/exec.c
@@ -610,10 +610,10 @@ static void *exec_notification_one (void *arg) /* {{{ */
   else if (n->severity == NOTIF_OKAY)
     severity = "OKAY";
 
-  fprintf (fh, "Severity: %s\n"
-      "Time: %u\n"
-      "Message: %s\n",
-      severity, (unsigned int) n->time, n->message);
+  fprintf (fh,
+      "Severity: %s\n"
+      "Time: %u\n",
+      severity, (unsigned int) n->time);
 
   /* Print the optional fields */
   if (strlen (n->host) > 0)
@@ -627,8 +627,7 @@ static void *exec_notification_one (void *arg) /* {{{ */
   if (strlen (n->type_instance) > 0)
     fprintf (fh, "TypeInstance: %s\n", n->type_instance);
 
-  /* Newline signalling end of data */
-  fprintf (fh, "\n");
+  fprintf (fh, "\n%s\n", n->message);
 
   fflush (fh);
   fclose (fh);