1EXIMSTATS(8)                         EXIM                         EXIMSTATS(8)
2
3
4

NAME

6       eximstats - generates statistics from Exim mainlog or syslog files.
7

SYNOPSIS

9        eximstats [Output] [Options] mainlog1 mainlog2 ...
10        eximstats -merge [Options] report.1.txt report.2.txt ... > weekly_report.txt
11
12   Output:
13       -txt
14           Output the results in plain text to STDOUT.
15
16       -txt=filename
17           Output the results in plain text. Filename '-' for STDOUT is
18           accepted.
19
20       -html
21           Output the results in HTML to STDOUT.
22
23       -html=filename
24           Output the results in HTML. Filename '-' for STDOUT is accepted.
25
26       -xls
27           Output the results in Excel compatible Format to STDOUT.  Requires
28           the Spreadsheet::WriteExcel CPAN module.
29
30       -xls=filename
31           Output the results in Excel compatible format. Filename '-' for
32           STDOUT is accepted.
33
34   Options:
35       -hnumber
36           histogram divisions per hour. The default is 1, and 0 suppresses
37           histograms. Valid values are:
38
39           0, 1, 2, 3, 5, 10, 15, 20, 30 or 60.
40
41       -ne Don't display error information.
42
43       -nr Don't display relaying information.
44
45       -nr/pattern/
46           Don't display relaying information that matches.
47
48       -nt Don't display transport information.
49
50       -nt/pattern/
51           Don't display transport information that matches
52
53       -qlist
54           List of times for queuing information single 0 item suppresses.
55
56       -tnumber
57           Display top <number> sources/destinations default is 50, 0
58           suppresses top listing.
59
60       -tnl
61           Omit local sources/destinations in top listing.
62
63       -t_remote_users
64           Include remote users in the top source/destination listings.
65
66       -include_original_destination
67           Include the original destination email addresses rather than just
68           using the final ones.  Useful for finding out which of your mailing
69           lists are receiving mail.
70
71       -show_dtlist
72           Show the delivery times (DT)for all the messages.
73
74           Exim must have been configured to use the +deliver_time logging
75           option for this option to work.
76
77           list is an optional list of times. Eg -show_dt1,2,4,8 will show the
78           number of messages with delivery times under 1 second, 2 seconds, 4
79           seconds, 8 seconds, and over 8 seconds.
80
81       -show_rtlist
82           Show the receipt times for all the messages. The receipt time is
83           defined as the Completed hh:mm:ss - queue_time_overall - the
84           Receipt hh:mm:ss.  These figures will be skewed by pipelined
85           messages so might not be that useful.
86
87           Exim must have been configured to use the +queue_time_overall
88           logging option for this option to work.
89
90           list is an optional list of times. Eg -show_rt1,2,4,8 will show the
91           number of messages with receipt times under 1 second, 2 seconds, 4
92           seconds, 8 seconds, and over 8 seconds.
93
94       -byhost
95           Show results by sending host. This may be combined with -bydomain
96           and/or -byemail and/or -byedomain. If none of these options are
97           specified, then -byhost is assumed as a default.
98
99       -bydomain
100           Show results by sending domain.  May be combined with -byhost
101           and/or -byemail and/or -byedomain.
102
103       -byemail
104           Show results by sender's email address.  May be combined with
105           -byhost and/or -bydomain and/or -byedomain.
106
107       -byemaildomain or -byedomain
108           Show results by sender's email domain.  May be combined with
109           -byhost and/or -bydomain and/or -byemail.
110
111       -pattern Description /Pattern/
112           Look for the specified pattern and count the number of lines in
113           which it appears.  This option can be specified multiple times. Eg:
114
115            -pattern 'Refused connections' '/refused connection/'
116
117       -merge
118           This option allows eximstats to merge old eximstat reports
119           together. Eg:
120
121            eximstats mainlog.sun > report.sun.txt
122            eximstats mainlog.mon > report.mon.txt
123            eximstats mainlog.tue > report.tue.txt
124            eximstats mainlog.wed > report.web.txt
125            eximstats mainlog.thu > report.thu.txt
126            eximstats mainlog.fri > report.fri.txt
127            eximstats mainlog.sat > report.sat.txt
128            eximstats -merge       report.*.txt > weekly_report.txt
129            eximstats -merge -html report.*.txt > weekly_report.html
130
131           •   You can merge text or html reports and output the results as
132               text or html.
133
134           •   You can use all the normal eximstat output options, but only
135               data included in the original reports can be shown!
136
137           •   When merging reports, some loss of accuracy may occur in the
138               top n lists.  This will be towards the ends of the lists.
139
140           •   The order of items in the top n lists may vary when the data
141               volumes round to the same value.
142
143       -charts
144           Create graphical charts to be displayed in HTML output.  Only valid
145           in combination with -html.
146
147           This requires the following modules which can be obtained from
148           http://www.cpan.org/modules/01modules.index.html
149
150           GD
151           GDTextUtil
152           GDGraph
153
154           To install these, download and unpack them, then use the normal
155           perl installation procedure:
156
157            perl Makefile.PL
158            make
159            make test
160            make install
161
162       -chartdirI <dir>
163           Create the charts in the directory <dir>
164
165       -chartrelI <dir>
166           Specify the relative directory for the "img src=" tags from where
167           to include the charts
168
169       -emptyok
170           Specify that it's OK to not find any valid log lines. Without this
171           we will output an error message if we don't find any.
172
173       -d  Debug flag. This outputs the eval()'d parser onto STDOUT which
174           makes it easier to trap errors in the eval section. Remember to add
175           1 to the line numbers to allow for the title!
176

DESCRIPTION

178       Eximstats parses exim mainlog and syslog files to output a statistical
179       analysis of the messages processed. By default, a text analysis is
180       generated, but you can request other output formats using flags. See
181       the help (-help) to learn about how to create charts from the tables.
182

AUTHOR

184       There is a website at https://www.exim.org - this contains details of
185       the mailing list exim-users@exim.org.
186

TO DO

188       This program does not perfectly handle messages whose received and
189       delivered log lines are in different files, which can happen when you
190       have multiple mail servers and a message cannot be immediately
191       delivered. Fixing this could be tricky...
192
193       Merging of xls files is not (yet) possible. Be free to implement :)
194
195
196
197perl v5.38.0                      2023-10-16                      EXIMSTATS(8)
Impressum