sysdb: Use a custom output format instead of pretty-printed JSON.

[sysdb.git] / doc / sysdbd-collectd-unixsock.5.txt

diff --git a/doc/sysdbd-collectd-unixsock.5.txt b/doc/sysdbd-collectd-unixsock.5.txt
index 6add73fe8c5549ce62b56f22ad7bee03b8dc5c59..acb98d98c4bca20ffd90d2ef5730d34408400d90 100644 (file)
--- a/doc/sysdbd-collectd-unixsock.5.txt
+++ b/doc/sysdbd-collectd-unixsock.5.txt
@@ -15,6 +15,8 @@ SYNOPSIS
   <Backend "collectd::unixsock">
       <Instance "collector">
           Socket "/var/run/collectd-unixsock"
+          TimeseriesBackend "rrdtool"
+          TimeseriesBaseURL "/var/lib/collectd/rrd"
       </Instance>
   </Backend>
 
@@ -22,8 +24,7 @@ DESCRIPTION
 -----------
 *collectd::unixsock* is a backend module which queries the system statistics
 collection daemon *collectd* using its *unixsock* interface. It connects to
-the daemon and periodically queries all hosts and metric names. The latter are
-then stored as services of the respective host.
+the daemon and periodically queries all hosts and metric names.
 
 CONFIGURATION
 -------------
@@ -40,9 +41,24 @@ CONFIGURATION
                The path name of the UNIX domain socket provided by collectd's
                *unixsock* plugin.
 
+       *TimeseriesBackend* '<type>';;
+               The data-store type to be used to query time-series information of a
+               metric. This setting relates to a collectd writer plugin. The
+               data-store needs to be accessible from SysDB and the type needs to be
+               supported by SysDB (through an appropriate time-series fetcher
+               plugin like, for example, *timeseries::rrdtool*).
+
+       *TimeseriesBaseURL* '<url>';;
+               The base URL for time-series data. This may be a path-name or a
+               network address depending on the time-series backend type.
+
 SEE ALSO
 --------
-manpage:sysdbd[1], manpage:sysdbd.conf[5]
+manpage:sysdbd[1], manpage:sysdbd.conf[5],
+manpage:sysdbd-timeseries-rrdtool[5],
+https://collectd.org/, https://collectd.org/wiki/index.php/Plugin:UnixSock
+
+The SysDB homepage: https://sysdb.io/
 
 AUTHOR
 ------