[Dataflow Java] Clarify which portions of DataflowWorkerLoggingOptions are deprecated - #38960
Conversation
Summary of ChangesHello, 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 improves the documentation and deprecation strategy for DataflowWorkerLoggingOptions. By explicitly marking individual methods as deprecated and providing clear guidance on using SdkHarnessOptions, it ensures that developers are directed toward more portable and forward-compatible configuration options for worker logging. Highlights
New Features🧠 You can now enable Memory (public preview) 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 the 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 counterproductive. 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request refactors DataflowWorkerLoggingOptions by removing the deprecation from the entire interface and instead deprecating individual logging option getters, pointing users to SdkHarnessOptions equivalents. The review feedback suggests improving the Javadoc formatting by using proper {@link} tags for the recommended replacements and ensuring that corresponding setter methods are also marked with @deprecated to maintain consistency.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| * */ | ||
| @Description("Controls the default log level of all loggers without a log level override.") | ||
| @Default.Enum("INFO") | ||
| @Deprecated |
There was a problem hiding this comment.
When deprecating a property in a PipelineOptions interface, both the getter and the setter should be deprecated to ensure consistent compiler warnings. Please also add @Deprecated to setDefaultWorkerLogLevel(Level level).
| + "message may be filtered depending on the defaultWorkerLogLevel or if a 'System.out' " | ||
| + "override is specified via workerLogLevelOverrides.") | ||
| @Default.Enum("INFO") | ||
| @Deprecated |
There was a problem hiding this comment.
Please also deprecate the corresponding setter setWorkerSystemOutMessageLevel(Level level) with @Deprecated to ensure consistency.
| + "message may be filtered depending on the defaultWorkerLogLevel or if a 'System.err' " | ||
| + "override is specified via workerLogLevelOverrides.") | ||
| @Default.Enum("ERROR") | ||
| @Deprecated |
There was a problem hiding this comment.
Please also deprecate the corresponding setter setWorkerSystemErrMessageLevel(Level level) with @Deprecated to ensure consistency.
| + "level. System.out and System.err levels are configured via loggers of the corresponding " | ||
| + "name. Also, note that when multiple overrides are specified, the exact name followed by " | ||
| + "the closest parent takes precedence.") | ||
| @Deprecated |
There was a problem hiding this comment.
Please also deprecate the corresponding setter setWorkerLogLevelOverrides(WorkerLogLevelOverrides value) with @Deprecated to ensure consistency.
…s are deprecated in preference of equivalent fields in SdkHarnessOptions
4175438 to
8796ed9
Compare
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request updates DataflowWorkerLoggingOptions by removing the deprecation annotation from the interface itself and instead deprecating all of its individual methods, directing users to use SdkHarnessOptions for cross-runner compatibility. The reviewer suggested updating the class-level Javadoc to clarify that all options in the interface are deprecated, rather than just 'some' of them.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
test failures are unrelated spark test issue |
|
assign set of reviewers |
|
Assigning reviewers: R: @tvalentyn added as fallback since no labels match configuration 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). |
…s are deprecated (apache#38960) Clarify which portions of DataflowWorkerLoggingOptions are deprecated in preference of equivalent fields in SdkHarnessOptions
…s are deprecated (apache#38960) Clarify which portions of DataflowWorkerLoggingOptions are deprecated in preference of equivalent fields in SdkHarnessOptions
2 participants
Specifically point out which fields should be used in SdkHarnessOptions
Please add a meaningful description for your change here
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.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)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.