Skip to content

Commit f5fb25c

Browse files
committed
Fix verb
1 parent 03056c9 commit f5fb25c

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

.vale/Vocab/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ receiveDeadline
7272
receiveTimeout
7373
sendDeadline
7474
dialTimeout
75+
backoff
7576
backoffMultiplier
7677
disableBackoffCaps
7778
API

using-gatewayd/clients.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The dial timeout is the amount of time the client should wait before giving up o
4747
4848
## Retries and backoff
4949
50-
The first attempt to connect to the database server is made when the client is created, which happens instantly when GatewayD starts. However, if the first attempt fails, the client will retry the connection. The default number of retries is `3`, which means that the client will retry the connection three times before giving up. Setting it to `0` disables the retry mechanism. The client can also backoff before retrying the connection. The backoff duration is set to `1s` by default and `0s` disables the backoff mechanism. The backoff multiplier is set to `2` by default and `0` disables the backoff. The backoff multiplier is applied to the backoff duration. The backoff duration is capped at `60s` by default and the max retry is capped at `10` by default. Setting `disableBackoffCaps` to `true` disables the backoff and retry caps.
50+
The first attempt to connect to the database server is made when the client is created, which happens instantly when GatewayD starts. However, if the first attempt fails, the client will retry the connection. The default number of retries is `3`, which means that the client will retry the connection three times before giving up. Setting it to `0` disables the retry mechanism. The client can also back off before retrying the connection. The backoff duration is set to `1s` by default and `0s` disables the backoff mechanism. The backoff multiplier is set to `2` by default and `0` disables the backoff. The backoff multiplier is applied to the backoff duration. The backoff duration is capped at `60s` by default and the max retry is capped at `10` by default. Setting `disableBackoffCaps` to `true` disables the backoff and retry caps.
5151
5252
{: .note }
5353
> The first attempt to connect to the database server is counted as a retry, hence the three retries are actually four attempts (one instant attempt and three retry attempts), and the backoff duration is applied to the second attempt and so on.

using-gatewayd/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ clients:
8686
# Retry configuration
8787
retries: 3 # 0 means no retry
8888
backoff: 1s # duration
89-
backoffMultiplier: 2 # 0 means no backoff
89+
backoffMultiplier: 2.0 # 0 means no backoff
9090
disableBackoffCaps: false
9191

9292
pools:

using-gatewayd/global-configuration/clients.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ GatewayD supports multiple client configurations. Each client in each configurat
2727
| dialTimeout | duration (string) | 60s | Valid duration strings | The amount of time the client should wait before giving up on dialing the database. `0s` disables dial timeout. |
2828
| retries | number | 3 | Positive integers | The amount of times to retry a failed connection. `0` means no retry. |
2929
| backoff | duration (string) | 1s | Valid duration strings | The amount of time to wait before retrying a failed connection. `0s` means no backoff. |
30-
| backoffMultiplier | number | 2 | Positive integers | The multiplier to apply to the backoff duration. `0` means no backoff. |
30+
| backoffMultiplier | number | 2.0 | Positive integers | The multiplier to apply to the backoff duration. `0` means no backoff. |
3131
| disableBackoffCaps | boolean | False | True, False | Whether to disable the backoff caps for backoff multiplier and backoff duration. |
3232

3333
```yaml
@@ -45,6 +45,6 @@ clients:
4545
# Retry configuration
4646
retries: 3 # 0 means no retry
4747
backoff: 1s # duration
48-
backoffMultiplier: 2 # 0 means no backoff
48+
backoffMultiplier: 2.0 # 0 means no backoff
4949
disableBackoffCaps: false
5050
```

0 commit comments

Comments
 (0)