X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-unixsock.pod;h=ac4a1b13fb4810b99e2fbc6f40ae853c27b1091f;hb=4027126a75439c7d2b1d5572092fd291ef19ead6;hp=971cb36dc0a138a9c826d5148178714e57078b91;hpb=b58af48a482b30999bd0b71c470c5dbab8fd5abd;p=collectd.git diff --git a/src/collectd-unixsock.pod b/src/collectd-unixsock.pod index 971cb36d..ac4a1b13 100644 --- a/src/collectd-unixsock.pod +++ b/src/collectd-unixsock.pod @@ -17,11 +17,11 @@ collectd-unixsock - Documentation of collectd's C The C opens an UNIX-socket over which one can interact with the daemon. This can be used to use the values collected by collectd in other -applications, such as monitoring, or submit externally collected values to -collectd. +applications, such as monitoring solutions, or submit externally collected +values to collectd. -This plugin is used by L to check if some value is in a -certain range and exit with a Nagios-compatible exit code. +For example, this plugin is used by L to check if some +value is in a certain range and exit with a Nagios-compatible exit code. =head1 COMMANDS @@ -94,7 +94,8 @@ data-sets is available in the B file. 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, or a double if the data-source is @@ -142,10 +143,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) @@ -183,19 +183,25 @@ Example: -> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire! <- | 0 Success -=item B [BI] [BI [...]] +=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. B -may be specified multiple times - each occurrence applies to plugins listed -afterwards. +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 specified, only specific plugins are flushed. Otherwise all plugins -providing a flush callback are 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 - <- | 0 Done + -> | FLUSH plugin=rrdtool identifier=localhost/df/df-root identifier=localhost/df/df-var + <- | 0 Done: 2 successful, 0 errors =back @@ -206,13 +212,15 @@ Value or value-lists are identified in a uniform fashion: I/I/I Where I and I are both either of type "I" or -"I-I". This sounds more complicated than it is, so here are +"I-I". If the identifier includes spaces, it must be quoted +using double quotes. This sounds more complicated than it is, so here are some examples: myhost/cpu-0/cpu-user myhost/load/load myhost/memory/memory-used myhost/disk-sda/disk_octets + "myups/snmp/temperature-Outlet 1" =head1 ABSTRACTION LAYER