[spark] branch master updated: [SPARK-38550][DOCS][FOLLOWUP] Improve the documentation of Diagnostic disk store

[dongjoon]

This is an automated email from the ASF dual-hosted git repository.

dongjoon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new 1cc2d1641c2 [SPARK-38550][DOCS][FOLLOWUP] Improve the documentation of 
Diagnostic disk store
1cc2d1641c2 is described below

commit 1cc2d1641c23f028b5f175f80a695891ff13a6e2
Author: Gengliang Wang <gengli...@apache.org>
AuthorDate: Wed Apr 20 09:48:09 2022 -0700

    [SPARK-38550][DOCS][FOLLOWUP] Improve the documentation of Diagnostic disk 
store
    
    ### What changes were proposed in this pull request?
    
    * Add the conf `spark.appStatusStore.diskStoreDir` in configuration.md
    * This diagnostic API requires setting `spark.appStatusStore.diskStoreDir` 
for storing the diagnostic information.
    * Change the doc of conf `spark.appStatusStore.diskStoreDir`
    
    ### Why are the changes needed?
    
    Improve the documentation so that users can know it better
    
    ### Does this PR introduce _any_ user-facing change?
    
    No
    ### How was this patch tested?
    
    Preview:
    <img width="872" alt="image" 
src="https://user-images.githubusercontent.com/1097932/164146475-59143209-fc76-419f-8dc6-6e3b65b4aaee.png";>
    
    <img width="1816" alt="image" 
src="https://user-images.githubusercontent.com/1097932/164145412-668fc3d3-25bd-4221-8785-4ef5a0819791.png";>
    
    Closes #36274 from gengliangwang/improveDoc.
    
    Authored-by: Gengliang Wang <gengli...@apache.org>
    Signed-off-by: Dongjoon Hyun <dongj...@apache.org>
---
 core/src/main/scala/org/apache/spark/internal/config/Status.scala | 4 ++--
 docs/configuration.md                                             | 8 ++++++++
 docs/monitoring.md                                                | 4 +++-
 3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/core/src/main/scala/org/apache/spark/internal/config/Status.scala 
b/core/src/main/scala/org/apache/spark/internal/config/Status.scala
index 1db7267237f..64462fdee54 100644
--- a/core/src/main/scala/org/apache/spark/internal/config/Status.scala
+++ b/core/src/main/scala/org/apache/spark/internal/config/Status.scala
@@ -73,8 +73,8 @@ private[spark] object Status {
 
   val DISK_STORE_DIR_FOR_STATUS =
     ConfigBuilder("spark.appStatusStore.diskStoreDir")
-      .doc("Local directory where to store app status. " +
-           "It's an alternative to the in-memory kv store")
+      .doc("Local directory where to store diagnostic information of SQL 
executions. " +
+        "This configuration is only for live UI.")
       .version("3.4.0")
       .stringConf
       .createOptional
diff --git a/docs/configuration.md b/docs/configuration.md
index c0f3de86f98..3374be02606 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1469,6 +1469,14 @@ Apart from these, the following properties are also 
available, and may be useful
   </td>
   <td>1.4.0</td>
 </tr>
+<tr>
+  <td><code>spark.appStatusStore.diskStoreDir</code></td>
+  <td>None</td>
+  <td>
+    Local directory where to store diagnostic information of SQL executions. 
This configuration is only for live UI.
+  </td>
+  <td>3.4.0</td>
+</tr>
 </table>
 
 ### Compression and Serialization
diff --git a/docs/monitoring.md b/docs/monitoring.md
index 6d1bd2eefcc..a59efe5ff6f 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -613,11 +613,13 @@ can be identified by their `[attempt-id]`. In the API 
listed below, when running
   </tr>
   <tr>
     <td><code>/applications/[app-id]/diagnostics/sql/[execution-id]</code></td>
-    <td>Diagnostic for the given query. it includes:
+    <td>Diagnostic for the given query, including:
     <br>
     1. plan change history of adaptive execution
     <br>
     2. physical plan description with unlimited fields
+    <br>
+    This API requires setting <code>spark.appStatusStore.diskStoreDir</code> 
for storing the diagnostic information.
     </td>
   </tr>
   <tr>


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org