feat: Add stream_name to structured logs#3680
Draft
edgarrmondragon wants to merge 1 commit into
Draft
Conversation
Signed-off-by: Edgar Ramírez Mondragón <edgarrm358@gmail.com>
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideIntroduce structured logging support for streams by wrapping loggers in LoggerAdapter instances that inject a stream_name field, and adjust typing and log formatter behavior to handle the new context field safely. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Documentation build overview
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- In
PluginBase.logger,logging.LoggerAdapteris constructed without the requiredextraargument, which will raise aTypeErrorat runtime; pass an explicitextradict (e.g.extra={}) when instantiating the adapter. - In
Stream.__init__, accessingtap.logger.logger.getChild(self.name)assumestap.loggeris aLoggerAdapter; it would be safer to rely on a documented interface or helper method rather than the.loggerattribute to avoid coupling to the adapter’s internal structure. - Updating
loggertype hints tologging.Logger | logging.LoggerAdapterin some places but not others may cause inconsistencies for callers; consider centralizing a common logger protocol or alias to keep the logger interface uniform across the SDK.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `PluginBase.logger`, `logging.LoggerAdapter` is constructed without the required `extra` argument, which will raise a `TypeError` at runtime; pass an explicit `extra` dict (e.g. `extra={}`) when instantiating the adapter.
- In `Stream.__init__`, accessing `tap.logger.logger.getChild(self.name)` assumes `tap.logger` is a `LoggerAdapter`; it would be safer to rely on a documented interface or helper method rather than the `.logger` attribute to avoid coupling to the adapter’s internal structure.
- Updating `logger` type hints to `logging.Logger | logging.LoggerAdapter` in some places but not others may cause inconsistencies for callers; consider centralizing a common logger protocol or alias to keep the logger interface uniform across the SDK.
## Individual Comments
### Comment 1
<location path="singer_sdk/plugin_base.py" line_range="215-221" />
<code_context>
@classproperty
- def logger(cls) -> logging.Logger: # noqa: N805
+ def logger(cls) -> logging.LoggerAdapter: # noqa: N805
"""Get logger.
Returns:
Plugin logger.
"""
- return logging.getLogger(cls.name)
+ return logging.LoggerAdapter(logging.getLogger(cls.name))
# Constructor
</code_context>
<issue_to_address>
**issue (bug_risk):** LoggerAdapter is instantiated without the required `extra` mapping.
`logging.LoggerAdapter` requires both a logger and an `extra` mapping. This call (`logging.LoggerAdapter(logging.getLogger(cls.name))`) will raise `TypeError` at runtime. Please pass an `extra` dict-like mapping, e.g. `logging.LoggerAdapter(logging.getLogger(cls.name), extra={"app_name": cls.name})` (or other appropriate metadata).
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+215
to
+221
| def logger(cls) -> logging.LoggerAdapter: # noqa: N805 | ||
| """Get logger. | ||
|
|
||
| Returns: | ||
| Plugin logger. | ||
| """ | ||
| return logging.getLogger(cls.name) | ||
| return logging.LoggerAdapter(logging.getLogger(cls.name)) |
Contributor
There was a problem hiding this comment.
issue (bug_risk): LoggerAdapter is instantiated without the required extra mapping.
logging.LoggerAdapter requires both a logger and an extra mapping. This call (logging.LoggerAdapter(logging.getLogger(cls.name))) will raise TypeError at runtime. Please pass an extra dict-like mapping, e.g. logging.LoggerAdapter(logging.getLogger(cls.name), extra={"app_name": cls.name}) (or other appropriate metadata).
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## main #3680 +/- ##
==========================================
- Coverage 94.12% 88.39% -5.74%
==========================================
Files 73 73
Lines 6200 6202 +2
Branches 762 763 +1
==========================================
- Hits 5836 5482 -354
- Misses 270 620 +350
- Partials 94 100 +6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
SSIA
Summary by Sourcery
Propagate structured logging context by wrapping plugin and stream loggers in LoggerAdapter and updating logging utilities to handle optional stream-specific metadata.
Enhancements: