[pmg-devel] [PATCH pmg-docs 2/2] add documentation for the pmg-log-tracker

[Mira Limbeck]

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 <m.limbeck at proxmox.com>
---
 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