sarutak commented on code in PR #56013:
URL: https://github.com/apache/spark/pull/56013#discussion_r3279784473
##########
docs/web-ui.md:
##########
@@ -28,113 +28,102 @@ to monitor the status and resource consumption of your
Spark cluster.
* This will become a table of contents (this text will be scraped).
{:toc}
+## Overview
+
+The Web UI is built into every Spark application: while the application is
+running, it serves a set of web pages that let you inspect what is happening
+inside it. Typical uses include monitoring a running job, diagnosing a
+failure, analyzing the execution plan of a slow SQL query, and checking how
+memory and tasks are distributed across executors.
+
+By default the Web UI is available at `http://<driver-host>:4040`. When that
+port is already in use (for example, when several Spark applications run on
+the same host), Spark tries `4041`, `4042`, and so on until it finds a free
+port, and logs the chosen port at startup. You can override the default port
+with `spark.ui.port`, and tune other UI behavior through the `spark.ui.*`
+properties documented in the [Configuration](configuration.html#spark-ui)
+reference.
+
+The Web UI is tied to the lifetime of the application: once it exits, the UI
+is no longer reachable. To inspect an application after it has finished,
+enable event logging and run the Spark History Server, which reconstructs an
+equivalent UI from the persisted event log; see
+[Monitoring and Instrumentation](monitoring.html) for setup details.
+
+The remaining sections walk through each tab in the Web UI's top navigation
+bar.
+
## Jobs Tab
The Jobs tab displays a summary page of all jobs in the Spark application and
a details page
for each job. The summary page shows high-level information, such as the
status, duration, and
progress of all jobs and the overall event timeline. When you click on a job
on the summary
page, you see the details page for that job. The details page further shows
the event timeline,
DAG visualization, and all stages of the job.
-The information that is displayed in this section is
-* User: Current Spark user
-* Started At: The startup time of Spark application
-* Total uptime: Time since Spark application started
+The information displayed at the top of the page includes:
+
* Scheduling mode: See [job
scheduling](job-scheduling.html#configuring-pool-properties)
* Number of jobs per status: Active, Completed, Failed
-
-<p style="text-align: center;">
- <img src="img/AllJobsPageDetail1.png" title="Basic info" alt="Basic info"
width="20%"/>
-</p>
-
* Event timeline: Displays in chronological order the events related to the
executors (added, removed) and the jobs
-
-<p style="text-align: center;">
- <img src="img/AllJobsPageDetail2.png" title="Event timeline" alt="Event
timeline"/>
-</p>
-
* 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
Review 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 is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
