doc/sysdbd-collectd-unixsock.5.txt

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