Mail package TPmail for Unix systems

Language

[eng] [rus]

Module sma_stat. Description and work.

Module sma_stat
Features list of sma_stat
Options of module sma_stat
Configuration file for sma_stat
Usage examples
Sample of configuration file
Reports samples

Module sma_stat is provided a mail traffic statistics as reports using HTML or ASCII formats. The program sma_stat reads as input the logs of sendmail (usually this is maillog), and then, using a given configuration file, builds the reports files. The reports can be done for many servers (it is possible to collect logs of sendmail for these servers into one combined log). It is possible to a various configuration files to build a wanted reports. When a mail traffic volume is enough big then a usage of all options is given the waste of the disk space. For example, the reports with all options are processed about 20000 messages/connects will be wasted the disk space upto 100 Megabytes.

Module sma_stat can provided the following statistics about mail traffic:

- common summary info for the time interval (messages/connects, traffic volume and others.);
- common summary info for week period (messages/connects, traffic volume and others);
- summary info for the time interval for hosts (relays);
- summary info for the time interval for recipients (abonents);
- detail information for the time interval for domains;
- detail information for the time interval for envelopes messages;
- detail information for the time interval for relays;
- detail information for the time interval for milter rejects;
- detail information for the time interval for ruleset rejects;
- additional info for the time interval as unknown users and others;
- support of links to other reports as messages archive, anti-spam filter statistics ÓÔÁÔÉÓÔÉËÁ and other specialized reports;

A program sma_stat is supported the following options of command line
(they is also described in the standard manual man for sma_stat):

Option	Purpose
-h	short help
-a	format output as ASCII (default=HTML)
-g	print general information (default=no)
-q	print domains information for relays (default=no)
-u	print unknown messages list of sendmail (default=no)
-z	print unknown user messages list (default=no)
-o	print other messages list of sendmail (default=no)
-n	print domains information for envelopes (default=no)
-m	print milter rejects information (default=no)
-s	print ruleset rejects information (default=no)
-e	print envelope information (default=no)
-i	print index html file (default=no)
-r	print relays information (default=no)
-t	print TLS/SSL messages list of sendmail (default=no)
-j	print non-active clients messages list (default=no)
-x	print recipients summary information (default=no)
-y	print relays summary information (default=no)
-w	print weekly summary information (default=no)
-k	print messages/rejects statistics in plain ASCII (default=no)
-c config	configuration file name (default=/usr/local/etc/sma_stat.conf)
-v	verbose
-p	enable time profiling
-P	disable mergesort
-B outdir	output base catalog (default=current catalog)
-L logfile	logging file (default=/var/log/sma_stat.log)
-f infile	input file (logfile of sendmail)
-G outfile	output file of general info (option -g)
-Q outfile	output file of domains info for relays (option -q)
-N outfile	output file of domains info for envelopes (option -n)
-R outfile	output file of relays info (option -r)
-E outfile	output file of envelope info (option -e)
-M outfile	output file of milter reject info (option -m)
-S outfile	output file of sendmail ruleset rejects info (option -s)
-O outfile	output file of all other messages of sendmail (option -o)
-T outfile	output file of all TLS/SSL messages of sendmail (option -t)
-J outfile	output file of all non-active clients messages (option -j)
-U outfile	output file of all unknown messages of sendmail (option -u)
-X outfile	output file of summary info for recipients (otion -x)
-Y outfile	output file of summary info for relays (option -y)
-Z outfile	output file of all unknown user messages (option -z)
-I outfile	main HTML output file (option -i),(default=index.html)
-K outfile	output file of messages/rejects statistics (option -k)
-l licensekey	user license key file (default=/usr/local/etc/tpmail.key)
-d level	debugging level (default=0)
-V	print version

The configuration file for sma_stat is the almost identical the command line options with these exceiptions:
1) can be done the split of large HTML files into more small pieces;
2) can be done the links to reports from other programs;

It is recommended to use the configuration file.

The module sma_stat has a ready scripts to build the statistics reports:
sma_stat_current.sh, sma_stat_daily.sh, weekly_mail_report.sh

Samples usage.

Sample 1.
Build only the common statistics in the text format.
# /usr/local/bin/sma_stat -f /var/log/maillog -ag -G general.asc

Sample 2.
Build all the statistics in the HTML format and place all reports on the Web server. Assume that all neccessary options are present in the configuration file.
# /usr/local/bin/sma_stat -B /usr/local/www/data/mailstat/current -f /var/log/maillog

Configuration file sample (it can be found in TPmail distribution): sma_stat.conf.sample

Reports samples.

A weekly report: weekly_report.html
A start page of reports: index.html
A start page of common summary info per day: general.html
A page of common summary info for rejects per day: milter_rejects_by_reason_count.html
A page of hosts distributiuon per country for day (sorted by name):
relay_domains_by_name_level_1.html
A page of accepted messages per day (sorted by messages number): envelope_pairs_by_count.html
A page of rejects per day (sorted by name): milter_rejects_by_recipient_name.html

Last modified: $Date: 2008-01-04 19:14:47+03 $

Mail package TPmail for Unix systems

Language

Home

Documentation

Support

News

Resources

Contacts

Module sma_stat. Description and work.

Contents