author | Florian Forster <octo@leeloo.lan.home.verplant.org> | |
Wed, 23 Jan 2008 13:54:41 +0000 (14:54 +0100) | ||
committer | Florian Forster <octo@leeloo.lan.home.verplant.org> | |
Wed, 23 Jan 2008 13:54:41 +0000 (14:54 +0100) |
1 | 2 | |||
---|---|---|---|---|
src/collectd-unixsock.pod | patch | | diff1 | | diff2 | | blob | history |
diff --combined src/collectd-unixsock.pod
index 5769329fa1e4df6078c5e17a7bd6ed3e3599b4dd,7a82541ad274915e0593504a4a0b6b6833dfcc70..16ba70f488553daa6d7f41acb890397cb706b12d
=item B<LISTVAL>
-Returnes a list of the values available in the value cache together with the
+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<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.
+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.
Example:
-> | LISTVAL
An I<Identifier> is of the form
C<I<host>B</>I<plugin>B<->I<instance>B</>I<type>B<->I<instance>> with both
I<instance>-parts being optional. If they're omitted the hyphen must be
- omitted, too.
+ omitted, too. I<plugin> and each I<instance>-part may be chosen freely as long
+ as the tuple (plugin, plugin instance, type instance) uniquely identifies the
+ plugin within collectd. I<type> identifies the type and number of values
+ (i.E<nbsp>e. data-set) passed to collectd. A large list of predefined
+ data-sets is available in the B<types.db> file.
The I<OptionList> is an optional list of I<Options>, where each option if a
key-value-pair. A list of currently understood options can be found below, all
other options will be ignored.
-I<Valuelist> is a colon-seperated list of the time and the values, each either
+I<Valuelist> is a colon-separated 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