X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-unixsock.pod;h=1e00baf3d118ea1839f0d03208aeca127b08dca4;hb=ec9abb566017d406745f5f263b55792f89cede1a;hp=3ef24386548abf19a4588d0d9710a7eb4b744f3c;hpb=9d5a7847b03d78a94b6a0b153abeb630b4b94ddd;p=collectd.git diff --git a/src/collectd-unixsock.pod b/src/collectd-unixsock.pod index 3ef24386..1e00baf3 100644 --- a/src/collectd-unixsock.pod +++ b/src/collectd-unixsock.pod @@ -29,6 +29,18 @@ Upon start the C opens a UNIX-socket and waits for connections. Once a connection is established the client can send commands to the daemon which it will answer, if it understand them. +In general the plugin answers with a status line of the following form: + +I I + +If I is greater than or equal to zero the message indicates success, +if I is less than zero the message indicates failure. I is a +human-readable string that further describes the return value. + +On success, I furthermore indicates the number of subsequent lines of +output (not including the status line). Each such lines usually contains a +single return value. See the description of each command for details. + The following commands are implemented: =over 4 @@ -36,37 +48,34 @@ The following commands are implemented: =item B I If the value identified by I (see below) is found the complete -value-list is returned. The response is a space separated list of -name-value-pairs: - -I IB<=>I[ IB<=>I[ ...]] - -If I is less then zero, an error occurred. Otherwise it contains the -number of values that follow. Each value is of the form IB<=>I. +value-list is returned. The response is a list of name-value-pairs, each pair +on its own line (the number of lines is indicated by the status line - see +above). Each name-value-pair is of the form IB<=>I. Counter-values are converted to a rate, e.Eg. bytes per second. Undefined values are returned as B. Example: -> | GETVAL myhost/cpu-0/cpu-user - <- | 1 value=1.260000e+00 + <- | 1 Value found + <- | value=1.260000e+00 =item B Returns a list of the values available in the value cache together with the time of the last update, so that querying applications can issue a B -command for the values that have changed. - -The first line's status number is the number of identifiers returned or less -than zero if an error occurred. Each of the following lines contains the -update time as an epoch value and the identifier, separated by a space. +command for the values that have changed. Each return value consists of the +update time as an epoch value and the identifier, separated by a space. The +update time is the time of the last value, as provided by the collecting +instance and may be very different from the time the server considers to be +"now". Example: -> | LISTVAL <- | 69 Values found - <- | 1182204284 leeloo/cpu-0/cpu-idle - <- | 1182204284 leeloo/cpu-0/cpu-nice - <- | 1182204284 leeloo/cpu-0/cpu-system - <- | 1182204284 leeloo/cpu-0/cpu-user + <- | 1182204284 myhost/cpu-0/cpu-idle + <- | 1182204284 myhost/cpu-0/cpu-nice + <- | 1182204284 myhost/cpu-0/cpu-system + <- | 1182204284 myhost/cpu-0/cpu-user ... =item B I [I] I @@ -174,6 +183,26 @@ Example: -> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire! <- | 0 Success +=item B [BI] [BI [...]] [BI [...]] + +Flushes all cached data older than I seconds. If no timeout has been +specified, it defaults to -1 which causes all data to be flushed. + +If the B option has been specified, only the I plugin will be +flushed. You can have multiple B options to flush multiple plugins in +one go. If the B option is not given all plugins providing a flush +callback will be flushed. + +If the B option is given only the specified values will be flushed. +This is meant to be used by graphing or displaying frontends which want to have +the lastest values for a specific graph. Again, you can specify the +B option multiple times to flush several values. If this option is +not specified at all, all values will be flushed. + +Example: + -> | FLUSH plugin=rrdtool identifier=localhost/df/df-root identifier=localhost/df/df-var + <- | 0 Done: 2 successful, 0 errors + =back =head2 Identifiers @@ -191,20 +220,6 @@ some examples: myhost/memory/memory-used myhost/disk-sda/disk_octets -=head2 Return values - -Unless otherwise noted the plugin answers with a line of the following form: - -I I - -If I is zero the message indicates success, if I is non-zero the -message indicates failure. I is a human-readable string that describes -the return value further. - -Commands that return values may use I to return the number of values that -follow, such as the B command. These commands usually return a negative -value on failure and never return zero. - =head1 ABSTRACTION LAYER B ships the Perl-Module L which