Skip to content

Commit

Permalink
[hotfix][doc] Generate and use docs of RpcOptions instead of AkkaOptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@Zakelly
Zakelly committed Apr 7, 2024
1 parent 2747a58 commit 1eeedee
Show file tree
Hide file tree
Showing 3 changed files with 152 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/content.zh/docs/deployment/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ These options are for the network stack that handles the streaming and batch dat
Flink uses Pekko for RPC between components (JobManager/TaskManager/ResourceManager).
Flink does not use Pekko for data transport.

{{< generated/akka_configuration >}}
{{< generated/rpc_configuration >}}

----
----
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/deployment/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ These options are for the network stack that handles the streaming and batch dat
Flink uses Pekko for RPC between components (JobManager/TaskManager/ResourceManager).
Flink does not use Pekko for data transport.

{{< generated/akka_configuration >}}
{{< generated/rpc_configuration >}}

----
----
Expand Down
150 changes: 150 additions & 0 deletions docs/layouts/shortcodes/generated/rpc_configuration.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
<table class="configuration table table-bordered">
<thead>
<tr>
<th class="text-left" style="width: 20%">Key</th>
<th class="text-left" style="width: 15%">Default</th>
<th class="text-left" style="width: 10%">Type</th>
<th class="text-left" style="width: 55%">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><h5>pekko.ask.callstack</h5></td>
<td style="word-wrap: break-word;">true</td>
<td>Boolean</td>
<td>If true, call stack for asynchronous asks are captured. That way, when an ask fails (for example times out), you get a proper exception, describing to the original method call and call site. Note that in case of having millions of concurrent RPC calls, this may add to the memory footprint.</td>
</tr>
<tr>
<td><h5>pekko.ask.timeout</h5></td>
<td style="word-wrap: break-word;">10 s</td>
<td>Duration</td>
<td>Timeout used for all futures and blocking Pekko calls. If Flink fails due to timeouts then you should try to increase this value. Timeouts can be caused by slow machines or a congested network. The timeout value requires a time-unit specifier (ms/s/min/h/d).</td>
</tr>
<tr>
<td><h5>pekko.client-socket-worker-pool.pool-size-factor</h5></td>
<td style="word-wrap: break-word;">1.0</td>
<td>Double</td>
<td>The pool size factor is used to determine thread pool size using the following formula: ceil(available processors * factor). Resulting size is then bounded by the pool-size-min and pool-size-max values.</td>
</tr>
<tr>
<td><h5>pekko.client-socket-worker-pool.pool-size-max</h5></td>
<td style="word-wrap: break-word;">2</td>
<td>Integer</td>
<td>Max number of threads to cap factor-based number to.</td>
</tr>
<tr>
<td><h5>pekko.client-socket-worker-pool.pool-size-min</h5></td>
<td style="word-wrap: break-word;">1</td>
<td>Integer</td>
<td>Min number of threads to cap factor-based number to.</td>
</tr>
<tr>
<td><h5>pekko.fork-join-executor.parallelism-factor</h5></td>
<td style="word-wrap: break-word;">2.0</td>
<td>Double</td>
<td>The parallelism factor is used to determine thread pool size using the following formula: ceil(available processors * factor). Resulting size is then bounded by the parallelism-min and parallelism-max values.</td>
</tr>
<tr>
<td><h5>pekko.fork-join-executor.parallelism-max</h5></td>
<td style="word-wrap: break-word;">64</td>
<td>Integer</td>
<td>Max number of threads to cap factor-based parallelism number to.</td>
</tr>
<tr>
<td><h5>pekko.fork-join-executor.parallelism-min</h5></td>
<td style="word-wrap: break-word;">8</td>
<td>Integer</td>
<td>Min number of threads to cap factor-based parallelism number to.</td>
</tr>
<tr>
<td><h5>pekko.framesize</h5></td>
<td style="word-wrap: break-word;">"10485760b"</td>
<td>String</td>
<td>Maximum size of messages which are sent between the JobManager and the TaskManagers. If Flink fails because messages exceed this limit, then you should increase it. The message size requires a size-unit specifier.</td>
</tr>
<tr>
<td><h5>pekko.jvm-exit-on-fatal-error</h5></td>
<td style="word-wrap: break-word;">true</td>
<td>Boolean</td>
<td>Exit JVM on fatal Pekko errors.</td>
</tr>
<tr>
<td><h5>pekko.log.lifecycle.events</h5></td>
<td style="word-wrap: break-word;">false</td>
<td>Boolean</td>
<td>Turns on the Pekko’s remote logging of events. Set this value to 'true' in case of debugging.</td>
</tr>
<tr>
<td><h5>pekko.lookup.timeout</h5></td>
<td style="word-wrap: break-word;">10 s</td>
<td>Duration</td>
<td>Timeout used for the lookup of the JobManager. The timeout value has to contain a time-unit specifier (ms/s/min/h/d).</td>
</tr>
<tr>
<td><h5>pekko.remote-fork-join-executor.parallelism-factor</h5></td>
<td style="word-wrap: break-word;">2.0</td>
<td>Double</td>
<td>The parallelism factor is used to determine thread pool size using the following formula: ceil(available processors * factor). Resulting size is then bounded by the parallelism-min and parallelism-max values.</td>
</tr>
<tr>
<td><h5>pekko.remote-fork-join-executor.parallelism-max</h5></td>
<td style="word-wrap: break-word;">16</td>
<td>Integer</td>
<td>Max number of threads to cap factor-based parallelism number to.</td>
</tr>
<tr>
<td><h5>pekko.remote-fork-join-executor.parallelism-min</h5></td>
<td style="word-wrap: break-word;">8</td>
<td>Integer</td>
<td>Min number of threads to cap factor-based parallelism number to.</td>
</tr>
<tr>
<td><h5>pekko.retry-gate-closed-for</h5></td>
<td style="word-wrap: break-word;">50</td>
<td>Long</td>
<td>Milliseconds a gate should be closed for after a remote connection was disconnected.</td>
</tr>
<tr>
<td><h5>pekko.server-socket-worker-pool.pool-size-factor</h5></td>
<td style="word-wrap: break-word;">1.0</td>
<td>Double</td>
<td>The pool size factor is used to determine thread pool size using the following formula: ceil(available processors * factor). Resulting size is then bounded by the pool-size-min and pool-size-max values.</td>
</tr>
<tr>
<td><h5>pekko.server-socket-worker-pool.pool-size-max</h5></td>
<td style="word-wrap: break-word;">2</td>
<td>Integer</td>
<td>Max number of threads to cap factor-based number to.</td>
</tr>
<tr>
<td><h5>pekko.server-socket-worker-pool.pool-size-min</h5></td>
<td style="word-wrap: break-word;">1</td>
<td>Integer</td>
<td>Min number of threads to cap factor-based number to.</td>
</tr>
<tr>
<td><h5>pekko.ssl.enabled</h5></td>
<td style="word-wrap: break-word;">true</td>
<td>Boolean</td>
<td>Turns on SSL for Pekko’s remote communication. This is applicable only when the global ssl flag security.ssl.enabled is set to true.</td>
</tr>
<tr>
<td><h5>pekko.startup-timeout</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Timeout after which the startup of a remote component is considered being failed.</td>
</tr>
<tr>
<td><h5>pekko.tcp.timeout</h5></td>
<td style="word-wrap: break-word;">"20 s"</td>
<td>String</td>
<td>Timeout for all outbound connections. If you should experience problems with connecting to a TaskManager due to a slow network, you should increase this value.</td>
</tr>
<tr>
<td><h5>pekko.throughput</h5></td>
<td style="word-wrap: break-word;">15</td>
<td>Integer</td>
<td>Number of messages that are processed in a batch before returning the thread to the pool. Low values denote a fair scheduling whereas high values can increase the performance at the cost of unfairness.</td>
</tr>
</tbody>
</table>

0 comments on commit 1eeedee

Please sign in to comment.