Skip to content

docs: add HashJoinExec metrics to user guide - #24055

Open
fyrsta7 wants to merge 1 commit into
apache:mainfrom
fyrsta7:codex/hashjoin-metrics-docs
Open

docs: add HashJoinExec metrics to user guide#24055
fyrsta7 wants to merge 1 commit into
apache:mainfrom
fyrsta7:codex/hashjoin-metrics-docs

Conversation

@fyrsta7

@fyrsta7 fyrsta7 commented Aug 2, 2026

Copy link
Copy Markdown

Which issue does this PR close?

Rationale for this change

HashJoinExec exposes several operator-specific metrics, but the metrics user guide did not document them yet. This PR follows the metrics documentation tracking issue by adding the HashJoinExec section.

What changes are included in this PR?

  • Adds HashJoinExec operator-specific metrics to docs/source/user-guide/metrics.md.
  • Adds a note near BuildProbeJoinMetrics to keep metric descriptions in sync with the user guide.
  • Corrects the probe_hit_rate implementation comment to say "at least one match", matching the current metric accounting.

Are these changes tested?

This is a documentation/comment-only change with no runtime behavior change.

Checked locally:

  • git diff --check
  • cargo fmt --check
  • npx prettier@2.7.1 --check docs/source/user-guide/metrics.md
  • ./dev/rust_lint.sh

Are there any user-facing changes?

Yes. The metrics user guide now documents the existing HashJoinExec metrics. There are no runtime behavior or public API changes.

AI-assisted contribution note

This change is limited to documentation and comments. I verified the metric names and descriptions against BuildProbeJoinMetrics and HashJoinExec, and I do not have unknowns or assumptions to call out.

@github-actions github-actions Bot added documentation Improvements or additions to documentation physical-plan Changes to the physical-plan crate labels Aug 2, 2026
@fyrsta7
fyrsta7 marked this pull request as ready for review August 2, 2026 17:15
@fyrsta7
fyrsta7 marked this pull request as draft August 2, 2026 17:44
@fyrsta7
fyrsta7 marked this pull request as ready for review August 3, 2026 06:27
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 physical-plan Changes to the physical-plan crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include HashJoinExec in the metrics user-guide

1 participant