Configure basic top-level logger #212
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace hardcoded logger names with __name__. This also helps to enforce a logger hierarchy, i.e. "securesystemslib" overrules "securesystemslib.keys".
- remove obsolete comment (from when sslib was part of tuf) - reword docstring to disambiguate printing and logging
As pointed out by @FlorianVeaux in secure-systems-lab#210, securesystemslib does not correctly initialize its loggers. As a consequence the logging module logs a one-off "No handler could be found ..." warning when used for the first time (only on Python 2). The logging module then calls basicConfig, which attaches a basic StreamHandler to the root logger, to which securesystemslib's log messages are propagated. This commit adds the configuration of a simple securesystemslib top-level logger, with an attached StreamHandler and log level WARNING, to which all other securesystemslib loggers default. This removes the one-off warning, while providing a similar logging behavior as before and clear instructions (see added comments) on how to customize (format, silence, etc...) securesystemslib's logging.
|
@trishankatdatadog, @FlorianVeaux, please let me know if this works for you. |
FlorianVeaux
approved these changes
Feb 25, 2020
Merged
|
@FlorianVeaux, @trishankatdatadog: I just pushed v0.14.1 which includes the logging fixes. https://github.com/secure-systems-lab/securesystemslib/releases/tag/v0.14.1 |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue #:
Closes #210
Description of the changes being introduced by the pull request:
As pointed out by @FlorianVeaux in #210, securesystemslib does not correctly initialize its loggers. As a consequence the logging module logs a one-off "No handler could be found ..." warning when used for the first time (only on Python 2).
The logging module then calls basicConfig, which attaches a basic StreamHandler to the root logger, to which securesystemslib's log messages are propagated.
This PR adds the configuration of a simple securesystemslib top-level logger, with an attached StreamHandler and log level WARNING, to which all other securesystemslib loggers default.
This removes the one-off warning, while providing a similar logging behavior as before and clear instructions (see added comments) on how to customize (format, silence, etc...) securesystemslib's logging.
The PR further:
__name__logger naming conventionPlease verify and check that the pull request fulfils the following
requirements: