1 sysdbd-collectd-unixsock(5)
2 ===========================
3 :doctype: manpage
5 NAME
6 ----
7 sysdbd-collectd-unixsock - collectd::unixsock plugin querying collectd
9 SYNOPSIS
10 --------
11 <LoadBackend "collectd::unixsock">
12 Interval 60
13 </LoadBackend>
15 <Backend "collectd::unixsock">
16 <Instance "collector">
17 Socket "/var/run/collectd-unixsock"
18 TimeseriesBackend "rrdtool"
19 TimeseriesBaseURL "/var/lib/collectd/rrd"
20 </Instance>
21 </Backend>
23 DESCRIPTION
24 -----------
25 *collectd::unixsock* is a backend module which queries the system statistics
26 collection daemon *collectd* using its *unixsock* interface. It connects to
27 the daemon and periodically queries all hosts and metric names.
29 CONFIGURATION
30 -------------
31 *collectd::unixsock* accepts the following configuration options:
33 *Instance* '<name>'::
34 An instance block specifies a connection to collectd. The specified
35 '<name>' is used to identify the connection internally but otherwise has
36 no special meaning.
37 +
38 An instance block accepts the following configuration options:
40 *Socket* '<path>';;
41 The path name of the UNIX domain socket provided by collectd's
42 *unixsock* plugin.
44 *TimeseriesBackend* '<type>';;
45 The data-store type to be used to query time-series information of a
46 metric. This setting relates to a collectd writer plugin. The
47 data-store needs to be accessible from SysDB and the type needs to be
48 supported by SysDB (through an appropriate time-series fetcher
49 plugin like, for example, *timeseries::rrdtool*).
51 *TimeseriesBaseURL* '<url>';;
52 The base URL for time-series data. This may be a path-name or a
53 network address depending on the time-series backend type.
55 SEE ALSO
56 --------
57 manpage:sysdbd[1], manpage:sysdbd.conf[5],
58 manpage:sysdbd-timeseries-rrdtool[5],
59 https://collectd.org/, https://collectd.org/wiki/index.php/Plugin:UnixSock
61 The SysDB homepage: https://sysdb.io/
63 AUTHOR
64 ------
65 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
67 COPYRIGHT
68 ---------
69 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
71 This is free software under the terms of the BSD license, see the source for
72 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
73 FITNESS FOR A PARTICULAR PURPOSE.
75 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :