chore: Simplify on-heap memory configuration #2599
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #2599 +/- ##
============================================
+ Coverage 56.12% 59.17% +3.04%
- Complexity 976 1444 +468
============================================
Files 119 146 +27
Lines 11743 13719 +1976
Branches 2251 2353 +102
============================================
+ Hits 6591 8118 +1527
- Misses 4012 4379 +367
- Partials 1140 1222 +82 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
andygrove
changed the title
comphead
reviewed
Oct 18, 2025
| "This config is optional. If this is not specified, it will be set to " + | ||
| s"`spark.comet.memory.overhead.factor` * `spark.executor.memory`. $TUNING_GUIDE.") | ||
| .internal() | ||
| "when running Spark in on-heap mode.") |
There was a problem hiding this comment.
Should we add default value in the doc?
There was a problem hiding this comment.
The generated docs show the default value:
comphead
reviewed
Oct 18, 2025
| | `spark.comet.columnar.shuffle.memory.factor` | Fraction of Comet memory to be allocated per executor process for columnar shuffle when running in on-heap mode. For more information, refer to the [Comet Tuning Guide](https://datafusion.apache.org/comet/user-guide/tuning.html). | 1.0 | | ||
| | `spark.comet.exec.onHeap.enabled` | Whether to allow Comet to run in on-heap mode. Required for running Spark SQL tests. | false | | ||
| | `spark.comet.exec.onHeap.memoryPool` | The type of memory pool to be used for Comet native execution when running Spark in on-heap mode. Available pool types are `greedy`, `fair_spill`, `greedy_task_shared`, `fair_spill_task_shared`, `greedy_global`, `fair_spill_global`, and `unbounded`. | greedy_task_shared | | ||
| | `spark.comet.memoryOverhead` | The amount of additional memory to be allocated per executor process for Comet, in MiB, when running Spark in on-heap mode. | 1073741824b | |
There was a problem hiding this comment.
should the default value to be 1024?
There was a problem hiding this comment.
Hmm.. we could update GenerateDocs to recognize byte configs and show in the unit they were defined as. I'll take a look.
.bytesConf(ByteUnit.MiB)
There was a problem hiding this comment.
I pushed a commit. The default is now shown as 1024 MiB.
comphead
approved these changes
Oct 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
N/A
Rationale for this change
Simplify the on-heap memory configuration, which is intended for test use only now.
The number of configs is reduced from 7 to 4. The remaining configs, which are now documented in a new
Development & Testing Settingssection in the configuration guide are:COMET_ONHEAP_ENABLEDCOMET_ONHEAP_MEMORY_POOL_TYPECOMET_ONHEAP_MEMORY_OVERHEADCOMET_ONHEAP_SHUFFLE_MEMORY_FACTORWhat changes are included in this PR?
COMET_MEMORY_OVERHEAD_FACTORCOMET_MEMORY_OVERHEAD_MIN_MIBCOMET_COLUMNAR_SHUFFLE_MEMORY_SIZEONHEAPorOFFHEAPHow are these changes tested?
CI