Introduce LOGGING_OVERRIDE config var #18
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
Co-Authored-By: Daniel Fangl <[email protected]>
Co-authored-by: Dominik Schubert <[email protected]>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Introduced a new experimental configuration variable 'LOGGING_OVERRIDE' to allow setting custom log levels for individual loggers, primarily for debugging purposes.
- Added
LOGGING_OVERRIDEinlocalstack/config.pyfor fine-grained logger control - Implemented parsing and application of logging overrides in
localstack/logging/setup.py - Created
parse_key_value_pairsfunction inlocalstack/utils/collections.pyto handle override parsing - Added unit tests for
parse_key_value_pairsintests/unit/utils/test_collections.py - Feature is not intended for general use documentation, as it's a temporary solution
4 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings
Comment on lines
+85
to
+92
| logging_overrides = parse_key_value_pairs(raw_logging_override) | ||
| for logger, level_name in logging_overrides.items(): | ||
| level = getattr(logging, level_name, None) | ||
| if not level: | ||
| raise RuntimeError( | ||
| f"Failed to configure logging overrides ({raw_logging_override}): '{level_name}' is not a valid log level" | ||
| ) | ||
| logging.getLogger(logger).setLevel(level) |
There was a problem hiding this comment.
style: Potential performance impact if many overrides are specified. Consider caching results
Comment on lines
+93
to
+98
| except RuntimeError: | ||
| raise | ||
| except Exception as e: | ||
| raise RuntimeError( | ||
| f"Failed to configure logging overrides ({raw_logging_override})" | ||
| ) from e |
There was a problem hiding this comment.
style: Catch specific exceptions instead of using a broad except clause
Comment on lines
+547
to
+549
| items = pair.split("=") | ||
| if len(items) != 2: | ||
| raise ValueError(f"invalid key/value pair: '{pair}'") |
There was a problem hiding this comment.
style: Consider using a more robust parsing method, such as shlex.split(), to handle cases where values might contain commas
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.
Motivation
While debugging DNS issues, we found the need to add additional logging to help debugging, but only for a specific module. The DNS resolution process is too noisy to use current debug logs.
See localstack#10809 for an application of this new config feature.
Changes
@dfangl suggested we support a per-logger override for the log level. This would mean that if we are interested in a specific logger (or can disable some logs), we can specify this in a structured environment variable.
Note: we are planning on re-working the logging overall, so this functionality should only be used in specific cases, to enable more detailed logs for specific aspects of LocalStack's internals, and not documented.