Update the logging config actor configuration format #1204
Merged
Conversation
This file contains hidden or 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
llucax
requested review from
ela-kotulska-frequenz
and removed request for
a team
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR updates the logging configuration to be compatible with the UI‐generated configuration by requiring the logger name to be specified explicitly, and by separating the root logger configuration from individual logger configurations.
- Introduces a new RootLoggerConfig type for root logger settings
- Updates tests and configuration parsing to use explicit logger names
- Adjusts logging configuration actor to use the new naming scheme
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/config/test_manager.py | Adds explicit logger name in configuration tests |
| tests/config/test_logging_actor.py | Updates logger configuration tests to match the new format |
| src/frequenz/sdk/config/_logging_actor.py | Introduces RootLoggerConfig and updates logging configuration logic |
| src/frequenz/sdk/config/init.py | Updates exports to expose the new RootLoggerConfig |
| mkdocs.yml | Updates documentation formatting options |
| RELEASE_NOTES.md | Documents the logging config changes |
Comments suppressed due to low confidence (1)
src/frequenz/sdk/config/_logging_actor.py:28
- Consider decorating RootLoggerConfig with @DataClass (or an equivalent construct) for consistency with LoggerConfig and to ensure automatic generation of methods such as init.
class RootLoggerConfig:
shsms
previously approved these changes
May 9, 2025
RELEASE_NOTES.md
Outdated
| level = "DEBUG" | ||
| ``` | ||
|
|
||
| - Now: |
There was a problem hiding this comment.
Not aligned with the previous - Before: I guess?
github-project-automation
bot
moved this from Review in progress
to Review approved
in Python SDK Roadmap
ela-kotulska-frequenz
previously approved these changes
May 9, 2025
This configuration was at the wrong level. Signed-off-by: Leandro Lucarella <[email protected]>
The logging configuration was changed to make it compatible with the configuration generated by the UI, which doesn't quote sub-key properly. To do this, the logger name needs to be specified explicitly now (the configuration key was used as the name before). Signed-off-by: Leandro Lucarella <[email protected]>
|
Fixed release notes indentation issue and rebased to fix conflicts. |
llucax
commented
May 9, 2025
| level = "DEBUG" | ||
| ``` | ||
|
|
||
| - Now: |
There was a problem hiding this comment.
Still somehow GitHub gets confused about this...
shsms
approved these changes
May 9, 2025
github-project-automation
bot
moved this from Review approved
to Done
in Python SDK Roadmap
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The logging configuration was changed to make it compatible with the configuration generated by the UI, which doesn't quote sub-key properly.
To do this, the logger name needs to be specified explicitly now (the configuration key was used as the name before).