Skip to content
Florian Forster edited this page Nov 20, 2023 · 1 revision
Name: UnixSock plugin
Type: other
Callbacks: config, init, shutdown
Status: supported
FirstVersion: 4.0
Copyright: 2007–2008 Florian octo Forster
License: MIT License
Manpage: collectd.conf(5), collectd-unixsock(5)
See also: List of Plugins

The UnixSock plugin opens a UNIX domain socket and accepts connections. Using this socket one can send commands to the daemon and receive information. The protocol used is documented in the collectd-unixsock(5) manual page and in the Plain-text-protocol wiki page.

This plugin is a generic plugin, i.e. it cannot work without configuration, because there is no reasonable default behavior. Please read the Plugin unixsock section of the collectd.conf(5) manual page for an in-depth description of the plugin's configuration.

Synopsis

 LoadPlugin unixsock
 # ...
 <Plugin unixsock>
   SocketFile "/path/to/socket"
   SocketGroup "collectd"
   SocketPerms "0770"
   DeleteSocket true
 </Plugin>

Dependencies

  • none

Examples

collectdctl listval # collectdctl is available since version 5.0.0

 echo "PUTNOTIF severity=okay time=$(date  %s) message=hello" | \
   socat - UNIX-CLIENT:/path/to/socket

See also

Clone this wiki locally