src/collectd-unixsock.pod

   1 =head1 NAME
   2
   3 collectd-unixsock - Documentation of collectd's C<unixsock plugin>
   4
   5 =head1 SYNOPSIS
   6
   7   # See collectd.conf(5)
   8   LoadPlugin unixsock
   9   # ...
  10   <Plugin unixsock>
  11     SocketFile "/path/to/socket"
  12     SocketGroup "collectd"
  13     SocketPerms "0770"
  14   </Plugin>
  15
  16 =head1 DESCRIPTION
  17
  18 The C<unixsock plugin> opens an UNIX-socket over which one can interact with
  19 the daemon. This can be used to use the values collected by collectd in other
  20 applications, such as monitoring, or submit externally collected values to
  21 collectd.
  22
  23 This plugin is used by L<collectd-nagios(1)> to check if some value is in a
  24 certain range and exit with a Nagios-compatible exit code.
  25
  26 =head1 COMMANDS
  27
  28 Upon start the C<unixsock plugin> opens a UNIX-socket and waits for
  29 connections. Once a connection is established the client can send commands to
  30 the daemon which it will answer, if it understand them.
  31
  32 The following commands are implemented:
  33
  34 =over 4
  35
  36 =item B<GETVAL> I<Identifier>
  37
  38 If the value identified by I<Identifier> (see below) is found the complete
  39 value-list is returned. The response is a space seperated 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 occured. Otherwise it contains the
  45 number of values that follow. Each value is of the form I<name>B<=>I<value>.
  46 Counter-values are converted to a rate, e.E<nbsp>g. bytes per second.
  47 Undefined values are returned as B<NaN>.
  48
  49 Example:
  50   -> | GETVAL myhost/cpu-0/cpu-user
  51   <- | 1 value=1.260000e+00
  52
  53 =item B<PUTVAL> I<Identifier> I<Valuelist>
  54
  55 Submits a value (identified by I<Identifier>, see below) to the daemon which
  56 will dispatch it to all it's write-plugins. The I<Valuelist> is a
  57 colon-seperated list of values, either an integer if the data-source is a
  58 counter, of a double if the data-source if of type "gauge". You can submit an
  59 undefined gauge-value by using B<U>. When submitting B<U> to a counter the
  60 behavior is undefined.
  61
  62 Example:
  63   -> | PUTVAL testhost/interface/if_octets-test0 1179574444:123:456
  64   <- | 0 Success
  65
  66 =back
  67
  68 =head2 Identifiers
  69
  70 Value or value-lists are identified in a uniform fassion:
  71
  72 I<Hostname>/I<Plugin>/I<Type>
  73
  74 Where I<Plugin> and I<Type> are both either of type "I<Name>" or
  75 "I<Name>-I<Instance>". This sounds more complicated than it is, so here are
  76 some examples:
  77
  78   myhost/cpu-0/cpu-user
  79   myhost/load/load
  80   myhost/memory/memory-used
  81   myhost/disk-sda/disk_octets
  82
  83 =head2 Return values
  84
  85 Unless otherwise noted the plugin answers with a line of the following form:
  86
  87 I<Num> I<Message>
  88
  89 If I<Num> is zero the message indicates success, if I<Num> is non-zero the
  90 message indicates failure. I<Message> is a human-readable string that describes
  91 the return value further.
  92
  93 Commands that return values may use I<Num> to return the number of values that
  94 follow, such as the B<GETVAL> command. These commands usually return a negative
  95 value on failure and never return zero.
  96
  97 =head1 ABSTRACTION LAYER
  98
  99 Shipped with the sourcecode comes the Perl-Module L<Collectd::Unixsock> which
 100 provides an abstraction layer over the actual socket connection. It can be
 101 found in the directory F<contrib/PerlLib>. If you want to use Perl to
 102 communicate with the daemon, you're encouraged to use and expand this module.
 103
 104 =head1 SEE ALSO
 105
 106 L<collectd(1)>,
 107 L<collectd.conf(5)>,
 108 L<collectd-nagios(1)>,
 109 L<unix(7)>
 110
 111 =head1 AUTHOR
 112
 113 Florian Forster E<lt>octo@verplant.orgE<gt>
 114
 115 =cut