Difference between revisions of "Plugin:E-Mail"

From collectd Wiki
Jump to: navigation, search
(Created initial page.)
 
(See also: New section.)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{List of Plugins}}
+
{{Infobox Plugin
== Description ==
+
  | Name=E-Mail
 +
  | Type=read
 +
  | Callbacks={{Callback|config}}, {{Callback|init}}, {{Callback|read}}, {{Callback|shutdown}}
 +
  | Status={{deprecated}}
 +
  | FirstVersion={{Version|3.11}}
 +
  | Copyright=''2006–2008'' Sebastian Harl
 +
  | License={{GPLv2}}
 +
  | Manpage={{Manpage|collectd.conf|5|plugin_email}}<br />{{Manpage|collectd-email|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 [http://spamassassin.apache.org/ SpamAssassin] can be found in <code>contrib/SpamAssassin/</code>.
  
The <em>E-Mail</em> 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 [http://spamassassin.apache.org/ SpamAssassin] can be found in <code>contrib/SpamAssassin/</code>.
+
Use of this plugin is <strong>deprecated</strong>. If you want to submit statistics to the daemon, for example about email messages, please use the [[Plugin:UnixSock|UnixSock]] plugin instead.
  
Use of this plugin is <strong>deprecated</strong>. If you want to submit statistics to the daemon, for example about email messages, please use the [[Plugin:UnixSock|UnixSock]] plugin instead.
+
Unfortunately most <em>mail transfer agents</em> (MTAs, also often inaccurately called "mail servers") do not offer an interface to get some statistics out of them. You can, however, use the [[Plugin:Tail|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 [[Plugin:FileCount|FileCount]] plugin.
  
 
== Synopsis ==
 
== Synopsis ==
  
    "SocketFile",
+
<Plugin email>
    "SocketGroup",
+
  SocketFile "/var/run/collectd-email"
    "SocketPerms",
+
  SocketGroup "mail"
    "MaxConns"
+
  SocketPerms 660
 +
  MaxConns 4
 +
</Plugin>
  
 
== Example graphs ==
 
== Example graphs ==
Line 20: Line 31:
  
 
* <em>none</em>
 
* <em>none</em>
 +
 +
== See also ==
 +
 +
* [http://spamassassin.apache.org/ SpamAssassin]
 +
* {{Plugin|UnixSock}}
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 +
{{DEFAULTSORT:E-mail}}

Latest revision as of 11:48, 13 January 2010

E-Mail plugin
Type: read
Callbacks: config, init, read, shutdown
Status: deprecated
First version: 3.11
Copyright: 2006–2008 Sebastian Harl
License: GPLv2
Manpage: collectd.conf(5)
collectd-email(5)
List of Plugins

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