Set up standard logging module #2064

rlerm · 2021-09-05T17:26:31Z

Initial parts of #2063: Set up the root logger from the logging module. Make py3.log defer to that logger.

The root logger's configuration was built in a way that tries to preserve the existing behavior as much as possble.

This has the advantage of overall less custom code; as well as support for per-module configuration. This would enable a potential solution for ultrabug#1479, since in the future it can allow per-module configuration of log levels. I expect this to mainly help module creators, allowing them to enable logging for only their module, while disabling all other messages. It also is easier to use, since the `logging` module's interface is generally simpler than `self.py3`. Here, I've made the decision to keep the message format as close as possible to the existing log messages.

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

…2058)

closes ultrabug#2061

closes ultrabug#2062

This has the advantage of overall less custom code; as well as support for per-module configuration. This would enable a potential solution for ultrabug#1479, since in the future it can allow per-module configuration of log levels. I expect this to mainly help module creators, allowing them to enable logging for only their module, while disabling all other messages. It also is easier to use, since the `logging` module's interface is generally simpler than `self.py3`. Here, I've made the decision to keep the message format as close as possible to the existing log messages.

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

lgtm-com · 2021-09-05T17:34:36Z

This pull request introduces 1 alert when merging ac08112 into cafe0c7 - view on LGTM.com

new alerts:

1 for Unused import

ultrabug · 2021-09-07T19:42:19Z

Thanks @rlerm, this is a very promising first contribution to this project 🏅

When you say "initial parts" I guess you plan on adding things, is that correct? If so, please mark this PR as WIP and tell me when the time is right to review and test it please?

Also, you will want to demonstrate and document what this new logging system brings to the table and how to use it to achieve the goals you expressed in #2063 please

Thanks again

This has the advantage of overall less custom code; as well as support for per-module configuration. This would enable a potential solution for ultrabug#1479, since in the future it can allow per-module configuration of log levels. I expect this to mainly help module creators, allowing them to enable logging for only their module, while disabling all other messages. It also is easier to use, since the `logging` module's interface is generally simpler than `self.py3`. Here, I've made the decision to keep the message format as close as possible to the existing log messages.

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

…2058)

The JSON file will take over the entire configuration; it must fully specify logging as defined in https://docs.python.org/3/library/logging.config.html?highlight=logging#logging-config-dictschema

…odules.

This has the advantage of overall less custom code; as well as support for per-module configuration. This would enable a potential solution for ultrabug#1479, since in the future it can allow per-module configuration of log levels. I expect this to mainly help module creators, allowing them to enable logging for only their module, while disabling all other messages. It also is easier to use, since the `logging` module's interface is generally simpler than `self.py3`. Here, I've made the decision to keep the message format as close as possible to the existing log messages.

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

…2058)

This has the advantage of overall less custom code; as well as support for per-module configuration. This would enable a potential solution for ultrabug#1479, since in the future it can allow per-module configuration of log levels. I expect this to mainly help module creators, allowing them to enable logging for only their module, while disabling all other messages. It also is easier to use, since the `logging` module's interface is generally simpler than `self.py3`. Here, I've made the decision to keep the message format as close as possible to the existing log messages.

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

The Python library defaults to True, but that is a confusing behavior since it disables the "core" logger, which was created before logging was set up. Users can still set 'disable_existing_loggers' explicitly in their configs. Since most existing modules (who are using self.py3.log) will be logged by "core", that means that most logs would be suppressed.

Also, use it as the logging example in the docs.

rlerm · 2022-01-31T23:10:17Z

I've done the rebase, can you check it again? Thanks!

ultrabug · 2022-02-01T09:51:10Z

@rlerm as I'm trying to figure out how to get the same behavior as the current syslog state using your PR I fail to get a debug log to systemd but I don't get debug logs of the core/py3status if I try to use:

{
    "version": 1,
    "handlers": {
        "syslog": {
            "formatter": "default",
            "class": "logging.handlers.SysLogHandler"
        },
        "file": {
            "class": "logging.handlers.RotatingFileHandler",
            "filename": "/tmp/py3status_log.log",
            "maxBytes": 2048,
            "formatter": "default"
        }
    },
    "formatters": {
        "default": {
            "validate": false,
            "format":"%(asctime)s %(levelname)s %(module)s %(message)s",
            "datefmt":"%Y-%m-%d %H:%M:%S"
        }
    },
    "loggers": {
        "root": {"handlers": ["syslog"], "level": "DEBUG"},
        "core": {"handlers": ["syslog"], "level": "DEBUG"},
        "xrandr": {"handlers": ["file"], "level": "DEBUG"}
    }
}

what I am missing please?

rlerm · 2022-03-10T00:21:34Z

You were missing https://stackoverflow.com/a/3969772/340862: the syslog handler requires an "address" parameter (we are setting it correctly in the default setting in core.py.

By adding the same parameter to the json config, I am able to get the logs for core:

    "handlers": {
        "syslog": {
            "formatter": "default",
            "class": "logging.handlers.SysLogHandler",
            "address": "/dev/log"
        },
(...)

lgtm-com · 2022-10-02T14:14:14Z

This pull request introduces 1 alert when merging 0049671 into afeab68 - view on LGTM.com

new alerts:

1 for Variable defined multiple times

ultrabug · 2023-06-18T09:37:54Z

closing, I never got to the bottom of it and I apologize for this

recent updates would require work from you

rlerm and others added 14 commits August 22, 2021 21:01

Use standard logging infrastructure on "debug" statements.

3ed7e94

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

new sway_idle module: to display the idle state of sway wm (ultrabug#…

17d826d

…2058)

sway_idle module: chmod -x and remove useless encoding shebang

e085d93

speedtest module: fix error when clicking too fast, closes ultrabug#2060

56cf8b0

clock module: compatible with tzlocal 3.0, thx to @flyingapfopenguin

355c006

closes ultrabug#2061

version 3.39

e813cb9

make qa run tox

3a64b42

README: update readthedocs links to new documentation thx to @oceyral

07fe1b8

closes ultrabug#2062

i3 contrib page: update readthedocs links to new documentation

96dbe5b

i3 contrib page: update to sync with i3.github.io

9a9ee14

Use standard logging infrastructure on "debug" statements.

b4f49e2

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

Merge branch 'logging' of github.com:rlerm/py3status into logging

ac08112

Remove unused import.

25184cb

rlerm changed the title ~~Logging~~ Set up standard logging module Sep 5, 2021

rlerm added 2 commits September 5, 2021 17:39

Fix oversight: Make "info" be the default logging threshold.

c8421de

Fix syslog setup.

6a7229b

ultrabug mentioned this pull request Sep 7, 2021

Make logging from modules easier #2063

Open

rlerm and others added 9 commits September 18, 2021 16:44

Use standard logging infrastructure on "debug" statements.

ac9140c

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

new sway_idle module: to display the idle state of sway wm (ultrabug#…

0924f4a

…2058)

sway_idle module: chmod -x and remove useless encoding shebang

eeb38b0

i3 contrib page: update readthedocs links to new documentation

1bf1315

i3 contrib page: update to sync with i3.github.io

084d92a

Remove unused import.

fc6ab26

Fix oversight: Make "info" be the default logging threshold.

06f128d

Fix syslog setup.

480c87e

ultrabug and others added 22 commits January 31, 2022 19:56

sway_idle module: chmod -x and remove useless encoding shebang

531b45b

i3 contrib page: update readthedocs links to new documentation

62c6acc

i3 contrib page: update to sync with i3.github.io

c2260d1

Remove unused import.

868805a

Fix oversight: Make "info" be the default logging threshold.

abaaef5

Fix syslog setup.

fd41bf3

Allow configuring logging using a JSON file.

e56fb64

The JSON file will take over the entire configuration; it must fully specify logging as defined in https://docs.python.org/3/library/logging.config.html?highlight=logging#logging-config-dictschema

Add documentation explaining how to configure logging while testing m…

9bbbbe3

…odules.

Use standard logging infrastructure on "debug" statements.

7d8f5b9

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

new sway_idle module: to display the idle state of sway wm (ultrabug#…

664a006

…2058)

i3 contrib page: update readthedocs links to new documentation

58f00c3

Fix lint error.

1b2ba50

Use standard logging infrastructure on "debug" statements.

6277b64

Instead of checking for the "debug" option, we just log with the DEBUG level. The root logger's configuration will suppress log levels as needed.

Remove unused import.

ffd2f9e

Fix syslog handler, and eagerly import module.

70fa768

Run black formatter.

0ef5c3e

Run formatter.

bd3a338

Port the xrandr module to use the builtin logging library.

18817ac

Also, use it as the logging example in the docs.

Merge branch 'logging' of github.com:rlerm/py3status into logging

3e3ff6d

Merge branch 'master' into logging

0049671

ultrabug closed this Jun 18, 2023

lasers mentioned this pull request Jan 21, 2024

Set up standard logging module #2232

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set up standard logging module #2064

Set up standard logging module #2064

rlerm commented Sep 5, 2021

lgtm-com bot commented Sep 5, 2021

ultrabug commented Sep 7, 2021

rlerm commented Jan 31, 2022

ultrabug commented Feb 1, 2022

rlerm commented Mar 10, 2022

lgtm-com bot commented Oct 2, 2022

ultrabug commented Jun 18, 2023

Set up standard logging module #2064

Set up standard logging module #2064

Conversation

rlerm commented Sep 5, 2021

lgtm-com bot commented Sep 5, 2021

ultrabug commented Sep 7, 2021

rlerm commented Jan 31, 2022

ultrabug commented Feb 1, 2022

rlerm commented Mar 10, 2022

lgtm-com bot commented Oct 2, 2022

ultrabug commented Jun 18, 2023