[doc] Added documentation for adding of meta information using PUTNOTIF
authorJohn-John Tedro <johnjohn.tedro@gmail.com>
Sun, 29 Sep 2013 16:48:52 +0000 (16:48 +0000)
committerJohn-John Tedro <johnjohn.tedro@gmail.com>
Sun, 29 Sep 2013 16:48:52 +0000 (16:48 +0000)
src/collectd-exec.pod
src/collectd-unixsock.pod

index 2c59630..41f967e 100644 (file)
@@ -169,6 +169,19 @@ 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.
 
+=item B<type:key=>I<value>
+
+Sets user defined meta information. The B<type> key is a single character
+defining the type of the meta information.
+
+The current supported types are:
+
+=over 8
+
+=item B<s> A string passed as-is.
+
+=back
+
 =back
 
 =back
index 40626d3..7cc6e70 100644 (file)
@@ -176,11 +176,24 @@ 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<exec plugin>, see
-L<collectd-exec(5)>.
+=item B<type:key=>I<value>
+
+Sets user defined meta information. The B<type> key is a single character
+defining the type of the meta information.
+
+The current supported types are:
+
+=over 8
+
+=item B<s> A string passed as-is.
 
 =back
 
+=back
+
+Please note that this is the same format as used in the B<exec plugin>, see
+L<collectd-exec(5)>.
+
 Example:
   -> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire!
   <- | 0 Success