Skip to content

docs: explain spark.comet.shuffle.native.maxBufferBytes in the shuffle tuning guide - #7308

Merged
andygrove merged 1 commit into
apache:mainfrom
comphead:docs-shuffle-max-buffer-bytes
Oct 28, 2026
Merged

andygrove merged 1 commit into
apache:mainfrom
comphead:docs-shuffle-max-buffer-bytes

Conversation

@comphead

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

None. This documents an existing setting that the user guide did not explain.

Rationale for this change

spark.comet.shuffle.native.maxBufferBytes is only described in the generated configuration reference and the contributor guide, so users whose tasks end in a native shuffle have no guidance on when to set it or what it costs.

By default the writer buffers until the memory pool refuses it. In a wide group-by we ran (87 sort keys, 12 tasks per executor), that was about 2.6 GB per map task, and executors were killed for exceeding their containers. With the limit at 256m, far fewer executors were killed, and a local reproduction of the same job showed no slowdown and a 3% larger shuffle. At 128m and below, the stage reading the shuffle got slower.

What changes are included in this PR?

  • A "Native Shuffle Writer Memory" section in the shuffle tuning page: what the setting does, why to set it, and what it costs.
  • The tuning guide's index mentions the new section.

How are these changes tested?

Documentation only. prettier, which CI runs on Markdown, makes no changes.

…e tuning guide

The setting was described only in the generated configuration reference
and the contributor guide. Add a short section on what it does, when to
set it, and what it costs, and mention it in the tuning guide's index.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 28, 2026

@andygrove andygrove left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Thanks @comphead.

@andygrove
andygrove added this pull request to the merge queue Oct 28, 2026
Merged via the queue into apache:main with commit 7f73d86 Oct 28, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants