From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 656A091A78 for ; Mon, 27 Mar 2023 14:22:42 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 50543A4AA for ; Mon, 27 Mar 2023 14:22:42 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Mon, 27 Mar 2023 14:22:41 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 4403646DE7 for ; Mon, 27 Mar 2023 14:22:41 +0200 (CEST) From: Dominik Csapak To: pmg-devel@lists.proxmox.com Date: Mon, 27 Mar 2023 14:22:40 +0200 Message-Id: <20230327122240.3412697-2-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230327122240.3412697-1-d.csapak@proxmox.com> References: <20230327122240.3412697-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.010 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pmg-devel] [PATCH pmg-docs v2 2/2] administration: add section for statistics X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 27 Mar 2023 12:22:42 -0000 by explaining each panel and it's options Signed-off-by: Dominik Csapak --- pmg-admin-guide.adoc | 2 + pmg-statistic.adoc | 113 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 115 insertions(+) create mode 100644 pmg-statistic.adoc diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc index 5ca2b0c..7c92781 100644 --- a/pmg-admin-guide.adoc +++ b/pmg-admin-guide.adoc @@ -31,6 +31,8 @@ include::pmg-mail-filter.adoc[] include::pmg-administration.adoc[] +include::pmg-statistic.adoc[] + include::pmgbackup.adoc[] include::pmgcm.adoc[] diff --git a/pmg-statistic.adoc b/pmg-statistic.adoc new file mode 100644 index 0000000..58e4d77 --- /dev/null +++ b/pmg-statistic.adoc @@ -0,0 +1,113 @@ +Statistics +========== + +{pmg} offers a useful and feature-rich statistics interface, which allows the +administrators 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 main 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 not containing a virus) +* SPF rejects +* Bounces (mails with an empty envelope-sender address) +* Virus Mails + +'Outgoing Mails':: + +Shows the outgoing mail counts as a graph and the following details +(as counts and percentages of the outgoing mail volume): + +* Outgoing Mails +* Bounces (mails with an empty envelope-sender address) +* Virus Mails + +Spam Scores +----------- + +This panel shows the distribution 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[postscreen readme]. + +Domain +------ + +Contains 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 +-------- + +Similar 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 list of external recipients that received mail from this +{pmg}, coming in on the internal port, 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