From 5ad8f83646dae13f78c76b14a861a4a50019574f Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Wed, 18 Nov 2020 10:46:32 -0600 Subject: [PATCH] Improve docs --- examples/etc/pgwui.ini | 13 +++++++++---- examples/misc/development.ini | 21 +++++++++++++++------ 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/examples/etc/pgwui.ini b/examples/etc/pgwui.ini index bfe5a4e..5bf231c 100644 --- a/examples/etc/pgwui.ini +++ b/examples/etc/pgwui.ini @@ -180,12 +180,16 @@ port = 6543 ### # logging configuration # http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html +# +# Configures logging via both syslog(3) and stderr, the latter being +# suitable for a systemd service. ### [loggers] keys = root, pgwui_server, pgwui_upload [handlers] +# Both syslog and stderr keys = syslog, console [formatters] @@ -210,10 +214,11 @@ formatter = generic [formatter_generic] format = %(asctime)s %(levelname)-5.5s [%(name)s][%(threadName)s] %(message)s -# These sections don't do anything as given. They are provided so that -# logging can be customized per pgwui package. You may want to add -# "propagate = False" lines to avoid duplicate logging if you customize -# them to emit log messages. +# These sections don't do anything as given. Because they have no +# handler they emit no messages. They are provided so that logging +# can be customized per pgwui package. You may want to add +# "propagate = False" lines to avoid duplicate logging if you +# customize them to emit log messages. [logger_pgwui_server] level = INFO diff --git a/examples/misc/development.ini b/examples/misc/development.ini index c613b1b..645de43 100644 --- a/examples/misc/development.ini +++ b/examples/misc/development.ini @@ -89,7 +89,7 @@ pgwui.validate_hmac = False # PGWUI components in use. The display value of the menu items can # be overridden using a "menu_label" setting for each component. # CAUTION: Do not uncomment the below, instead change the component's -# "menu_label" setting. +# "menu_label" setting. E.g.: #pgwui.pgwui_upload = # menu_label = upload -- Upload File Into Database @@ -180,9 +180,14 @@ port = 6543 ### # logging configuration # http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html +# +# Emit all logs, and stdout from the application, to stderr. +# Configured so that logs are viewable from the terminal window used +# to run pserve. ### [loggers] +# See per-component loggers below keys = root, pgwui_server, pgwui_upload [handlers] @@ -192,7 +197,7 @@ keys = console keys = generic [logger_root] -level = INFO +level = DEBUG handlers = console [handler_console] @@ -204,10 +209,14 @@ formatter = generic [formatter_generic] format = %(asctime)s %(levelname)-5.5s [%(name)s][%(threadName)s] %(message)s -# These sections don't do anything as given. They are provided so that -# logging can be customized per pgwui package. You may want to add -# "propagate = False" lines to avoid duplicate logging if you customize -# them to emit log messages. +# +# Per-component logger configuration +# +# These sections don't do anything as given. Because they have no +# handler they emit no messages. They are provided so that logging +# can be customized per pgwui package. You may want to add +# "propagate = False" lines to avoid duplicate logging if you +# customize them to emit log messages. [logger_pgwui_server] level = DEBUG -- 2.34.1