doc/sysdbd-collectd-unixsock.5.txt

   1 sysdbd-collectd-unixsock(5)
   2 ===========================
   3 :doctype: manpage
   4
   5 NAME
   6 ----
   7 sysdbd-collectd-unixsock - collectd::unixsock plugin querying collectd
   8
   9 SYNOPSIS
  10 --------
  11   <LoadBackend "collectd::unixsock">
  12       Interval 60
  13   </LoadBackend>
  14
  15   <Backend "collectd::unixsock">
  16       <Instance "collector">
  17           Socket "/var/run/collectd-unixsock"
  18       </Instance>
  19   </Backend>
  20
  21 DESCRIPTION
  22 -----------
  23 *collectd::unixsock* is a backend module which queries the system statistics
  24 collection daemon *collectd* using its *unixsock* interface. It connects to
  25 the daemon and periodically queries all hosts and metric names. The latter are
  26 then stored as services of the respective host.
  27
  28 CONFIGURATION
  29 -------------
  30 *collectd::unixsock* accepts the following configuration options:
  31
  32 *Instance* '<name>'::
  33         An instance block specifies a connection to collectd. The specified
  34         '<name>' is used to identify the connection internally but otherwise has
  35         no special meaning.
  36         +
  37         An instance block accepts the following configuration options:
  38
  39         *Socket* '<path>';;
  40                 The path name of the UNIX domain socket provided by collectd's
  41                 *unixsock* plugin.
  42
  43 SEE ALSO
  44 --------
  45 manpage:sysdbd[1], manpage:sysdbd.conf[5],
  46 https://collectd.org/, https://collectd.org/wiki/index.php/Plugin:UnixSock
  47
  48 The SysDB homepage: http://sysdb.io/
  49
  50 AUTHOR
  51 ------
  52 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
  53
  54 COPYRIGHT
  55 ---------
  56 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
  57
  58 This is free software under the terms of the BSD license, see the source for
  59 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
  60 FITNESS FOR A PARTICULAR PURPOSE.
  61
  62 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
  63