Skip to content

[Dataflow Java] Support the existing --logMdc option by adding the present mdc values to custom_data json field. - #36117

Merged
kennknowles merged 1 commit into
apache:masterfrom
scwhittle:mdc_v1
Sep 11, 2025
Merged

[Dataflow Java] Support the existing --logMdc option by adding the present mdc values to custom_data json field.#36117
kennknowles merged 1 commit into
apache:masterfrom
scwhittle:mdc_v1

Conversation

@scwhittle

Copy link
Copy Markdown
Contributor

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @scwhittle, 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 enhances the logging capabilities of Dataflow Java workers by enabling the inclusion of SLF4J Mapped Diagnostic Context (MDC) values directly within the custom_data field of log entries. This change improves log traceability and debugging by providing more contextual information, activated via an existing command-line option, without altering the core logging mechanism.

Highlights

  • MDC Logging Support: Implemented support for the existing --logMdc option in Dataflow Java workers, allowing SLF4J Mapped Diagnostic Context (MDC) values to be included in log messages.
  • Log Output Enhancement: MDC key-value pairs are now serialized into a custom_data JSON field within the log entry, providing richer contextual information for debugging and analysis.
  • Configuration Integration: The new MDC logging functionality is integrated with DataflowWorkerLoggingInitializer to respect the --logMdc command-line option, enabling or disabling this feature based on job configuration.
  • Improved Test Coverage: Added new unit tests to DataflowWorkerLoggingHandlerTest to thoroughly validate the correct inclusion and exclusion of MDC data in log outputs under various scenarios.
  • MDC Context Management: Updated existing tests in DataflowWorkerLoggingHandlerTest and BeamFnLoggingClientTest to utilize MDC.putCloseable, ensuring proper cleanup of MDC context after test execution.
Using Gemini Code Assist

The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions

Copy link
Copy Markdown
Contributor

Assigning reviewers:

R: @m-trieu for label java.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

@scwhittle

Copy link
Copy Markdown
Contributor Author

R: @kennknowles

@github-actions

Copy link
Copy Markdown
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

@kennknowles
kennknowles merged commit f359ff5 into apache:master Sep 11, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants