doc/sysdbd.conf.5.txt

   1 sysdbd.conf(5)
   2 ==============
   3 Sebastian "tokkee" Harl <sh@tokkee.org>
   4 version {package_version}, {build_date}
   5 :doctype: manpage
   6
   7 NAME
   8 ----
   9 sysdbd.conf - configuration for the system management and inventory collection
  10 service
  11
  12 SYNOPSIS
  13 --------
  14   Interval 300
  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 *LoadBackend* '<name>'::
  70         Loads the backend named '<name>'. Backends are special plugins taking care
  71         of collecting values from external systems. This may optionally be a
  72         section containing any of the following options:
  73
  74         *Interval* '<seconds>';;
  75                 Overwrite the global interval setting by setting a custom interval to
  76                 be used for this backend. See the global *Interval* option for more
  77                 details.
  78
  79 PLUGINS
  80 -------
  81 Some plugins support additional configuration options. Each of these are
  82 enclosed in a *Plugin* or *Backend* section. The following plugins are shipped
  83 with SysDB. See *sysdb*-'<name>'(5) manpages for more details.
  84
  85 *collectd::unixsock*::
  86 This backend module accesses the system statistics collection daemon
  87 *collectd* through its UNIX socket interface. It periodically queries all host
  88 and service information.
  89 +
  90 See also: http://collectd.org
  91
  92 *mk-livestatus*::
  93 This backend modules accesses monitoring systems supporting the *livestatus*
  94 addon (e.g., *Nagios*, *Icinga*, and *Shinken*). It periodically queries all
  95 host and service information.
  96 +
  97 See also: http://mathias-kettner.de/checkmk_livestatus.html,
  98 http://www.nagios.org/, http://icinga.org/, http://www.shinken-monitoring.org/
  99
 100 *puppet::store-configs*::
 101 This backend module accesses the configuration management system *Puppet*
 102 through its *store configs* database. It periodically queries all host and
 103 facter facts information storing the latter as host attributes.
 104 +
 105 See also: http://puppetlabs.com/puppet,
 106 http://puppetlabs.com/puppet/related-projects/facter/
 107
 108 *syslog*::
 109 This logging module sends log messages of the daemon and plugins to the local
 110 system's syslog service.
 111
 112 SEE ALSO
 113 --------
 114 *sysdbd*(1)
 115
 116 AUTHOR
 117 ------
 118 sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
 119
 120 COPYRIGHT
 121 ---------
 122 Copyright (C) 2012 Sebastian "tokkee" Harl <sh@tokkee.org>
 123
 124 This is free software under the terms of the BSD license, see the source for
 125 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
 126 FITNESS FOR A PARTICULAR PURPOSE.
 127
 128 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
 129