Skip to content

Commit

Permalink
Update config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kimahriman committed Mar 2, 2022
1 parent 9e36055 commit 4f8e7e6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,10 @@ package object config {

private[spark] val DRIVER_MEMORY_OVERHEAD_FACTOR =
ConfigBuilder("spark.driver.memoryOverheadFactor")
.doc("This sets the Memory Overhead Factor on the driver that will allocate memory to " +
"non-JVM memory, which includes off-heap memory allocations, non-JVM tasks, various " +
"systems processes, and tmpfs-based local directories.")
.doc("Fraction of driver memory to be allocated as additional non-heap memory per driver " +
"process in cluster mode. This is memory that accounts for things like VM overheads, " +
"interned strings, other native overheads, etc. This tends to grow with the container " +
"size. This value is ignored if spark.driver.memoryOverhead is set directly.")
.version("3.3.0")
.doubleConf
.checkValue(factor => factor > 0,
Expand Down Expand Up @@ -328,9 +329,10 @@ package object config {

private[spark] val EXECUTOR_MEMORY_OVERHEAD_FACTOR =
ConfigBuilder("spark.executor.memoryOverheadFactor")
.doc("This sets the Memory Overhead Factor on executors that will allocate memory to " +
"non-JVM memory, which includes off-heap memory allocations, non-JVM tasks, various " +
"systems processes, and tmpfs-based local directories.")
.doc("Fraction of executor memory to be allocated as additional non-heap memory per " +
"executor process. This is memory that accounts for things like VM overheads, " +
"interned strings, other native overheads, etc. This tends to grow with the container " +
"size. This value is ignored if spark.executor.memoryOverhead is set directly.")
.version("3.3.0")
.doubleConf
.checkValue(factor => factor > 0,
Expand Down
9 changes: 6 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,10 @@ of the most common options to set are:
<td><code>spark.driver.memoryOverheadFactor</code></td>
<td>0.10</td>
<td>
Fraction of driver memory to be allocated as additional non-heap memory per driver process
in cluster mode. This value is ignored if <code>spark.driver.memoryOverhead</code> is set
directly.
Fraction of driver memory to be allocated as additional non-heap memory per driver process in cluster mode.
This is memory that accounts for things like VM overheads, interned strings,
other native overheads, etc. This tends to grow with the container size.
This value is ignored if <code>spark.driver.memoryOverhead</code> is set directly.
</td>
<td>3.3.0</td>
</tr>
Expand Down Expand Up @@ -302,6 +303,8 @@ of the most common options to set are:
<td>0.10</td>
<td>
Fraction of executor memory to be allocated as additional non-heap memory per executor process.
This is memory that accounts for things like VM overheads, interned strings,
other native overheads, etc. This tends to grow with the container size.
This value is ignored if <code>spark.executor.memoryOverhead</code> is set directly.
</td>
<td>3.3.0</td>
Expand Down

0 comments on commit 4f8e7e6

Please sign in to comment.