Add DiskProvisionedIops and DiskProvisionedThroughputMibps pipeline options #37377
Add DiskProvisionedIops and DiskProvisionedThroughputMibps pipeline options #37377bambadiouf1 wants to merge 9 commits intoapache:masterfrom
Conversation
Summary of ChangesHello @bambadiouf1, 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 Google Cloud Dataflow's capabilities by allowing users to specify detailed performance characteristics for worker VM root disks. By introducing options for provisioned IOPS and throughput, it provides greater control over the underlying infrastructure, which can be crucial for optimizing the performance and cost-efficiency of data processing pipelines. This change is integrated across all supported SDKs, ensuring a consistent experience for developers. 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
|
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
309f5fd to
6cb13d9
Compare
efa4d20 to
6cb13d9
Compare
…rker pools for java sdk
|
assign set of reviewers |
|
Assigning reviewers: R: @damccorm 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). |
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces support for configuring provisioned IOPS and throughput for worker disks in the Dataflow runner across the Java, Go, and Python SDKs. The changes include updating the Dataflow API version, adding new pipeline options, and implementing the necessary translation logic to pass these parameters to the service. Review feedback highlights that the Go implementation is currently incomplete as it lacks the translation logic to the API request. Additionally, suggestions were made for the Java SDK to use Long instead of Integer for these fields for better consistency and to include basic validation to ensure values are greater than zero before being set.
| diskProvisionedIops = flag.Int64("disk_provisioned_iops", 0, "Provisioned IOPS for the worker disk (optional).") | ||
| diskProvisionedThroughputMibps = flag.Int64("disk_provisioned_throughput_mibps", 0, "Provisioned throughput in MiB/s for the worker disk (optional).") |
There was a problem hiding this comment.
The Go implementation appears to be incomplete. While flags and JobOptions fields have been added, there is no corresponding logic to translate these values into the WorkerPool configuration within the Dataflow API request (typically handled in environment.go). Without this translation, these flags will have no effect on the provisioned workers.
There was a problem hiding this comment.
I agree that I would've expected this to show up in
| if (options.getDiskProvisionedIops() != null) { | ||
| workerPool.setDiskProvisionedIops(Long.valueOf(options.getDiskProvisionedIops())); | ||
| } | ||
| if (options.getDiskProvisionedThroughputMibps() != null) { | ||
| workerPool.setDiskProvisionedThroughputMibps( | ||
| Long.valueOf(options.getDiskProvisionedThroughputMibps())); | ||
| } |
There was a problem hiding this comment.
For consistency with how diskSizeGb is handled (lines 489-491), it is recommended to also check that these values are greater than zero. This provides basic client-side validation and ensures that a value of 0 (if provided) doesn't inadvertently override service defaults in an unexpected way. Additionally, the conversion to Long can be simplified.
| if (options.getDiskProvisionedIops() != null) { | |
| workerPool.setDiskProvisionedIops(Long.valueOf(options.getDiskProvisionedIops())); | |
| } | |
| if (options.getDiskProvisionedThroughputMibps() != null) { | |
| workerPool.setDiskProvisionedThroughputMibps( | |
| Long.valueOf(options.getDiskProvisionedThroughputMibps())); | |
| } | |
| if (options.getDiskProvisionedIops() != null && options.getDiskProvisionedIops() > 0) { | |
| workerPool.setDiskProvisionedIops((long) options.getDiskProvisionedIops()); | |
| } | |
| if (options.getDiskProvisionedThroughputMibps() != null && options.getDiskProvisionedThroughputMibps() > 0) { | |
| workerPool.setDiskProvisionedThroughputMibps( | |
| (long) options.getDiskProvisionedThroughputMibps()); | |
| } |
| Integer getDiskProvisionedIops(); | ||
|
|
||
| void setDiskProvisionedIops(Integer value); |
There was a problem hiding this comment.
Consider using Long instead of Integer for these performance-related fields. While Integer is likely sufficient for current IOPS limits, using Long is more consistent with the underlying Dataflow API (which the translator casts to Long) and the Go implementation in this PR. It also future-proofs the options against very high performance disk specifications.
| Integer getDiskProvisionedIops(); | |
| void setDiskProvisionedIops(Integer value); | |
| Long getDiskProvisionedIops(); | |
| void setDiskProvisionedIops(Long value); |
| Integer getDiskProvisionedThroughputMibps(); | ||
|
|
||
| void setDiskProvisionedThroughputMibps(Integer value); |
There was a problem hiding this comment.
| DiskType string | ||
| DiskProvisionedIops int64 | ||
| DiskProvisionedThroughputMibps int64 | ||
| MachineType string |
There was a problem hiding this comment.
These don't look correctly formatted - could you please run go fmt to fix?
| diskProvisionedIops = flag.Int64("disk_provisioned_iops", 0, "Provisioned IOPS for the worker disk (optional).") | ||
| diskProvisionedThroughputMibps = flag.Int64("disk_provisioned_throughput_mibps", 0, "Provisioned throughput in MiB/s for the worker disk (optional).") |
There was a problem hiding this comment.
I agree that I would've expected this to show up in
This pull request introduces two new pipeline options for the Google Cloud Dataflow runner for the Java, Python and Go SDKs. These options allow users to specify provisioned performance for worker VM root disks:
disk_provisioned_iops: Sets the provisioned IOPS for the root disk. If unspecified, the service chooses a default
disk_provisioned_throughput_mibps: Sets the provisioned throughput in MiB/s for the root disk.
Added getters and setters to DataflowPipelineWorkerPoolOptions and updated DataflowPipelineTranslator to pass these values to the worker pool configuration.
Will follow up with a PR for the Go and Python SDKs
Tests have been added/updated to verify that these options are correctly parsed and translated.
More context:
we need to add these pipeline options before submitting this cl: https://critique.corp.google.com/cl/858930428
Issue: #37374
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.