X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-exec.pod;h=b95779dd5fc4414cb6e65bebcac880d6c048070a;hb=refs%2Fheads%2Fff%2Fjson;hp=9882601b81213a3a58054aded34e2977af3e020b;hpb=1584314f015f98abc61e74fdd6e47e200c8d02aa;p=collectd.git diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod index 9882601b..b95779dd 100644 --- a/src/collectd-exec.pod +++ b/src/collectd-exec.pod @@ -83,12 +83,13 @@ plugin within collectd. I identifies the type and number of values data-sets is available in the B file. See L for a description of the format of this file. -The I is an optional list of I, where each option if a +The I is an optional list of I, where each option is a key-value-pair. A list of currently understood options can be found below, all -other options will be ignored. +other options will be ignored. Values that contain spaces must be quoted with +double quotes. I is a colon-separated list of the time and the values, each either -an integer if the data-source is a counter, of a double if the data-source if +an integer if the data-source is a counter, or a double if the data-source is of type "gauge". You can submit an undefined gauge-value by using B. When submitting B to a counter the behavior is undefined. The time is given as epoch (i.Ee. standard UNIX time). @@ -139,10 +140,9 @@ Valid options are: =item BI (B) 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. +accessible to the user, so it should contain some useful information. As with +all options: If the message includes spaces, it must be quoted with double +quotes. This option is mandatory. =item B|B|B (B) @@ -171,11 +171,13 @@ table. All the options are optional, but B without B or B without B doesn't make much sense and should be avoided. -Please note that this is the same format as used in the B, see -L. +=back =back +Please note that this is the same format as used in the B, see +L. + When collectd exits it sends a B to all still running child-processes upon which they have to quit.