Skip to content

Commit 8d01295

Browse files
authored
PBM-1093 Documeted retry for Azure (#310)
* PBM-1093 Documeted retry for Azure modified: docs/details/azure.md modified: docs/reference/configuration-options.md
1 parent 41ca8c7 commit 8d01295

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

docs/details/azure.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,17 @@ storage:
8080
```
8181
8282
For the description of configuration options, see [Configuration file options](../reference/configuration-options.md).
83+
84+
85+
## Upload retries
86+
87+
You can set up the number of attempts for Percona Backup for MongoDB to upload data to Microsoft Azure storage as well as the min and max time to wait for the next retry. Set the options `storage.azure.retryer.numMaxRetries`, `storage.azure.retryer.minRetryDelay` and `storage.azure.retryer.maxRetryDelay` in Percona Backup for MongoDB configuration.
88+
89+
```yaml
90+
retryer:
91+
numMaxRetries: 3
92+
minRetryDelay: 800ms
93+
maxRetryDelay: 60s
94+
```
95+
96+
This upload retry increases the chances of data upload completion in cases of unstable connection.

docs/reference/configuration-options.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,10 @@ storage:
544544
credentials:
545545
key: <your-access-key>
546546
maxObjSizeGB: 194560
547+
retryer:
548+
numMaxRetries: 3
549+
minRetryDelay: 800ms
550+
maxRetryDelay: 60s
547551
```
548552

549553
### storage.azure.account
@@ -597,6 +601,30 @@ Your access key to authorize access to data in your storage account.
597601

598602
The maximum file size to be stored on the backup storage. If the file to upload exceeds this limit, PBM splits it in pieces, each of which falls within the defined limit. Read more about [Managing large backup files](../features/split-merge-backup.md).
599603

604+
### storage.azure.retryer.numMaxRetries
605+
606+
*Type*: int <br>
607+
*Required*: NO <br>
608+
*Default*: 3
609+
610+
The maximum number of retries to upload data to Microsoft Azure storage. A zero value means no retries will be performed.
611+
612+
### storage.azure.retryer.minRetryDelay
613+
614+
*Type*: time.Duration <br>
615+
*Required*: NO <br>
616+
*Default*: 800ms
617+
618+
The minimum time to wait before the next retry, specified as a `time.Duration`. Units like ms, s, etc., are supported. Defaults to nanoseconds if no unit is provided.
619+
620+
621+
### storage.azure.retryer.maxRetryDelay
622+
623+
*Type*: time.Duration <br>
624+
*Required*: NO <br>
625+
*Default*: 60s
626+
627+
The maximum time to wait before the next retry, specified as a `time.Duration`. Units like ms, s, etc., are supported. Defaults to nanoseconds if no unit is provided.
600628

601629
## Alibaba Cloud OSS storage options
602630

0 commit comments

Comments
 (0)