(incubator-uniffle) branch master updated: [#1905][FOLLOWUP] docs: Add documents after introducing XXX_JAVA_OPTS env var (#1933)

[rickyma]

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

rickyma pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-uniffle.git


The following commit(s) were added to refs/heads/master by this push:
     new fa87381f8 [#1905][FOLLOWUP] docs: Add documents after introducing 
XXX_JAVA_OPTS env var (#1933)
fa87381f8 is described below

commit fa87381f86c6959067eb9cf09cd34610c119f743
Author: maobaolong <baoloong...@tencent.com>
AuthorDate: Fri Jul 26 16:39:27 2024 +0800

    [#1905][FOLLOWUP] docs: Add documents after introducing XXX_JAVA_OPTS env 
var (#1933)
    
    ### What changes were proposed in this pull request?
    
    Add some necessary docs.
    
    ### Why are the changes needed?
    
    Fix: #1905
    
    ### Does this PR introduce _any_ user-facing change?
    
    Yeah, docs page.
    
    ### How was this patch tested?
    
    No need
---
 docs/coordinator_guide.md | 5 +++++
 docs/dashboard_guide.md   | 7 +++++++
 docs/server_guide.md      | 8 ++++++++
 3 files changed, 20 insertions(+)

diff --git a/docs/coordinator_guide.md b/docs/coordinator_guide.md
index c098ff1bc..978e0a107 100644
--- a/docs/coordinator_guide.md
+++ b/docs/coordinator_guide.md
@@ -36,6 +36,11 @@ This document will introduce how to deploy Uniffle 
coordinators.
      HADOOP_HOME=<hadoop home>
      XMX_SIZE="16g"
    ```
+   You can add extra JVM arguments for the Uniffle coordinator by specifying 
`UNIFFLE_COORDINATOR_JAVA_OPTS` in `rss-env.sh`.
+   Example:
+   ```
+   UNIFFLE_COORDINATOR_JAVA_OPTS="-Xdebug 
-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5006 
-Drss.jetty.http.port=19998"
+   ```
 3. update RSS_HOME/conf/coordinator.conf, eg,
    ```
      rss.rpc.server.port 19999
diff --git a/docs/dashboard_guide.md b/docs/dashboard_guide.md
index 5b413a408..32a2d63c2 100644
--- a/docs/dashboard_guide.md
+++ b/docs/dashboard_guide.md
@@ -32,6 +32,13 @@ rss.dashboard.http.port 19997
 coordinator.web.address http://coordinator.hostname:19998/
 ```
 
+### Configure related JVM parameters
+You can add extra JVM arguments for the Uniffle dashboard by specifying 
`UNIFFLE_DASHBOARD_JAVA_OPTS` in `RSS_HOME/bin/rss-env.sh`
+Example:
+```
+UNIFFLE_DASHBOARD_JAVA_OPTS="-Xdebug 
-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5004 
-Drss.jetty.http.port=19997"
+```
+
 ### Start the dashboard process
 In the $RSS_HOME/bin directory, start with a script.
 ``` shell
diff --git a/docs/server_guide.md b/docs/server_guide.md
index b6408e3ec..16e2146ff 100644
--- a/docs/server_guide.md
+++ b/docs/server_guide.md
@@ -176,6 +176,14 @@ XMX_SIZE=40g
 MAX_DIRECT_MEMORY_SIZE=360g
 ```
 
+You can add extra JVM arguments for the Uniffle server by specifying 
`UNIFFLE_SHUFFLE_SERVER_JAVA_OPTS` in `rss-env.sh`.
+
+For example:
+
+```
+UNIFFLE_SHUFFLE_SERVER_JAVA_OPTS="-Xdebug 
-Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005 
-Drss.jetty.http.port=19978"
+```
+
 ##### server.conf
 
 Generally, `rss.server.read.buffer.capacity` of 20g is enough, you can pay 
more attention to the metric `read_used_buffer_size`.