From: Karl O. Pinc <kop@karlpinc.com>
Date: Tue, 3 Sep 2024 16:40:31 +0000 (-0500)
Subject: Better documentation of the logging handlers
X-Git-Url: https://papio.biology.duke.edu/gitweb/?a=commitdiff_plain;h=0daa95e73fd05b47e3bbf4a9d3171664236b67b9;p=pgwui_server

Better documentation of the logging handlers
---

diff --git a/examples/etc/pgwui.yaml b/examples/etc/pgwui.yaml
index 4f54db7..0284502 100644
--- a/examples/etc/pgwui.yaml
+++ b/examples/etc/pgwui.yaml
@@ -541,11 +541,15 @@ logging:
       format: '%(asctime)s [%(levelname)s]: %(name)s - %(message)s'
   handlers:
     console:
+      # "console" captures tracebacks, which the syslog handler does not
       class: logging.StreamHandler
       level: INFO
       stream: ext://sys.stdout
       formatter: console
     syslog:
+      # "syslog" logs to syslog (which then seems to log to journalctl).
+      # This seems to provide "hilighting" based on priority level in a way
+      # the console handler does not.
       class: logging.handlers.SysLogHandler
       level: INFO
       address: /dev/log