X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=doc%2Fsysdbd.conf.5.txt;h=ff4c7102cf90935a5c896746c410897751db57ed;hb=ebeb14d9215ce017340525214728e4bc62bd1d67;hp=d6b13475ba4381d4e1510c50df7aed620d7ae2e1;hpb=67199c74bfccf38d904b7277ddfea646e09c119f;p=sysdb.git diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt index d6b1347..ff4c710 100644 --- a/doc/sysdbd.conf.5.txt +++ b/doc/sysdbd.conf.5.txt @@ -1,7 +1,5 @@ sysdbd.conf(5) ============== -Sebastian "tokkee" Harl -version {package_version}, {build_date} :doctype: manpage NAME @@ -20,6 +18,8 @@ SYNOPSIS LoadBackend "collectd::unixsock" LoadBackend "mk-livestatus" + LoadPlugin "timeseries::rrdtool" + Interval 1800 @@ -83,19 +83,38 @@ GLOBAL SETTINGS 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 *sysdb*-''(5) manpages for more details. +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 service information. +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 @@ -112,17 +131,49 @@ 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 -------- -*sysdbd*(1) +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 ------ -sysdbd was written by Sebastian "tokkee" Harl . +SysDB was written by Sebastian "tokkee" Harl . COPYRIGHT ---------