X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-exec.pod;h=b878657957a5614146cd8cd4891ed0cdf79a5b3d;hb=48efd3deb4c9139fd060ff3d289896e9031bcc7c;hp=5f2c687b3c5aab69434b32552eb102d51385d299;hpb=6299d39b903cb87a3db5b6d2148a2d717754a30a;p=collectd.git diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod index 5f2c687b..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 @@ -201,13 +201,13 @@ The data is passed to the executables over C in a format very similar to 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.Ee. an empty line. The rest, basically the "body", is the message of -the notification. +i.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 + Time: 1200928930.515 Host: myhost.mydomain.org \n This is a test notification to demonstrate the format @@ -223,7 +223,9 @@ Severity of the notification. May either be B, B, or B. =item B