Mailstats
Version
Mailstats
Brian Read's mailstats contrib analyzes your qpsmtpd log files and sends a periodic email to the address you specify summarizing your server's email activity.
The latest version also supports storing your mail server statistics in a MySQL database. You could potentially configure several servers to store their statistics in one central database in order to get consolidated statistics from several servers.
Read the original announcement here: http://forums.contribs.org/index.php?topic=40651.0
Installation
yum install --enablerepo=smecontribs smeserver-mailstats
for SME11, the command will be:
dnf install smeserver-mailstats
This is TBA, and will released with SME11 full release.
Configuration
If you install mailstats you should review the latest documentation, which is kept in the script itself. You can review the script after installation using:
less /usr/bin/spamfilter-stats-7.pl
The configuration options are listed below.
Create the report db entry
config set mailstats report
Status
config setprop mailstats Status ("enabled"|"disabled")
Column Header
(defaults to "auto") Column Header entries are created and set to "yes" if a non zero count is detected (they may not exist before). "Yes" means that that column is then always shown. If you delete the entry or set it to "auto" then it will only show if a non zero occurs again (and then get set to "yes").(enable, supress or only show if nonzero)
config setprop mailstats <column header> ("yes"|"no"|"auto")
QpsmtpCodes
Show league table of qpsmtd result codes (default to "enabled")
config setprop mailstats QpsmtpdCodes ("enabled"|"disabled")
See this note for more information about the qpsmtpd LogLevel setting: Updating_to_SME_7.2#qpsmtpd_LogLevel
SpamAssassin rules
Show league table of Spamassasin rules applied. (default to "enabled")
config setprop mailstats SARules ("enabled"|"disabled")
JunkMailList
Show listing of each user and number of junkmail emails left, in descending order of number (default to "enabled")
config setprop mailstats JunkMailList ("enabled"|"disabled")
SpamAssassin Rule Percent Threshold
Set a threshold for report cutoff
config setprop mailstats SARulePercentThreshold (0.5)
Email to send report
config setprop mailstats Email (admin) - email to send report
Save data to MySQL database
(default is "no")
config setprop mailstats SaveDataToMySQL ("yes"|"no")
MySQL server hostname
(default is "localhost")
config setprop mailstats server <hostname>
MySQL server port
(default is "3306")
config setprop mailstats DBPort <####>
Reporting Interval
Length of time to report on (default is "day")
config setprop mailstats Interval ("day"|"week"|"fortnight"|"month"|"#####"))
Note: a number is interpreted as seconds. Also note that lengthening the report interval does not change the interval summary at the moment, this means you will still get an hourly summary over whatever period you run the report.
Base
What time to base the report (default is "Midnight")
config setprop mailstats Base ("Midnight"|Midday"|"Now"|"##")
Note: a number is interpreted as the hour of the day (0-23)
Additional Notes
Handling @*.u Logfiles
Multilog occasionally generates log files that end in ".u" instead of ".s". The multilog manual says this:
- .s: This file is completely processed and safely written to disk.
- .u: This file was being created at the moment of an outage. It may have been truncated. It has not been processed.
The latest version of mailstats.cron will process "@*" and "current", so will catch all log files. Earlier versions only processed "*.s" and "current".
However in the early days of an installation, there will be only the "current" file, this leads to a nightly error message:
Can't open /var/log/qpsmtpd/@*: No such file or directory
This is only a minor issue as it 'solves' itself once logrotate creates the .u or .s files.
You can eliminate this issue by forcing a qpsmtpd log rotation as described at http://wiki.contribs.org/Email_Statistics#Force_first_log_rotation
Manual report generation
You can use the following command to generate a report
perl /usr/bin/mailstats.pl /var/log/qpsmtpd/@* /var/log/qpsmtpd/current
Bug Reporting & Tracking
Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-mailstats component or use this link: smeserver-mailstats
smeserver-mailstats - Outstanding bugs
| ID | Product | Version | Status | Summary (18 tasks) ⇒ |
|---|---|---|---|---|
| 13422 | SME Contribs | Futur | CONFIRMED | Geoip table percentage does not have percent sign unlike all the other tables) |
| 13393 | SME Contribs | Futur | CONFIRMED | Add floating buttons that allow back and forward without loosing scrolled position. |
| 13327 | SME Contribs | 11.0 | CONFIRMED | NFR: add nightly postfix stats from/similar to logwatch |
| 13320 | SME Contribs | Futur | CONFIRMED | Javascript failures on front panel |
| 13242 | SME Contribs | 11.0 | CONFIRMED | Make the report and html work for other languages. |
| 13241 | SME Contribs | 11.0 | CONFIRMED | External connection count is very much higher than table indicates |
| 13236 | SME Contribs | 11.0 | CONFIRMED | Add arithmetic test/comparison of totals versus broken down totals |
| 13233 | SME Contribs | 11.0 | CONFIRMED | Wrong DB user created |
| 13216 | SME Contribs | 11.0 | CONFIRMED | spam Blacklist result ignored by Mailstats |
| 13204 | SME Contribs | 11.0 | RESOLVED | Fix Apache 2.4 directive to control access to /opt/mailstats |
| 13197 | SME Contribs | 11.0 | CONFIRMED | Add mailstats version to left hand table |
| 13196 | SME Contribs | 11.0 | CONFIRMED | Geoip Percentage column does not have % sign |
| 13121 | SME Contribs | 11.0 | RESOLVED | Overall Development and testing of smeserver-mailstats during SME11 beta |
| 13118 | SME Contribs | 11.0 | RESOLVED | Initial install does not create Status DB entry |
| 13117 | SME Contribs | 11.0 | RESOLVED | SME11 Mailstats Run time error |
| 13116 | SME Contribs | 11.0 | RESOLVED | First version for SME11, with SM2 panel |
| 12841 | SME Contribs | 11.0 | RESOLVED | Update Mailstats (perl and python) to accommodate SME11 log format. |
| 10251 | SME Contribs | Futur | CONFIRMED | NFR re add spamassassin tag stats |
