This is an automated email from the ASF dual-hosted git repository.
gurwls223 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 be1e8d8792ed [SPARK-46749][DOCS] Document `SPARK_LOG_*` and
`SPARK_PID_DIR`
be1e8d8792ed is described below
commit be1e8d8792edea737bd2800fe75998a807fba141
Author: Dongjoon Hyun <dh...@apple.com>
AuthorDate: Thu Jan 18 09:46:31 2024 +0900
[SPARK-46749][DOCS] Document `SPARK_LOG_*` and `SPARK_PID_DIR`
### What changes were proposed in this pull request?
This PR aims to document the following three environment variables for
`Spark Standalone` cluster.
- SPARK_LOG_DIR
- SPARK_LOG_MAX_FILES
- SPARK_PID_DIR
### Why are the changes needed?
So far, the users need to look at the `spark-env.sh.template` or
`spark-daemon.sh` files to see the descriptions and the default values. We had
better document it officially.
https://github.com/apache/spark/blob/9a2f39318e3af8b3817dc5e4baf52e548d82063c/conf/spark-env.sh.template#L67-L69
https://github.com/apache/spark/blob/9a2f39318e3af8b3817dc5e4baf52e548d82063c/sbin/spark-daemon.sh#L25-L28
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Generate HTML docs.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #44774 from dongjoon-hyun/SPARK-46749.
Authored-by: Dongjoon Hyun <dh...@apple.com>
Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
---
docs/spark-standalone.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/docs/spark-standalone.md b/docs/spark-standalone.md
index 0bc73978570b..b9e3bb5d3f7f 100644
--- a/docs/spark-standalone.md
+++ b/docs/spark-standalone.md
@@ -142,6 +142,18 @@ You can optionally configure the cluster further by
setting environment variable
comma-separated list of multiple directories on different disks.
</td>
</tr>
+ <tr>
+ <td><code>SPARK_LOG_DIR</code></td>
+ <td>Where log files are stored. (default: SPARK_HOME/logs).</td>
+ </tr>
+ <tr>
+ <td><code>SPARK_LOG_MAX_FILES</code></td>
+ <td>The maximum number of log files (default: 5).</td>
+ </tr>
+ <tr>
+ <td><code>SPARK_PID_DIR</code></td>
+ <td>Where pid files are stored. (default: /tmp).</td>
+ </tr>
<tr>
<td><code>SPARK_WORKER_CORES</code></td>
<td>Total number of cores to allow Spark applications to use on the
machine (default: all available cores).</td>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
