Skip to content

Commit fbca6b6

Browse files
aarondavpwendell
authored andcommitted
[SPARK-4864] Add documentation to Netty-based configs
Author: Aaron Davidson <[email protected]> Closes #3713 from aarondav/netty-configs and squashes the following commits: 8a8b373 [Aaron Davidson] Address Patrick's comments 3b1f84e [Aaron Davidson] [SPARK-4864] Add documentation to Netty-based configs
1 parent 7c0ed13 commit fbca6b6

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

docs/configuration.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -852,6 +852,41 @@ Apart from these, the following properties are also available, and may be useful
852852
between nodes leading to flooding the network with those.
853853
</td>
854854
</tr>
855+
<tr>
856+
<td><code>spark.shuffle.io.preferDirectBufs</code></td>
857+
<td>true</td>
858+
<td>
859+
(Netty only) Off-heap buffers are used to reduce garbage collection during shuffle and cache
860+
block transfer. For environments where off-heap memory is tightly limited, users may wish to
861+
turn this off to force all allocations from Netty to be on-heap.
862+
</td>
863+
</tr>
864+
<tr>
865+
<td><code>spark.shuffle.io.numConnectionsPerPeer</code></td>
866+
<td>1</td>
867+
<td>
868+
(Netty only) Connections between hosts are reused in order to reduce connection buildup for
869+
large clusters. For clusters with many hard disks and few hosts, this may result in insufficient
870+
concurrency to saturate all disks, and so users may consider increasing this value.
871+
</td>
872+
</tr>
873+
<tr>
874+
<td><code>spark.shuffle.io.maxRetries</code></td>
875+
<td>3</td>
876+
<td>
877+
(Netty only) Fetches that fail due to IO-related exceptions are automatically retried if this is
878+
set to a non-zero value. This retry logic helps stabilize large shuffles in the face of long GC
879+
pauses or transient network connectivity issues.
880+
</td>
881+
</tr>
882+
<tr>
883+
<td><code>spark.shuffle.io.retryWait</code></td>
884+
<td>5</td>
885+
<td>
886+
(Netty only) Seconds to wait between retries of fetches. The maximum delay caused by retrying
887+
is simply <code>maxRetries * retryWait</code>, by default 15 seconds.
888+
</td>
889+
</tr>
855890
</table>
856891

857892
#### Scheduling

network/common/src/main/java/org/apache/spark/network/util/TransportConf.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public int connectionTimeoutMs() {
4040
return conf.getInt("spark.shuffle.io.connectionTimeout", 120) * 1000;
4141
}
4242

43-
/** Number of concurrent connections between two nodes for fetching data. **/
43+
/** Number of concurrent connections between two nodes for fetching data. */
4444
public int numConnectionsPerPeer() {
4545
return conf.getInt("spark.shuffle.io.numConnectionsPerPeer", 1);
4646
}

0 commit comments

Comments
 (0)