public inbox for pmg-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Mira Limbeck <m.limbeck@proxmox.com>
To: pmg-devel@lists.proxmox.com
Subject: [pmg-devel] [PATCH pmg-docs 2/2] add documentation for the pmg-log-tracker
Date: Mon, 23 Aug 2021 15:15:18 +0200	[thread overview]
Message-ID: <20210823131518.1262023-2-m.limbeck@proxmox.com> (raw)
In-Reply-To: <20210823131518.1262023-1-m.limbeck@proxmox.com>

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@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





  reply	other threads:[~2021-08-23 13:20 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-23 13:15 [pmg-devel] [PATCH pmg-docs 1/2] add pmgqm timespan and timer/service edit info Mira Limbeck
2021-08-23 13:15 ` Mira Limbeck [this message]
2021-08-24  7:26 ` Dylan Whyte

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210823131518.1262023-2-m.limbeck@proxmox.com \
    --to=m.limbeck@proxmox.com \
    --cc=pmg-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal