sysdbd.conf(5) ============== :doctype: manpage NAME ---- sysdbd.conf - configuration for the system management and inventory collection service SYNOPSIS -------- Interval 300 Listen "unix:/var/run/sysdbd.sock" SSLCertificate "/etc/sysdb/ssl/cert.pem" SSLCertificateKey "/etc/sysdb/ssl/key.pem" LoadPlugin "syslog" LoadBackend "collectd::unixsock" LoadBackend "mk-livestatus" LoadPlugin "timeseries::rrdtool" Interval 1800 Socket "/var/run/collectd-unixsock" DESCRIPTION ----------- The *sysdbd.conf* file controls the behavior of the system management and inventory collection daemon (*sysdbd*). As the daemon itself does not provide any real (user-facing) functionality, the most important part of the configuration is loading and configuring plugins. The syntax of this configuration file is similar to that of the Apache webserver. It is made up of _options_ and _blocks_. Each option contains a _key_ and one or more _values_ separated by spaces and terminated by a newline character. Blocks are enclosed in a start- and end-tag, each on a line of their own. These tags are enclosed in angle brackets and also contain a key and value. A block's end-tag only contain the key of the start-tag prepended by a forward-slash ("/"). Empty lines are ignored as well as any unquoted hash symbol ("#") including anything following up to the following newline. Keys are unquoted strings consisting only of alphanumeric characters and the underscore character ("_"). Values may either be unquoted strings, quoted strings enclosed in double quotes, numbers or boolean values (*true* or *false*). In order to include a double-quote character in a quoted string, escape it using a backslash character ("\"). Floating point numbers use a dot (".") as decimal separator. Lines may be wrapped by using a backslash character ("\") as the last character before the newline. This allows long lines to be split into multiple lines. Quoted strings may be wrapped as well. However, those are treated special in that whitespace at the beginning of the following lines will be ignored, which allows for nicely indenting the wrapped lines. GLOBAL SETTINGS --------------- *sysdbd* accepts the following global options: *Interval* '':: Sets the interval at which to query backends by default. The interval is specified in seconds and might be a floating-point value. This option will be used by any "active" backend, that is, those that actively query some external system rather than receiving some stream of events. *Listen* '':: Sets the address on which sysdbd is to listen for client connections. It supports UNIX domain sockets and TCP sockets using TLS encryption. UNIX socket addresses are specified by the path name of the socket, optionally prefixed with 'unix:'. TCP listen addresses may be specified as ':', optionally prefixed with 'tcp:'. The host may be a hostname, an IPv4 address or and IPv6 address. It may be empty or '0.0.0.0' / '::' to listen on all local addresses. *Listen* may optionally be a block containing any of the following options: *SSLCertificate* '';; Specify the SSL server certificate file to use for SSL connections. *SSLCertificateKey* '';; Specify the SSL server private key file to use for SSL connections. *SSLCACertificates* '';; Specify the file containing certificate authority (CA) certificates for client verification purposes to use for SSL connnections. *LoadBackend* '':: Loads the backend named ''. Backends are special plugins taking care of collecting values from external systems. This may optionally be a block containing any of the following options: *Interval* '';; Overwrite the global interval setting by setting a custom interval to be used for this backend. See the global *Interval* option for more details. *LoadPlugin* '':: Loads the plugin named ''. Plugins provide additional functionality for sysdbd. *PluginDir* '':: Sets the base directory for plugins to ''. When loading a plugin, it is expected to be found below this directory. This option affects all following *LoadBackend* or *LoadPlugin* statements up to the following *PluginDir* option. PLUGINS ------- Some plugins support additional configuration options. Each of these are enclosed in a *Plugin* or *Backend* section. The following plugins are shipped with SysDB. See *sysdbd*-''(5) manpages for more details. Backends: ~~~~~~~~~ *collectd::unixsock*:: This backend module accesses the system statistics collection daemon *collectd* through its UNIX socket interface. It periodically queries all host and metric information. + See also: http://collectd.org *facter*:: This backend module retrieves local facter fact values and submits them as host attributes. + See also: https://github.com/puppetlabs/cfacter *mk-livestatus*:: This backend modules accesses monitoring systems supporting the *livestatus* addon (e.g., *Nagios*, *Icinga*, and *Shinken*). It periodically queries all host and service information. + See also: http://mathias-kettner.de/checkmk_livestatus.html, http://www.nagios.org/, http://icinga.org/, http://www.shinken-monitoring.org/ *puppet::store-configs*:: This backend module accesses the configuration management system *Puppet* through its *store configs* database. It periodically queries all host and facter facts information storing the latter as host attributes. + See also: http://puppetlabs.com/puppet, http://puppetlabs.com/puppet/related-projects/facter/ Time-series fetcher: ~~~~~~~~~~~~~~~~~~~~ *timeseries::rrdtool*:: This plugin adds support for fetching time-series data from RRD files. + See also: http://oss.oetiker.ch/rrdtool Plugins: ~~~~~~~~ *cname::dns*:: Canonicalize hostnames based on a reverse DNS query. *syslog*:: This logging module sends log messages of the daemon and plugins to the local system's syslog service. SEE ALSO -------- manpage:sysdbd[1], manpage:sysdb[7] The SysDB homepage: https://sysdb.io/ Backend documentation: ~~~~~~~~~~~~~~~~~~~~~~ manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-facter[5], manpage:sysdbd-mk-livestatus[5], manpage:sysdbd-puppet-store-configs[5] Time-series fetcher documentation: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ manpage:sysdbd-timeseries-rrdtool[5] Plugin documentation: ~~~~~~~~~~~~~~~~~~~~~ manpage:sysdbd-cname-dns[5], manpage:sysdbd-syslog[5] AUTHOR ------ SysDB was written by Sebastian "tokkee" Harl . COPYRIGHT --------- Copyright (C) 2012-2014 Sebastian "tokkee" Harl This is free software under the terms of the BSD license, see the source for copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :