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   LoadBackend "collectd::unixsock"
  17   LoadBackend "mk-livestatus"
  18
  19   <LoadBackend "puppet::store-configs">
  20       Interval 1800
  21   </LoadBackend>
  22
  23   <Backend "collectd::unixsock">
  24       <Instance "central-collector">
  25           Socket "/var/run/collectd-unixsock"
  26       </Instance>
  27   </Backend>
  28
  29 DESCRIPTION
  30 -----------
  31 The *sysdbd.conf* file controls the behavior of the system management and
  32 inventory collection daemon (*sysdbd*). As the daemon itself does not provide
  33 any real (user-facing) functionality, the most important part of the
  34 configuration is loading and configuring plugins.
  35
  36 The syntax of this configuration file is similar to that of the Apache
  37 webserver. It is made up of _options_ and _sections_. Each option contains a
  38 _key_ and one or more _values_ separated by spaces and terminated by a newline
  39 character. Sections are enclosed in a start- and end-tag, each on a line of
  40 their own. These tags are enclosed in angle brackets and also contain a key
  41 and value. Section end-tags only contain the key of the start-tag prepended by
  42 a forward-slash ("/"). Empty lines are ignored as well as any unquoted hash
  43 symbol ("#") including anything following up to the following newline. Keys
  44 are unquoted strings consisting only of alphanumeric characters and the
  45 underscore character ("_"). Values may either be unquoted strings, quoted
  46 strings enclosed in double quotes, numbers or boolean values (*true* or
  47 *false*). In order to include a double-quote character in a quoted string,
  48 escape it using a backslash character ("\"). Floating point numbers use a dot
  49 (".") as decimal separator.
  50
  51 Lines may be wrapped by using a backslash character ("\") as the last
  52 character before the newline. This allows long lines to be split into multiple
  53 lines. Quoted strings may be wrapped as well. However, those are treated
  54 special in that whitespace at the beginning of the following lines will be
  55 ignored, which allows for nicely indenting the wrapped lines.
  56
  57 GLOBAL SETTINGS
  58 ---------------
  59 *sysdbd* accepts the following global options:
  60
  61 *Interval* '<seconds>'::
  62         Sets the interval at which to query backends by default. The interval is
  63         specified in seconds and might be a floating-point value. This option will
  64         be used by any "active" backend, that is, those that actively query some
  65         external system rather than receiving some stream of events.
  66
  67 *LoadBackend* '<name>'::
  68         Loads the backend named '<name>'. Backends are special plugins taking care
  69         of collecting values from external systems. This may optionally be a
  70         section containing any of the following options:
  71
  72         *Interval* '<seconds>';;
  73                 Overwrite the global interval setting by setting a custom interval to
  74                 be used for this backend. See the global *Interval* option for more
  75                 details.
  76
  77 PLUGINS
  78 -------
  79 Some plugins support additional configuration options. Each of these are
  80 enclosed in a *Plugin* or *Backend* section. The following plugins are shipped
  81 with SysDB. See *sysdb*-'<name>'(5) manpages for more details.
  82
  83 * *collectd::unixsock*
  84 * *mk-livestatus*
  85 * *puppet::store-configs*
  86
  87 SEE ALSO
  88 --------
  89 *sysdbd*(1)
  90
  91 AUTHOR
  92 ------
  93 sysdbd was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
  94
  95 COPYRIGHT
  96 ---------
  97 Copyright (C) 2012 Sebastian "tokkee" Harl <sh@tokkee.org>
  98
  99 This is free software under the terms of the BSD license, see the source for
 100 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
 101 FITNESS FOR A PARTICULAR PURPOSE.
 102
 103 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
 104