Skip to content

email plugin

Plugin name email
Type read
Callbacks config, init, read, shutdown
Status deprecated
Since 3.11
Copyright 2006–2008 Sebastian Harl
License GPLv2
Configuration collectd.conf(5)

The E-Mail plugin opens a UNIX domain socket and starts accepting connections on that socket. Clients can connect to this socket and submit statistics about email messages. A sample plugin for SpamAssassin can be found in contrib/SpamAssassin/.

Use of this plugin is deprecated. If you want to submit statistics to the daemon, for example about email messages, please use the UnixSock plugin instead.

Unfortunately most mail transfer agents (MTAs, also often inaccurately called "mail servers") do not offer an interface to get some statistics out of them. You can, however, use the Tail plugin to get statistics such as "number of rejected mails per second" out of the log files. Other information, such as the current queue length, may be acquired by the FileCount plugin.

Synopsis

 <Plugin email>
   SocketFile "/var/run/collectd-email"
   SocketGroup "mail"
   SocketPerms 660
   MaxConns 4
 </Plugin>

Example graphs

None yet. Add one now!

Dependencies

  • none

See also

Configuration

Configuration options · from collectd.conf(5)

See this section in the full configuration reference

SocketFile Path
Sets the socket-file which is to be created.
SocketGroup Group
If running as root change the group of the UNIX-socket after it has been created. Defaults to collectd.
SocketPerms Permissions
Change the file permissions of the UNIX-socket after it has been created. The permissions must be given as a numeric, octal value as you would pass to chmod(1). Defaults to 0770.
MaxConns Number
Sets the maximum number of connections that can be handled in parallel. Since this many threads will be started immediately setting this to a very high value will waste valuable resources. Defaults to 5 and will be forced to be at most 16384 to prevent typos and dumb mistakes.