From 7c5f939cee7ea4ab3b7e19017785fed0fae60053 Mon Sep 17 00:00:00 2001 From: Sebastian Harl Date: Thu, 21 Aug 2014 21:55:35 -0700 Subject: [PATCH] Added documentation for the new timeseries::rrdtool plugin. --- doc/Makefile.am | 9 +++++++ doc/sysdbd-timeseries-rrdtool.5.txt | 42 +++++++++++++++++++++++++++++ doc/sysdbd.conf.5.txt | 15 +++++++++++ 3 files changed, 66 insertions(+) create mode 100644 doc/sysdbd-timeseries-rrdtool.5.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index 99ec20b..30f997d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -15,6 +15,7 @@ EXTRA_DIST = \ sysdbd-mk-livestatus.5.txt \ sysdbd-puppet-store-configs.5.txt \ sysdbd-syslog.5.txt \ + sysdbd-timeseries-rrdtool.5.txt \ sysdb.7.txt \ sysdbql.7.txt CLEANFILES = \ @@ -26,6 +27,7 @@ CLEANFILES = \ sysdbd-mk-livestatus.5 \ sysdbd-puppet-store-configs.5 \ sysdbd-syslog.5 \ + sysdbd-timeseries-rrdtool.5 \ sysdb.7 \ sysdbql.7 \ sysdb.1.html \ @@ -36,6 +38,7 @@ CLEANFILES = \ sysdbd-mk-livestatus.5.html \ sysdbd-puppet-store-configs.5.html \ sysdbd-syslog.5.html \ + sysdbd-timeseries-rrdtool.5.html \ sysdb.7.html \ sysdbql.7.html \ sysdb.1.xml \ @@ -46,6 +49,7 @@ CLEANFILES = \ sysdbd-mk-livestatus.5.xml \ sysdbd-puppet-store-configs.5.xml \ sysdbd-syslog.5.xml \ + sysdbd-timeseries-rrdtool.5.xml \ sysdb.7.xml \ sysdbql.7.xml @@ -58,6 +62,7 @@ man_MANS = \ sysdbd-mk-livestatus.5 \ sysdbd-puppet-store-configs.5 \ sysdbd-syslog.5 \ + sysdbd-timeseries-rrdtool.5 \ sysdb.7 \ sysdbql.7 @@ -70,6 +75,7 @@ html_DATA = \ sysdbd-mk-livestatus.5.html \ sysdbd-puppet-store-configs.5.html \ sysdbd-syslog.5.html \ + sysdbd-timeseries-rrdtool.5.html \ sysdb.7.html \ sysdbql.7.html @@ -89,6 +95,7 @@ sysdbd-collectd-unixsock.5.xml: sysdbd-collectd-unixsock.5.txt $(MAN_DEPS) sysdbd-mk-livestatus.5.xml: sysdbd-mk-livestatus.5.txt $(MAN_DEPS) sysdbd-puppet-store-configs.5.xml: sysdbd-puppet-store-configs.5.txt $(MAN_DEPS) sysdbd-syslog.5.xml: sysdbd-syslog.5.txt $(MAN_DEPS) +sysdbd-timeseries-rrdtool.5.xml: sysdbd-timeseries-rrdtool.5.txt $(MAN_DEPS) sysdb.7.xml: sysdb.7.txt sysdb-description.txt $(MAN_DEPS) sysdbql.7.xml: sysdbql.7.txt sysdb-description.txt $(MAN_DEPS) @@ -100,6 +107,7 @@ sysdbd-collectd-unixsock.5: sysdbd-collectd-unixsock.5.xml sysdbd-mk-livestatus.5: sysdbd-mk-livestatus.5.xml sysdbd-puppet-store-configs.5: sysdbd-puppet-store-configs.5.xml sysdbd-syslog.5: sysdbd-syslog.5.xml +sysdbd-timeseries-rrdtool.5: sysdbd-timeseries-rrdtool.5.xml sysdb.7: sysdb.7.xml sysdbql.7: sysdbql.7.xml @@ -111,6 +119,7 @@ sysdbd-collectd-unixsock.5.html: sysdbd-collectd-unixsock.5.txt $(MAN_DEPS) sysdbd-mk-livestatus.5.html: sysdbd-mk-livestatus.5.txt $(MAN_DEPS) sysdbd-puppet-store-configs.5.html: sysdbd-puppet-store-configs.5.txt $(MAN_DEPS) sysdbd-syslog.5.html: sysdbd-syslog.5.txt $(MAN_DEPS) +sysdbd-timeseries-rrdtool.5.html: sysdbd-timeseries-rrdtool.5.txt $(MAN_DEPS) sysdb.7.html: sysdb.7.txt sysdb-description.txt $(MAN_DEPS) sysdbql.7.html: sysdbql.7.txt sysdb-description.txt $(MAN_DEPS) diff --git a/doc/sysdbd-timeseries-rrdtool.5.txt b/doc/sysdbd-timeseries-rrdtool.5.txt new file mode 100644 index 0000000..4b59504 --- /dev/null +++ b/doc/sysdbd-timeseries-rrdtool.5.txt @@ -0,0 +1,42 @@ +sysdbd-timeseries-rrdtool(5) +============================ +:doctype: manpage + +NAME +---- +sysdbd-timeseries-rrdtool - timeseries::rrdtool plugin + +SYNOPSIS +-------- + LoadPlugin timeseries::rrdtool + +DESCRIPTION +----------- +*timeseries::rrdtool* is a plugin which adds support for fetching time-series +data from RRD files. + +CONFIGURATION +------------- +*timeseries::rrdtool* does not currently accept any configuration options. + +SEE ALSO +-------- +manpage:sysdbd[1], manpage:sysdbd.conf[5], +http://oss.oetiker.ch/rrdtool + +The SysDB homepage: http://sysdb.io/ + +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 : + diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt index c742cc8..8c90812 100644 --- a/doc/sysdbd.conf.5.txt +++ b/doc/sysdbd.conf.5.txt @@ -18,6 +18,8 @@ SYNOPSIS LoadBackend "collectd::unixsock" LoadBackend "mk-livestatus" + LoadPlugin "timeseries::rrdtool" + Interval 1800 @@ -123,6 +125,14 @@ 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: ~~~~~~~~ @@ -145,6 +155,11 @@ Backend documentation: manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-mk-livestatus[5], manpage:sysdbd-puppet-store-configs[5] +Time-series fetcher documentation: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +manpage:sysdbd-timeseries-rrdtool[5] + Plugin documentation: ~~~~~~~~~~~~~~~~~~~~~ -- 2.30.2