X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-exec.pod;h=b878657957a5614146cd8cd4891ed0cdf79a5b3d;hb=0e73c26f5670b2f11eecfdadaf545bcc7f260658;hp=fd9b3a0c02c7eba4b0fe617d5f759f7b9d424793;hpb=b61a03b05c1f4040a6599334b65141aa3bd134f5;p=collectd.git diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod index fd9b3a0c..b8786579 100644 --- a/src/collectd-exec.pod +++ b/src/collectd-exec.pod @@ -17,7 +17,7 @@ collectd-exec - Documentation of collectd's C =head1 DESCRIPTION -The C forks of an executable either to receive values or to +The C forks off an executable either to receive values or to dispatch notifications to the outside world. The syntax of the configuration is explained in L but summarized in the above synopsis. @@ -42,7 +42,7 @@ time and continuously write values to C. See L below for a description of the output format expected from these programs. -B If the executable only writes one value and then exits I will be +B If the executable only writes one value and then exits it will be executed every I seconds. If I is short (the default is 10 seconds) this may result in serious system load. @@ -73,7 +73,7 @@ Each line beginning with a C<#> (hash mark) is ignored. =item B I [I] I Submits one or more values (identified by I, see below) to the -daemon which will dispatch it to all it's write-plugins. +daemon which will dispatch it to all its write-plugins. An I is of the form CBIB<->IBIB<->I> with both @@ -94,7 +94,7 @@ I is a colon-separated list of the time and the values, each either 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). +epoch (i.Ee. standard UNIX time) or B to use the current time. You can mix options and values, but the order is important: Options only effect following values, so specifying an option as last field is allowed, but @@ -169,6 +169,19 @@ table. All the options are optional, but B without B or B without B doesn't make much sense and should be avoided. +=item BI + +Sets user defined meta information. The B key is a single character +defining the type of the meta information. + +The current supported types are: + +=over 8 + +=item B A string passed as-is. + +=back + =back =back @@ -268,12 +281,12 @@ to make use of collectd's more powerful interface. =over 4 -=item +=item * The user, the binary is executed as, may not have root privileges, i.Ee. must have an UID that is non-zero. This is for your own good. -=item +=item * Early versions of the plugin did not use a command but treated all lines as if they were arguments to the I command. When the I command was @@ -293,6 +306,6 @@ L, L =head1 AUTHOR -Florian Forster Eocto@verplant.orgE +Florian Forster Eocto@collectd.orgE =cut