CRAYSAT-1890: Fix sat.waiting logger
#247
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
haasken-hpe
force-pushed
the
CRAYSAT-1890-fix-waiting-logger
branch
from
9e27a60 to
56cd776
Compare
|
Thank you both! I'll wait to merge this until after @annapoorna-s-alt has merged the feature/CRAYSAT-1740 branch to main, just so you don't have to deal with more changelog conflicts. |
The `LOGGER` was incorrectly created with `__file__` as the logger name instead of `__name__`. As a result, it was not included under the `sat` package logger's hierarchy, and the expected log handlers were not applied to messages logged by this module. Fix this by specifying `__name__` instead, so the logger has the name `sat.waiting`, which is under the `sat` logger. Test Description: Ran `sat bootsys shutdown --stage capture-state` followed by `sat bootsys boot --stage k8s-check --k8s-timeout 10` to force a `Waiter` subclass to timeout, so I could observe the error log message. As expected, it timed out waiting on new pods that were created by K8s Jobs to reach a running or completed state, and it emitted the correctly formatted log message of the form: ``` ERROR: Waiting for condition "..." timed out after 10 seconds ```
haasken-hpe
force-pushed
the
CRAYSAT-1890-fix-waiting-logger
branch
from
56cd776 to
4cd4178
Compare
|
I just rebased this on the latest main branch after merging @annapoorna-s-alt 's PR to merge the |
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.
Summary and Scope
The
LOGGERwas incorrectly created with__file__as the logger name instead of__name__. As a result, it was not included under thesatpackage logger's hierarchy, and the expected log handlers were not applied to messages logged by this module. Fix this by specifying__name__instead, so the logger has the namesat.waiting, which is under thesatlogger.Issues and Related PRs
Testing
Tested on:
Test description:
Ran
sat bootsys shutdown --stage capture-statefollowed bysat bootsys boot --stage k8s-check --k8s-timeout 10to force aWaitersubclass to timeout, so I could observe the error log message.As expected, it timed out waiting on new pods that were created by K8s
Jobs to reach a running or completed state, and it emitted the correctly
formatted log message of the form:
Risks and Mitigations
Very low risk logging fix.
Pull Request Checklist