sysdbd-collectd-unixsock(5)
===========================
:doctype: manpage

NAME
----
sysdbd-collectd-unixsock - collectd::unixsock plugin querying collectd

SYNOPSIS
--------
  <LoadBackend "collectd::unixsock">
      Interval 60
  </LoadBackend>

  <Backend "collectd::unixsock">
      <Instance "collector">
          Socket "/var/run/collectd-unixsock"
          TimeseriesBackend "rrdtool"
          TimeseriesBaseURL "/var/lib/collectd/rrd"
      </Instance>
  </Backend>

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.

CONFIGURATION
-------------
*collectd::unixsock* accepts the following configuration options:

*Instance* '<name>'::
	An instance block specifies a connection to collectd. The specified
	'<name>' is used to identify the connection internally but otherwise has
	no special meaning.
	+
	An instance block accepts the following configuration options:

	*Socket* '<path>';;
		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-timeseries-rrdtool[5],
https://collectd.org/, https://collectd.org/wiki/index.php/Plugin:UnixSock

The SysDB homepage: https://sysdb.io/

AUTHOR
------
SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.

COPYRIGHT
---------
Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>

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 :