[pmg-devel] [PATCH pmg-docs 2/2] administration: add section for statistics

[Dominik Csapak]

by explaining each panel and it's options

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 pmg-administration.adoc | 117 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 117 insertions(+)

diff --git a/pmg-administration.adoc b/pmg-administration.adoc
index 05f4589..c4b83c4 100644
--- a/pmg-administration.adoc
+++ b/pmg-administration.adoc
@@ -238,3 +238,120 @@ You can view the complete headers and filter by sender or receiver of
 queued emails.
 
 Here, you can also flush or delete each deferred email independently.
+
+
+[[pmg_statistics]]
+Statistics
+----------
+
+{pmg} offers a useful and feature-rich statistics interface, which allows the
+admins to quickly see the general workload and makes it easy to identify
+problems.
+
+The statistics are shown for the selected time range, which defaults to the
+current day, but can be changed to any other day, a whole month, or even a
+whole year.
+
+On the man statistics page there are three graphs with additional data:
+
+'Total Mail Count'::
+
+Shows the total mail flow as a graph and the following details:
+
+* Total Mails
+* Incoming/Outgoing Mails (as count and percentage)
+* Virus Outbreaks (the amount of outgoing virus mails)
+* Avg. Mail Processing Time
+* Incoming/Outgoing Mail Traffic
+
+'Incoming Mails'::
+
+Shows the incoming mail counts as a graph and the following details
+(as counts and percentages of the incoming mail volume):
+
+* Incoming Mails
+* Junk Mails (Virus + Spam + Greylisted + SPF rejects + RBL rejects)
+* Greylisted Mails
+* Spam Mails (Mails with Spamscore >= 3 and no virus)
+* SPF rejects
+* Bounces (mails without a sender)
+* Virus Mails
+
+'Outgoing Mails'::
+
+Shows the outgoing mail counts as a graph and the following details
+(as counts and percentages of the incoming mail volume):
+
+* Outgoing Mails
+* Bounces (mails without a sender)
+* Virus Mails
+
+Spam Scores
+~~~~~~~~~~~
+
+This panel shows the mail count and percentage of the different spam scores
+for the selected time frame.
+
+Virus Charts
+~~~~~~~~~~~~
+
+This panel shows which and how many viruses were detected in the selected
+time frame.
+
+Hourly Distribution
+~~~~~~~~~~~~~~~~~~~
+
+Shows the amount of incoming and outgoing mail per hour for the selected
+time frame.
+
+Postscreen
+~~~~~~~~~~
+
+Contains a chart with the RBL and pregreet rejects for the selected time frame.
+For more info about postscreen and pregreet tests, see the
+https://www.postfix.org/POSTSCREEN_README.html[postfix postscreen readme].
+
+Domain
+~~~~~~
+
+Here is a summary for the recipient domain of the incoming and outgoing mails
+of the selected time frame, with traffic, count, how many viruses were detected,
+and how much of it was spam.
+
+Sender
+~~~~~~
+
+This panel contains a list of e-mail addresses that sent mail out in the
+selected time frame, with a total count, how many viruses were detected and how
+big these mails were.
+
+If you click on one of these e-mail addresses, you see a detailed list of
+recipients, complete with size, date and time.
+
+Receiver
+~~~~~~~~
+
+Analog to the `Sender` panel, this contains a list of e-mail addresses that
+received e-mails from outside, with a total, spam and virus count, as well
+as the total mail size.
+
+If you click an entry, it shows a detailed list of mails with size, date,
+time, virus and spam score info.
+
+If the `advanced statistics filters` are active, only active accounts will be
+listed. Active accounts are those which sent mail in the selected time frame
+or up to 90 days before.
+
+Contact
+~~~~~~~
+
+This contains the reverse list to the `Receiver` panel, namely a list of
+external recipients that received mail from this {pmg}, with total count,
+virus count and size.
+
+If you click an entry, it shows a list of mails with size, date and time.
+
+If the `advanced statistics filters` are active, active accounts will be
+filtered out, since they can already be seen in the `Receiver` panel. Active
+accounts are those which sent mail in the selected time frame or up to 90 days
+before.
-- 
2.30.2