[SPARK-55846][DOCS] Update Web UI documentation for UI modernization#56013
Open
yaooqinn wants to merge 1 commit into
Open
[SPARK-55846][DOCS] Update Web UI documentation for UI modernization#56013yaooqinn wants to merge 1 commit into
yaooqinn wants to merge 1 commit into
Conversation
### What changes were proposed in this pull request? This PR rewrites `docs/web-ui.md` for the modernized Spark Web UI delivered under SPARK-55760 (umbrella SPARK-56941, target 5.0.0). Highlights: - **Overview**: brief description of how to access the UI, port-walking behavior, `spark.ui.port` / `spark.ui.enabled`, and the new tab navbar. - **Jobs / Stages tabs**: simplified from 15+ inline screenshots to 4 representative ones (`AllJobsPage.png`, `JobPage.png`, `AllStagesPage.png`, `StagePage.png`); removed stale "Started At / User / Total uptime" prose now shown in the page footer. - **Storage tab**: refreshed screenshots only. - **Environment tab**: rewritten as an overview plus a list of the seven new subtabs (Runtime Information, Spark Properties, Resource Profiles, Hadoop Properties, System Properties, Metrics Properties, Classpath Entries). - **Executors tab**: documents the new **Thread Dump**, **Heap Histogram**, and **Flame Graph** side panel (drag-resizable from the left edge). Generalized the **stderr** / **stdout** link description so it isn't standalone-only. - **SQL tab**: new structure with `Query Listing`, `SQL Plan Visualization`, `Execution Detail Page`, and the existing SQL metrics table. Documents pan/zoom, in-graph metrics, node search, and the side-panel node details. - Refreshed all 10 corresponding screenshots and added 4 new ones for the Jobs/Stages pages. The Structured Streaming, Streaming (DStreams), and JDBC/ODBC Server sections are left untouched. ### Why are the changes needed? The Web UI was substantially modernized for Spark 5.0 (Bootstrap 5, DataTables-based listings, side panels, plan-viz pan/zoom, etc.), and `docs/web-ui.md` still described the pre-modernization layout in many places. This PR brings the user-facing documentation in line with the shipping UI. ### Does this PR introduce _any_ user-facing change? Documentation only. ### How was this patch tested? - Re-rendered the page locally and verified all referenced screenshots resolve. - All screenshots were captured against `master` running a small demo Spark application. - A reader-test pass was performed to find gaps for first-time users and the resulting issues were addressed. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: GitHub Copilot CLI 1.0.51-2 with Claude Opus 4.7 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sarutak
reviewed
May 21, 2026
Member
There was a problem hiding this comment.
The following screenshots seem no longer referenced.
AllJobsPageDetail{1,2,3}.pngJobPageDetail{1,2,3}.pngAllStagesPageDetail{1..9}.pngwebui-env-hadoop.png,webui-env-sys.png,webui-env-class.pngwebui-exe-err.png,webui-exe-thread.pngwebui-sql-plan.png
Should we remove them from the repository?
|
|
||
| * Details of jobs grouped by status: Displays detailed information of the jobs including Job ID, description (with a link to detailed job page), submitted time, duration, stages summary and tasks progress bar | ||
|
|
||
| The current user, application start time, and total uptime are shown in the footer at the |
Member
There was a problem hiding this comment.
The current user, application start time, and total uptime are shown in the footer at the bottom of every page.
Since this applies to all tabs, how about moving this sentence to the Overview section?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
What changes were proposed in this pull request?
This PR rewrites
docs/web-ui.mdfor the modernized Spark Web UI delivered under SPARK-55760Highlights:
spark.ui.port/spark.ui.enabled, and the new tab navbar.AllJobsPage.png,JobPage.png,AllStagesPage.png,StagePage.png); removed stale "Started At / User / Total uptime" prose now shown in the page footer.Query Listing,SQL Plan Visualization,Execution Detail Page, and the existing SQL metrics table. Documents pan/zoom, in-graph metrics, node search, and the side-panel node details.The Structured Streaming, Streaming (DStreams), and JDBC/ODBC Server sections are left untouched.
Why are the changes needed?
The Web UI was substantially modernized for Spark 5.0 (Bootstrap 5, DataTables-based listings, side panels, plan-viz pan/zoom, etc.), and
docs/web-ui.mdstill described the pre-modernization layout in many places. This PR brings the user-facing documentation in line with the shipping UI.Does this PR introduce any user-facing change?
Documentation only.
How was this patch tested?
masterrunning a small demo Spark application.Was this patch authored or co-authored using generative AI tooling?
Generated-by: GitHub Copilot CLI 1.0.51-2 with Claude Opus 4.7