← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/collectd/oneiric

« back to all changes in this revision

Viewing changes to src/collectd-unixsock.pod

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Harl
  • Date: 2008-06-17 10:35:51 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080617103551-9d0ym3zejc7agtt3
Tags: 4.4.1-1
http://bugs.debian.org/468143
http://bugs.debian.org/475120
http://bugs.debian.org/478759
http://bugs.debian.org/473435
http://bugs.debian.org/482667
* New upstream release.
  - Fixed another issue of the sensors plugin affecting some chip types
    (Closes: #468143).
  - Fixed creation of "vserver" graphs in collection.cgi (Closes: #475120).
  - Fixed a segfault when using libperl 5.10.
  - collectd now ships libiptc itself.
  New plugins:
  - Ascent server statistics: ascent
  - IPMI sensors information: ipmi
  - PowerDNS name server statistics: powerdns
  - incremental parsing of logfiles: tail
  - TeamSpeak2 server statistics: teamspeak2
  - detailed virtual memory statistics: vmem
* Disable "tcpconns" plugin by default (Closes: #478759).
* Reenabled iptables plugin on all architectures (Closes: #473435).
  - Added the plugin to collectd.conf.
  - Added /usr/share/doc/collectd/examples/iptables/.
  - Added build dependency on linux-libc-dev (>= 2.6.25-4) - that version is
    required because of #479899.
* New debconf template translations:
  - gl.po, thanks to Jacobo Tarrio (Closes: #482667).
* Added a work around for #474087 (broken openipmi .pc files) by forcing the
  inclusion of the ipmi plugin and manually specifying the dependencies.
* Updated standards-version to 3.8.0 (no changes).

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/collectd-unixsock.pod
29
29
connections. Once a connection is established the client can send commands to
30
30
the daemon which it will answer, if it understand them.
31
31
 
 
32
In general the plugin answers with a status line of the following form:
 
33
 
 
34
I<Status> I<Message>
 
35
 
 
36
If I<Status> is greater than or equal to zero the message indicates success,
 
37
if I<Status> is less than zero the message indicates failure. I<Message> is a
 
38
human-readable string that further describes the return value.
 
39
 
 
40
On success, I<Status> furthermore indicates the number of subsequent lines of
 
41
output (not including the status line). Each such lines usually contains a
 
42
single return value. See the description of each command for details.
 
43
 
32
44
The following commands are implemented:
33
45
 
34
46
=over 4
36
48
=item B<GETVAL> I<Identifier>
37
49
 
38
50
If the value identified by I<Identifier> (see below) is found the complete
39
 
value-list is returned. The response is a space separated list of
40
 
name-value-pairs:
41
 
 
42
 
I<num> I<name>B<=>I<value>[ I<name>B<=>I<value>[ ...]]
43
 
 
44
 
If I<num> is less then zero, an error occurred. Otherwise it contains the
45
 
number of values that follow. Each value is of the form I<name>B<=>I<value>.
 
51
value-list is returned. The response is a list of name-value-pairs, each pair
 
52
on its own line (the number of lines is indicated by the status line - see
 
53
above). Each name-value-pair is of the form I<name>B<=>I<value>.
46
54
Counter-values are converted to a rate, e.E<nbsp>g. bytes per second.
47
55
Undefined values are returned as B<NaN>.
48
56
 
49
57
Example:
50
58
  -> | GETVAL myhost/cpu-0/cpu-user
51
 
  <- | 1 value=1.260000e+00
 
59
  <- | 1 Value found
 
60
  <- | value=1.260000e+00
52
61
 
53
62
=item B<LISTVAL>
54
63
 
55
64
Returns a list of the values available in the value cache together with the
56
65
time of the last update, so that querying applications can issue a B<GETVAL>
57
 
command for the values that have changed.
58
 
 
59
 
The first line's status number is the number of identifiers returned or less
60
 
than zero if an error occurred. Each of the following lines contains the
61
 
update time as an epoch value and the identifier, separated by a space.
 
66
command for the values that have changed. Each return value consists of the
 
67
update time as an epoch value and the identifier, separated by a space. The
 
68
update time is the time of the last value, as provided by the collecting
 
69
instance and may be very different from the time the server considers to be
 
70
"now".
62
71
 
63
72
Example:
64
73
  -> | LISTVAL
65
74
  <- | 69 Values found
66
 
  <- | 1182204284 leeloo/cpu-0/cpu-idle
67
 
  <- | 1182204284 leeloo/cpu-0/cpu-nice
68
 
  <- | 1182204284 leeloo/cpu-0/cpu-system
69
 
  <- | 1182204284 leeloo/cpu-0/cpu-user
 
75
  <- | 1182204284 myhost/cpu-0/cpu-idle
 
76
  <- | 1182204284 myhost/cpu-0/cpu-nice
 
77
  <- | 1182204284 myhost/cpu-0/cpu-system
 
78
  <- | 1182204284 myhost/cpu-0/cpu-user
70
79
  ...
71
80
 
72
81
=item B<PUTVAL> I<Identifier> [I<OptionList>] I<Valuelist>
174
183
  -> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire!
175
184
  <- | 0 Success
176
185
 
 
186
=item B<FLUSH> [B<timeout=>I<Timeout>] [B<plugin=>I<Plugin> [...]]
 
187
 
 
188
Flushes all cached data older than I<Timeout> seconds. If no timeout has been
 
189
specified, it defaults to -1 which causes all data to be flushed. B<timeout>
 
190
may be specified multiple times - each occurrence applies to plugins listed
 
191
afterwards.
 
192
 
 
193
If specified, only specific plugins are flushed. Otherwise all plugins
 
194
providing a flush callback are flushed.
 
195
 
 
196
Example:
 
197
  -> | FLUSH
 
198
  <- | 0 Done
 
199
 
177
200
=back
178
201
 
179
202
=head2 Identifiers
191
214
  myhost/memory/memory-used
192
215
  myhost/disk-sda/disk_octets
193
216
 
194
 
=head2 Return values
195
 
 
196
 
Unless otherwise noted the plugin answers with a line of the following form:
197
 
 
198
 
I<Num> I<Message>
199
 
 
200
 
If I<Num> is zero the message indicates success, if I<Num> is non-zero the
201
 
message indicates failure. I<Message> is a human-readable string that describes
202
 
the return value further.
203
 
 
204
 
Commands that return values may use I<Num> to return the number of values that
205
 
follow, such as the B<GETVAL> command. These commands usually return a negative
206
 
value on failure and never return zero.
207
 
 
208
217
=head1 ABSTRACTION LAYER
209
218
 
210
219
B<collectd> ships the Perl-Module L<Collectd::Unixsock> which