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)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 671A16E39F for ; Mon, 23 Aug 2021 15:20:35 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 57B9F242BC for ; Mon, 23 Aug 2021 15:20:05 +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)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id D07E4242A9 for ; Mon, 23 Aug 2021 15:20:00 +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 E86D143688 for ; Mon, 23 Aug 2021 15:15:20 +0200 (CEST) From: Mira Limbeck To: pmg-devel@lists.proxmox.com Date: Mon, 23 Aug 2021 15:15:18 +0200 Message-Id: <20210823131518.1262023-2-m.limbeck@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210823131518.1262023-1-m.limbeck@proxmox.com> References: <20210823131518.1262023-1-m.limbeck@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.134 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment KAM_LAZY_DOMAIN_SECURITY 1 Sending domain does not have any anti-forgery methods NO_DNS_FOR_FROM 0.001 Envelope sender has no MX or A DNS records SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_NONE 0.001 SPF: sender does not publish an SPF Record Subject: [pmg-devel] [PATCH pmg-docs 2/2] add documentation for the pmg-log-tracker 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, 23 Aug 2021 13:20:35 -0000 The Tracking Center makes assumptions which are working fine for most of the users, but not for some. It might be useful for some users to know that this exists and is the backend for the Tracking Center. Signed-off-by: Mira Limbeck --- pmg-admin-guide.adoc | 2 ++ pmg-log-tracker.adoc | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 pmg-log-tracker.adoc diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc index 043b94a..5ca2b0c 100644 --- a/pmg-admin-guide.adoc +++ b/pmg-admin-guide.adoc @@ -79,6 +79,8 @@ include::pmgreport.adoc[] include::pmgupgrade.adoc[] +include::pmg-log-tracker.adoc[] + :leveloffset: 1 include::nmap.adoc[] diff --git a/pmg-log-tracker.adoc b/pmg-log-tracker.adoc new file mode 100644 index 0000000..ac023a1 --- /dev/null +++ b/pmg-log-tracker.adoc @@ -0,0 +1,36 @@ +[[chapter_pmg-log-tracker]] +ifndef::manvolnum[] +pmg-log-tracker - Backend for the Tracking Center +================================================= +:pmg-toplevel: +endif::manvolnum[] + +`pmg-log-tracker` is the backend for the Tracking Center. It parses the syslog +files in `/var/log/` for mail information. If a different file should be parsed, +e.g. the mail log, it can be specified with the `-i` option. + +An example parsing the mail.log and getting everything between the first of July +and the 15th of July would be possible with the following command. +---- +pmg-log-tracker -i /var/log/mail.log -s "2021-07-01 00:00:00" -e "2021-07-15 23:59:59" +---- + +Starttime `-s` and endtime `-e` are optional, by default the endtime will be +now and the starttime 0:00 of the same day. + +With the `--verbose` option additional info will be printed, mainly the +complete log for every mail. + +It is also possible to filter the log entries based on hostname, from address, +to address and other parameters. For a complete overview of all available +options, see `pmg-log-tracker --help` and `man pmg-log-tracker`. + +As a side effect of parsing the syslog, which doesn't contain information about +the year of the entries, the year passed to the `-s` and `-e` options has to +be the current one, not the one the logs were actually created. + + +ifdef::manvolnum[] +include::pmg-copyright.adoc[] +endif::manvolnum[] + -- 2.30.2