Skip to content
Permalink
Browse files
HAWQ-1280 Add documentation for gp_interconnect* parameters (closes #89)
  • Loading branch information
@janebeckman @dyozie
janebeckman authored and dyozie committed Jan 25, 2017
1 parent 2351d28 commit 18e72d6a22fffc3e1554825a06259a3ccb2a0810
Showing 3 changed files with 116 additions and 1 deletion.
6 book/master_middleman/source/subnavs/apache-hawq-nav-210.erb
View file
@@ -518,11 +518,17 @@
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_filerep_tcp_keepalives_interval">gp_filerep_tcp_keepalives_interval</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_hashjoin_tuples_per_bucket">gp_hashjoin_tuples_per_bucket</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_idf_deduplicate">gp_idf_deduplicate</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_cache_future_packets">gp_interconnect_cache_future_packets</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_default_rtt">gp_interconnect_default_rtt</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_fc_method">gp_interconnect_fc_method</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_hash_multiplier">gp_interconnect_hash_multiplier</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_min_retries_before_timeout">gp_interconnect_min_retries_before_timeout</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_min_rto">gp_interconnect_min_rto</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_queue_depth">gp_interconnect_queue_depth</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_setup_timeout">gp_interconnect_setup_timeout</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_snd_queue_depth">gp_interconnect_snd_queue_depth</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_timer_checking_period">gp_interconnect_timer_checking_period</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_timer_period">gp_interconnect_timer_period</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_interconnect_type">gp_interconnect_type</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_log_format">gp_log_format</a></li>
<li><a href="/docs/userguide/2.1.0.0-incubating/reference/guc/parameter_definitions.html#gp_max_csv_line_length">gp_max_csv_line_length</a></li>
12 markdown/reference/guc/guc_category-list.html.md.erb
View file
@@ -154,11 +154,21 @@ The parameters in this topic control the configuration of the HAWQ array and its

### <a id="topic50"></a>Interconnect Configuration Parameters

- [gp\_interconnect\_cache\_future\_packets](../../reference/guc/parameter_definitions.html#gp_interconnect_cache_future_packets)
- [gp\_interconnect\_default\_rtt](../../reference/guc/parameter_definitions.html#gp_interconnect_default_rtt)
- [gp\_interconnect\_fc\_method](parameter_definitions.html#gp_interconnect_fc_method)
- [gp\_interconnect\_hash\_multiplier](parameter_definitions.html#gp_interconnect_hash_multiplier)
- [gp\_interconnect\_min\_retries\_before\_timeout](../../reference/guc/parameter_definitions.html#gp_interconnect_min_retries_before_timeout)
- [gp\_interconnect\_min\_rto](../../reference/guc/parameter_definitions.html#gp_interconnect_min_rto)
- [gp\_interconnect\_queue\_depth](parameter_definitions.html#gp_interconnect_queue_depth)
- [gp\_interconnect\_snd\_queue\_depth](parameter_definitions.html#gp_interconnect_snd_queue_depth)
- [gp\_interconnect\_setup\_timeout](parameter_definitions.html#gp_interconnect_setup_timeout)
- [gp\_interconnect\_snd\_queue\_depth](parameter_definitions.html#gp_interconnect_snd_queue_depth)
- [gp\_interconnect\_timer\_checking\_period
](../../reference/guc/parameter_definitions.html#gp_interconnect_timer_checking_period
)
- [gp\_interconnect\_timer\_period
](../../reference/guc/parameter_definitions.html#gp_interconnect_timer_period
)
- [gp\_interconnect\_type](parameter_definitions.html#gp_interconnect_type)
- [gp\_max\_packet\_size](parameter_definitions.html#gp_max_packet_size)

99 markdown/reference/guc/parameter_definitions.html.md.erb
View file
@@ -167,17 +167,32 @@ Descriptions of the HAWQ server configuration parameters listed alphabetically.
- **[gp\_hashjoin\_tuples\_per\_bucket](../../reference/guc/parameter_definitions.html#gp_hashjoin_tuples_per_bucket)**

- **[gp\_idf\_deduplicate](../../reference/guc/parameter_definitions.html#gp_idf_deduplicate)**

- **[gp\_interconnect\_cache\_future\_packets](../../reference/guc/parameter_definitions.html#gp_interconnect_cache_future_packets)**

- **[gp\_interconnect\_default\_rtt](../../reference/guc/parameter_definitions.html#gp_interconnect_default_rtt)**

- **[gp\_interconnect\_fc\_method](../../reference/guc/parameter_definitions.html#gp_interconnect_fc_method)**

- **[gp\_interconnect\_hash\_multiplier](../../reference/guc/parameter_definitions.html#gp_interconnect_hash_multiplier)**

- **[gp\_interconnect\_min\_retries\_before\_timeout](../../reference/guc/parameter_definitions.html#gp_interconnect_min_retries_before_timeout)**

- **[gp\_interconnect\_min\_rto](../../reference/guc/parameter_definitions.html#gp_interconnect_min_rto)**
- **[gp\_interconnect\_queue\_depth](../../reference/guc/parameter_definitions.html#gp_interconnect_queue_depth)**

- **[gp\_interconnect\_setup\_timeout](../../reference/guc/parameter_definitions.html#gp_interconnect_setup_timeout)**

- **[gp\_interconnect\_snd\_queue\_depth](../../reference/guc/parameter_definitions.html#gp_interconnect_snd_queue_depth)**

- **[gp\_interconnect\_timer\_period
](../../reference/guc/parameter_definitions.html#gp_interconnect_timer_period
)**

- **[gp\_interconnect\_timer\_checking\_period
](../../reference/guc/parameter_definitions.html#gp_interconnect_timer_checking_period
)**

- **[gp\_interconnect\_type](../../reference/guc/parameter_definitions.html#gp_interconnect_type)**

- **[gp\_log\_format](../../reference/guc/parameter_definitions.html#gp_log_format)**
@@ -1371,6 +1386,41 @@ Changes the strategy to compute and process MEDIAN, and PERCENTILE\_DISC.
</tbody>
</table>

## <a name="gp_interconnect_cache_future_packets"></a>gp\_interconnect\_cache\_future\_packets

Controls whether future packets are cached.

| Value Range | Default | Set Classifications |
|-------------|-----------|-------------------------|
| Boolean | true (on) | master, session, reload |


## <a name="gp_interconnect_default_rtt"></a>gp\_interconnect\_default\_rtt

Sets the default rtt (in ms) for UDP interconnect.

<table>
<colgroup>
<col width="33%" />
<col width="33%" />
<col width="33%" />
</colgroup>
<thead>
<tr class="header">
<th>Value Range</th>
<th>Default</th>
<th>Set Classifications</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>1-1000ms</td>
<td>20ms</td>
<td>master, session, reload</td>
</tr>
</tbody>
</table>

## <a name="gp_interconnect_fc_method"></a>gp\_interconnect\_fc\_method

Specifies the flow control method used for UDP interconnect when the value of [gp\_interconnect\_type](#gp_interconnect_type) is UDPIFC.
@@ -1410,6 +1460,25 @@ Sets the size of the hash table used by the UDP interconnect to track connection
|-------------|---------|-------------------------|
| 2-25 | 2 | master, session, reload |

## <a name="gp_interconnect_min_retries_before\_timeout"></a>gp\_interconnect\_min\_retries\_before\_timeout

Sets the minimum number of retries before reporting a transmit timeout in the interconnect.

| Value Range | Default | Set Classifications |
|-------------|---------|-------------------------|
| 1-4096 | 100 | master, session, reload |


## <a name="gp_interconnect_min_rto"></a>gp\_interconnect\_min\_rto

Sets the minimum rto (in ms) for UDP interconnect.

| Value Range | Default | Set Classifications |
|-------------|---------|-------------------------|
|1-1000ms | 20ms | master, session, reload |



## <a name="gp_interconnect_queue_depth"></a>gp\_interconnect\_queue\_depth

Sets the amount of data per-peer to be queued by the UDP interconnect on receivers (when data is received but no space is available to receive it the data will be dropped, and the transmitter will need to resend it). Increasing the depth from its default value will cause the system to use more memory; but may increase performance. It is reasonable for this to be set between 1 and 10. Queries with data skew potentially perform better when this is increased. Increasing this may radically increase the amount of memory used by the system.
@@ -1438,6 +1507,36 @@ This parameter is used only when [gp\_interconnect\_type](#gp_interconnect_type)
|-------------|---------|-------------------------|
| 1 - 4096 | 2 | master, session, reload |

## <a name="gp_interconnect_timer_period"></a>gp\_interconnect\_timer\_period

Sets the timer period (in ms) for UDP interconnect.

| Value Range | Default | Set Classifications |
|-------------|---------|-------------------------|
| 1-100ms | 5ms | master, session, reload |



## <a name="gp_interconnect_timer_checking_period"></a>gp\_interconnect\_timer\_checking\_period

Sets the timer checking period (in ms) for UDP interconnect.

| Value Range | Default | Set Classifications |
|-------------|---------|-------------------------|
| 1-100ms | 20ms | master, session, reload |



## <a name="gp_interconnect_transmit_timeout"></a>gp\_interconnect\_transmit\_timeout

Timeout (in seconds) on interconnect to transmit a packet.

| Value Range | Default | Set Classifications |
|-------------|---------|-------------------------|
| 1-7200s | 3600s | master, session, reload |



## <a name="gp_interconnect_type"></a>gp\_interconnect\_type

Sets the networking protocol used for Interconnect traffic. With the TCP protocol, HAWQ has an upper limit of 1000 segment instances - less than that if the query workload involves complex, multi-slice queries.

0 comments on commit 18e72d6

Please sign in to comment.