Skip to content

Commit 7c09b57

Browse files
HeartSaVioRHyukjinKwon
authored andcommitted
[SPARK-28869][DOCS][FOLLOWUP] Add direct relationship between configs for rolling event log
### What changes were proposed in this pull request? This patch addresses the post-hoc review comment linked here - #25670 (comment) ### Why are the changes needed? We would like to explicitly document the direct relationship before we finish up structuring of configurations. ### Does this PR introduce any user-facing change? No. ### How was this patch tested? N/A Closes #27576 from HeartSaVioR/SPARK-28869-FOLLOWUP-doc. Authored-by: Jungtaek Lim (HeartSaVioR) <kabhwan.opensource@gmail.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org> (cherry picked from commit 446b2d2) Signed-off-by: HyukjinKwon <gurwls223@apache.org>
1 parent 518cc90 commit 7c09b57

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

core/src/main/scala/org/apache/spark/internal/config/package.scala

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,14 +191,15 @@ package object config {
191191

192192
private[spark] val EVENT_LOG_ENABLE_ROLLING =
193193
ConfigBuilder("spark.eventLog.rolling.enabled")
194-
.doc("Whether rolling over event log files is enabled. If set to true, it cuts down " +
194+
.doc("Whether rolling over event log files is enabled. If set to true, it cuts down " +
195195
"each event log file to the configured size.")
196196
.booleanConf
197197
.createWithDefault(false)
198198

199199
private[spark] val EVENT_LOG_ROLLING_MAX_FILE_SIZE =
200200
ConfigBuilder("spark.eventLog.rolling.maxFileSize")
201-
.doc("The max size of event log file to be rolled over.")
201+
.doc(s"When ${EVENT_LOG_ENABLE_ROLLING.key}=true, specifies the max size of event log file" +
202+
" to be rolled over.")
202203
.bytesConf(ByteUnit.BYTE)
203204
.checkValue(_ >= ByteUnit.MiB.toBytes(10), "Max file size of event log should be " +
204205
"configured to be at least 10 MiB.")

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1033,7 +1033,7 @@ Apart from these, the following properties are also available, and may be useful
10331033
<td><code>spark.eventLog.rolling.maxFileSize</code></td>
10341034
<td>128m</td>
10351035
<td>
1036-
The max size of event log file before it's rolled over.
1036+
When <code>spark.eventLog.rolling.enabled=true</code>, specifies the max size of event log file before it's rolled over.
10371037
</td>
10381038
</tr>
10391039
<tr>

0 commit comments

Comments
 (0)