Merge branch 'collectd-4.0'

[collectd.git] / src / collectd-unixsock.pod

diff --git a/src/collectd-unixsock.pod b/src/collectd-unixsock.pod
index 05e49a5..da4f2b2 100644 (file)
--- a/src/collectd-unixsock.pod
+++ b/src/collectd-unixsock.pod
@@ -20,6 +20,9 @@ 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, or submit externally collected values to
 collectd.
 

+This plugin is used by L<collectd-nagios(1)> to check if some value is in a
+certain range and exit with a Nagios-compatible exit code.
+

 =head1 COMMANDS
 
 Upon start the C<unixsock plugin> opens a UNIX-socket and waits for
 =head1 COMMANDS
 
 Upon start the C<unixsock plugin> opens a UNIX-socket and waits for


@@ -47,14 +50,34 @@ Example:
   -> | GETVAL myhost/cpu-0/cpu-user
   <- | 1 value=1.260000e+00
 
   -> | GETVAL myhost/cpu-0/cpu-user
   <- | 1 value=1.260000e+00
 

+=item B<LISTVAL>
+
+Returnes 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<GETVAL>
+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 occured. Each of the following lines containes the
+update time as an epoch value and the identifier, seperated by a space.
+
+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
+  ...
+

 =item B<PUTVAL> I<Identifier> I<Valuelist>
 
 Submits a value (identified by I<Identifier>, see below) to the daemon which
 will dispatch it to all it's write-plugins. The I<Valuelist> is a
 =item B<PUTVAL> I<Identifier> I<Valuelist>
 
 Submits a value (identified by I<Identifier>, see below) to the daemon which
 will dispatch it to all it's write-plugins. The I<Valuelist> is a

-colon-seperated list of values, either an integer if the data-source is a
-counter, of a double if the data-source if of type "gauge". You can submit an
-undefined gauge-value by using B<U>. When submitting B<U> to a counter the
-behavior is undefined.
+colon-seperated 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 of type "gauge".
+You can submit an undefined gauge-value by using B<U>. When submitting B<U> to
+a counter the behavior is undefined. The time is given as epoch (i.E<nbsp>e.
+standard UNIX time).

 
 Example:
   -> | PUTVAL testhost/interface/if_octets-test0 1179574444:123:456
 
 Example:
   -> | PUTVAL testhost/interface/if_octets-test0 1179574444:123:456


@@ -100,7 +123,10 @@ communicate with the daemon, you're encouraged to use and expand this module.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

-L<collectd(1)>, L<collectd.conf(5)>, L<unix(7)>
+L<collectd(1)>,
+L<collectd.conf(5)>,
+L<collectd-nagios(1)>,
+L<unix(7)>

 
 =head1 AUTHOR
 
 
 =head1 AUTHOR