doc/sysdbd.conf.5.txt

   1 sysdbd.conf(5)
   2 ==============
   3 :doctype: manpage
   4
   5 NAME
   6 ----
   7 sysdbd.conf - configuration for the system management and inventory collection
   8 service
   9
  10 SYNOPSIS
  11 --------
  12   Interval 300
  13
  14   Listen "unix:/var/run/sysdbd.sock"
  15
  16   LoadPlugin "syslog"
  17
  18   LoadBackend "collectd::unixsock"
  19   LoadBackend "mk-livestatus"
  20
  21   <LoadBackend "puppet::store-configs">
  22       Interval 1800
  23   </LoadBackend>
  24
  25   <Backend "collectd::unixsock">
  26       <Instance "central-collector">
  27           Socket "/var/run/collectd-unixsock"
  28       </Instance>
  29   </Backend>
  30
  31 DESCRIPTION
  32 -----------
  33 The *sysdbd.conf* file controls the behavior of the system management and
  34 inventory collection daemon (*sysdbd*). As the daemon itself does not provide
  35 any real (user-facing) functionality, the most important part of the
  36 configuration is loading and configuring plugins.
  37
  38 The syntax of this configuration file is similar to that of the Apache
  39 webserver. It is made up of _options_ and _sections_. Each option contains a
  40 _key_ and one or more _values_ separated by spaces and terminated by a newline
  41 character. Sections are enclosed in a start- and end-tag, each on a line of
  42 their own. These tags are enclosed in angle brackets and also contain a key
  43 and value. Section end-tags only contain the key of the start-tag prepended by
  44 a forward-slash ("/"). Empty lines are ignored as well as any unquoted hash
  45 symbol ("#") including anything following up to the following newline. Keys
  46 are unquoted strings consisting only of alphanumeric characters and the
  47 underscore character ("_"). Values may either be unquoted strings, quoted
  48 strings enclosed in double quotes, numbers or boolean values (*true* or
  49 *false*). In order to include a double-quote character in a quoted string,
  50 escape it using a backslash character ("\"). Floating point numbers use a dot
  51 (".") as decimal separator.
  52
  53 Lines may be wrapped by using a backslash character ("\") as the last
  54 character before the newline. This allows long lines to be split into multiple
  55 lines. Quoted strings may be wrapped as well. However, those are treated
  56 special in that whitespace at the beginning of the following lines will be
  57 ignored, which allows for nicely indenting the wrapped lines.
  58
  59 GLOBAL SETTINGS
  60 ---------------
  61 *sysdbd* accepts the following global options:
  62
  63 *Interval* '<seconds>'::
  64         Sets the interval at which to query backends by default. The interval is
  65         specified in seconds and might be a floating-point value. This option will
  66         be used by any "active" backend, that is, those that actively query some
  67         external system rather than receiving some stream of events.
  68
  69 *Listen* '<socket>'::
  70         Sets the address on which sysdbd is to listen for client connections. It
  71         supports UNIX domain sockets. The path name needs to be prefixed by
  72         'unix:'.
  73
  74 *LoadBackend* '<name>'::
  75         Loads the backend named '<name>'. Backends are special plugins taking care
  76         of collecting values from external systems. This may optionally be a
  77         section containing any of the following options:
  78
  79         *Interval* '<seconds>';;
  80                 Overwrite the global interval setting by setting a custom interval to
  81                 be used for this backend. See the global *Interval* option for more
  82                 details.
  83
  84 *LoadPlugin* '<name>'::
  85         Loads the plugin named '<name>'. Plugins provide additional functionality
  86         for sysdbd.
  87
  88 *PluginDir* '<directory>'::
  89         Sets the base directory for plugins to '<directory>'. When loading a
  90         plugin, it is expected to be found below this directory. This option
  91         affects all following *LoadBackend* or *LoadPlugin* statements up to the
  92         following *PluginDir* option.
  93
  94 PLUGINS
  95 -------
  96 Some plugins support additional configuration options. Each of these are
  97 enclosed in a *Plugin* or *Backend* section. The following plugins are shipped
  98 with SysDB. See *sysdbd*-'<name>'(5) manpages for more details.
  99
 100 Backends:
 101 ~~~~~~~~~
 102
 103 *collectd::unixsock*::
 104 This backend module accesses the system statistics collection daemon
 105 *collectd* through its UNIX socket interface. It periodically queries all host
 106 and service information.
 107 +
 108 See also: http://collectd.org
 109
 110 *mk-livestatus*::
 111 This backend modules accesses monitoring systems supporting the *livestatus*
 112 addon (e.g., *Nagios*, *Icinga*, and *Shinken*). It periodically queries all
 113 host and service information.
 114 +
 115 See also: http://mathias-kettner.de/checkmk_livestatus.html,
 116 http://www.nagios.org/, http://icinga.org/, http://www.shinken-monitoring.org/
 117
 118 *puppet::store-configs*::
 119 This backend module accesses the configuration management system *Puppet*
 120 through its *store configs* database. It periodically queries all host and
 121 facter facts information storing the latter as host attributes.
 122 +
 123 See also: http://puppetlabs.com/puppet,
 124 http://puppetlabs.com/puppet/related-projects/facter/
 125
 126 Plugins:
 127 ~~~~~~~~
 128
 129 *cname::dns*::
 130 Canonicalize hostnames based on a reverse DNS query.
 131
 132 *syslog*::
 133 This logging module sends log messages of the daemon and plugins to the local
 134 system's syslog service.
 135
 136 SEE ALSO
 137 --------
 138 manpage:sysdbd[1], manpage:sysdb[7]
 139
 140 The SysDB homepage: http://sysdb.io/
 141
 142 Backend documentation:
 143 ~~~~~~~~~~~~~~~~~~~~~~
 144
 145 manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-mk-livestatus[5],
 146 manpage:sysdbd-puppet-store-configs[5]
 147
 148 Plugin documentation:
 149 ~~~~~~~~~~~~~~~~~~~~~
 150
 151 manpage:sysdbd-cname-dns[5], manpage:sysdbd-syslog[5]
 152
 153 AUTHOR
 154 ------
 155 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
 156
 157 COPYRIGHT
 158 ---------
 159 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
 160
 161 This is free software under the terms of the BSD license, see the source for
 162 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
 163 FITNESS FOR A PARTICULAR PURPOSE.
 164
 165 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
 166