Skip to content

PBM-1093 Documeted retry for Azure #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nastena1606 merged 5 commits into from
Nov 4, 2025
Merged

PBM-1093 Documeted retry for Azure #310

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e50e224
PBM-1093 Documeted retry for Azure
nastena1606 Oct 21, 2025
858f2e0
Update docs/reference/configuration-options.md
nastena1606 Oct 31, 2025
7281791
Apply suggestion from @Copilot
nastena1606 Oct 31, 2025
24a5d07
Apply suggestion from @Copilot
nastena1606 Oct 31, 2025
513d2dc
Merge branch 'main' into PBM-1093-Doc-Azure-retryer-options
nastena1606 Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/details/azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,17 @@ storage:
```

For the description of configuration options, see [Configuration file options](../reference/configuration-options.md).


## Upload retries

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.

```yaml
retryer:
numMaxRetries: 3
minRetryDelay: 800
maxRetryDelay: 60
```

This upload retry increases the chances of data upload completion in cases of unstable connection.
29 changes: 29 additions & 0 deletions docs/reference/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,10 @@
credentials:
key: <your-access-key>
maxObjSizeGB: 194560
retryer:
numMaxRetries: 3
minRetryDelay: 800
maxRetryDelay: 60
```

### storage.azure.account
Expand Down Expand Up @@ -432,3 +436,28 @@
*Default*: 194560

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).

### storage.azure.retryer.numMaxRetries

*Type*: int <br>
*Required*: NO <br>

Check warning on line 443 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L443 

[Google.Colons] ': N' should be in lowercase.
Raw output 
{"message": "[Google.Colons] ': N' should be in lowercase.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 443, "column": 11}}}, "severity": "WARNING"}
*Default*: 3

The maximum number of retries to upload data to Microsoft Azure storage. A zero value means no retries will be performed.

Check warning on line 446 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L446 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 446, "column": 104}}}, "severity": "WARNING"}

Check notice on line 446 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L446 

[Google.Passive] In general, use active voice instead of passive voice ('be performed').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be performed').", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 446, "column": 109}}}, "severity": "INFO"}

### storage.azure.retryer.minRetryDelay

*Type*: time.Duration <br>

Check failure on line 450 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L450 

[Google.Spacing] 'e.D' should have one space.
Raw output 
{"message": "[Google.Spacing] 'e.D' should have one space.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 450, "column": 12}}}, "severity": "ERROR"}
*Required*: NO <br>

Check warning on line 451 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L451 

[Google.Colons] ': N' should be in lowercase.
Raw output 
{"message": "[Google.Colons] ': N' should be in lowercase.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 451, "column": 11}}}, "severity": "WARNING"}
*Default*: 800ms

Check failure on line 452 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L452 

[Google.Units] Put a nonbreaking space between the number and the unit in '800ms'.
Raw output 
{"message": "[Google.Units] Put a nonbreaking space between the number and the unit in '800ms'.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 452, "column": 12}}}, "severity": "ERROR"}

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.

Check notice on line 454 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L454 

[Google.Passive] In general, use active voice instead of passive voice ('are supported').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are supported').", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 454, "column": 105}}}, "severity": "INFO"}

Check notice on line 454 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L454 

[Google.Passive] In general, use active voice instead of passive voice ('is provided').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 454, "column": 155}}}, "severity": "INFO"}


### storage.azure.retryer.maxRetryDelay

*Type*: time.Duration <br>

Check failure on line 459 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L459 

[Google.Spacing] 'e.D' should have one space.
Raw output 
{"message": "[Google.Spacing] 'e.D' should have one space.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 459, "column": 12}}}, "severity": "ERROR"}
*Required*: NO <br>

Check warning on line 460 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L460 

[Google.Colons] ': N' should be in lowercase.
Raw output 
{"message": "[Google.Colons] ': N' should be in lowercase.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 460, "column": 11}}}, "severity": "WARNING"}
*Default*: 60s

Check failure on line 461 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L461 

[Google.Units] Put a nonbreaking space between the number and the unit in '60s'.
Raw output 
{"message": "[Google.Units] Put a nonbreaking space between the number and the unit in '60s'.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 461, "column": 12}}}, "severity": "ERROR"}

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.

Check notice on line 463 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L463 

[Google.Passive] In general, use active voice instead of passive voice ('are supported').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are supported').", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 463, "column": 105}}}, "severity": "INFO"}

Check notice on line 463 in docs/reference/configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/configuration-options.md#L463 

[Google.Passive] In general, use active voice instead of passive voice ('is provided').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 463, "column": 155}}}, "severity": "INFO"}