Include logger name in FnApiLogRecordHandler log entries#37177
Include logger name in FnApiLogRecordHandler log entries#37177userzhy wants to merge 1 commit intoapache:masterfrom
Conversation
This change adds the logger name (record.name) to the custom_data field of LogEntry protos in FnApiLogRecordHandler. This is useful for filtering and debugging logs in complex pipelines. Fixes apache#37146
Summary of ChangesHello @userzhy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a valuable enhancement to the logging mechanism within Apache Beam's Python SDK. By embedding the logger's name directly into log entries, it significantly improves the ability to filter, analyze, and debug logs, especially in complex pipeline environments where distinguishing log sources is crucial for operational insights. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Assigning reviewers: R: @jrmccluskey for label python. Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
|
Reminder, please take a look at this pr: @jrmccluskey |
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @tvalentyn for label python. Available commands:
|
| log_entry.transform_id = current_state.name_context.transform_id | ||
|
|
||
| # Include the logger name in custom_data for filtering and debugging. | ||
| if record.name: |
There was a problem hiding this comment.
Would you mind clarifying why the info collected in log_entry.log_location is not sufficient for the filtering purposes you have in mind?
Thanks!
|
Reminder, please take a look at this pr: @tvalentyn |
|
waiting on author |
|
This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 1 week if no further activity occurs. If you think that’s incorrect or this pull request requires a review, please simply write any comment. If closed, you can revive the PR at any time and @mention a reviewer or discuss it on the dev@beam.apache.org list. Thank you for your contributions. |
|
This pull request has been closed due to lack of activity. If you think that is incorrect, or the pull request requires review, you can revive the PR at any time. |
This change adds the logger name (
record.name) to thecustom_datafield ofLogEntryprotos inFnApiLogRecordHandler. This is useful for filtering and debugging logs in complex pipelines.Changes:
FnApiLogRecordHandler.emit()to include the logger name incustom_data['logger'].test_logger_name_in_custom_datato verify the functionality.Example:
When a log is emitted from a logger named
my_module.submodule, theLogEntry.custom_datawill contain:Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.Fixes #37146