srowen commented on a change in pull request #25430: [SPARK-28540][WEBUI] 
Document Environment page
URL: https://github.com/apache/spark/pull/25430#discussion_r315645590
 
 

 ##########
 File path: docs/web-ui.md
 ##########
 @@ -107,6 +107,51 @@ sizes and using executors for all partitions in an RDD or 
DataFrame.
 The Environment tab displays the values for the different environment and 
configuration variables,
 including JVM, Spark, and system properties.
 
+<p style="text-align: center;">
+  <img src="img/webui-env-tab.png"
+       title="Env tab"
+       alt="Env tab"
+       width="100%" />
+  <!-- Images are downsized intentionally to improve quality on retina 
displays -->
+</p>
+
+This environment page has five parts. It is a useful place to check whether 
your properties have
+been set correctly.
+The first part 'Runtime Information' simply contains the [runtime 
properties](configuration.html#runtime-environment)
+like versions of Java and Scala.
+The second part 'Spark Properties' lists the [application 
properties](configuration.html#application-properties) like
+'spark.app.name' and 'spark.driver.memory'.
+
+<p style="text-align: center;">
+  <img src="img/webui-env-hadoop.png"
+       title="Hadoop Properties"
+       alt="Hadoop Properties"
+       width="100%" />
+  <!-- Images are downsized intentionally to improve quality on retina 
displays -->
+</p>
+Clicking the 'Hadoop Properties' link displays properties relative to Hadoop 
and YARN. Note that properties like
+['spark.hadoop.*'](configuration.html#execution-behavior) are shown not in 
this part but in 'Spark Properties'.
+
+<p style="text-align: center;">
+  <img src="img/webui-env-sys.png"
+       title="System Properties"
+       alt="System Properties"
+       width="100%" />
+  <!-- Images are downsized intentionally to improve quality on retina 
displays -->
+</p>
+'System Properties' shows more details about the JVM.
+
+<p style="text-align: center;">
+  <img src="img/webui-env-class.png"
+       title="Classpath Entries"
+       alt="Classpath Entries"
+       width="100%" />
+  <!-- Images are downsized intentionally to improve quality on retina 
displays -->
+</p>
+
+The last part 'Classpath Entries' illustrates the classes loaded from 
different sources, which is very useful
 
 Review comment:
   Really minor but I might say "lists" or "shows" rather than "illustrates"

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to