Switch streaming engine worker harness based on job settings - #35786
Switch streaming engine worker harness based on job settings#35786parveensania wants to merge 0 commit into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @parveensania, 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!
I've implemented a significant enhancement to the streaming engine worker, allowing it to dynamically adapt its operational mode based on job settings. Specifically, the worker can now switch between 'directpath' and 'cloudpath' connectivity types by changing the underlying worker harness (FanOutStreamingEngineWorkerHarness or SingleSourceWorkerHarness). This change is driven by a periodically updated global configuration, ensuring that the worker can optimize its connectivity without requiring a restart. This provides greater flexibility and efficiency in how streaming jobs connect to the backend services.
Highlights
- Dynamic Worker Harness Switching: I've implemented the capability for the streaming engine worker harness to dynamically switch between
FanOutStreamingEngineWorkerHarness(for directpath connectivity) andSingleSourceWorkerHarness(for cloudpath connectivity). This switch is driven by theConnectivityTypespecified in the periodically pulled streaming engine global configuration. - Refactoring of StreamingDataflowWorker: I've refactored the
StreamingDataflowWorkerclass to manage theStreamingWorkerHarnessusing anAtomicReference. This change, along with the introduction of new private helper methods (createFanOutStreamingEngineWorkerHarness,createSingleSourceWorkerHarness, andswitchStreamingWorkerHarness), centralizes and encapsulates the logic for creating and switching between different worker harness types. - Global Configuration Observation: A new mechanism has been added to register a configuration observer with the
configFetcher.getGlobalConfigHandle(). This allows the worker to react to real-time changes in thestreamingGlobalConfig, specifically theuserWorkerJobSettings().getConnectivityType(), enabling on-the-fly harness adjustments. - Improved SingleSourceWorkerHarness Shutdown: I've improved the
SingleSourceWorkerHarnessby ensuring that itsgetWorkStreamis explicitly shut down when theshutdown()method is called. This prevents potential resource leaks and ensures proper cleanup of gRPC streams. - Dynamic Channel Cache Update in Status Pages: The
StreamingWorkerStatusPagesclass now includes a public method,updateChannelCache, which allows itschannelCachefield to be updated dynamically. This is crucial for maintaining correct status reporting when the underlying connectivity or channels change. - New ConnectivityType Enum: I've introduced a new
ConnectivityTypeenum (DEFAULT,CLOUDPATH,DIRECTPATH) withinwindmill.proto. This enum provides a clear and standardized way to define the desired connectivity mode for the user worker, which is then used by the streaming engine to dictate harness behavior.
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 or fill out our survey to provide feedback.
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
-
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. ↩
|
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). |
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
arunpandianp
left a comment
arunpandianp
left a comment
There was a problem hiding this comment.
Thanks, taking a look
| WindmillServerStub windmillServer) { | ||
| if (connectivityType == ConnectivityType.CONNECTIVITY_TYPE_DIRECTPATH) { | ||
| if (!(this.streamingWorkerHarness.get() instanceof FanOutStreamingEngineWorkerHarness)) { | ||
| LOG.debug("Shutting down to SingleSourceWorkerHarness"); |
There was a problem hiding this comment.
Add a info log saying switching from connectivityType X to Y.
| fanoutStreamingWorkerHarness::currentActiveCommitBytes; | ||
| this.channelzServlet = | ||
| createChannelzServlet(options, fanoutStreamingWorkerHarness::currentWindmillEndpoints); | ||
| streamingWorkerHarness.get().start(); |
There was a problem hiding this comment.
will this block? Blocking here will block the config callback thread and future config callbacks.
The shutdown seems like it will block, can we move this callback to a separate single threaded executor?
| channelCache, | ||
| dispatcherClient); | ||
| this.streamingWorkerHarness.set(fanoutStreamingWorkerHarness); | ||
| this.getDataStatusProvider = getDataMetricTracker::printHtml; |
There was a problem hiding this comment.
resetting these here won't update the references inside statusPages. Can we update the references in statusPages too?
| new ThreadFactoryBuilder().setNameFormat(DUMP_STATUS_PAGES_EXECUTOR).build())); | ||
| } | ||
|
|
||
| public void updateChannelCache(@Nullable ChannelCache channelCache) { |
6a86204 to
8f888fb
Compare
2 participants
Based on Streaming engine global config which is pulled periodically, switch the type to worker harness to use. This is to switch between directpath (FanOutStreamingEngineWorkerHarness) and cloudpath (SingleSourceWorkerHarness) connectivity type.
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.