Skip to content

PBM-1608 Documented debugTrace option for GCS #314

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

PBM-1608 Documented debugTrace option for GCS #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions docs/details/gcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,13 @@ You can find [the configuration file template :octicons-link-external-16:](https
hmacSecret: <your-secret-key-here>
```

## Debug logging

You can enable debug logging for different types of requests to GCS in Percona Backup for MongoDB. Percona Backup for MongoDB prints log messages in the `pbm logs` output so that you can debug and diagnose GCS request issues or failures.

To enable S3 debug logging, set the `storage.gcs.debugTrace` option in Percona Backup for MongoDB configuration. This instructs PBM to also print HTTP trace from the MinIO storage in the logs.


## Adjust PBM configuration to use GCS

Starting with version 2.10.0, PBM uses the Google Cloud SDK instead of AWS SDK. If you are upgrading from an earlier version, you need to adjust your PBM configuration as follows:
Expand Down
7 changes: 7 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 @@ -350,6 +350,13 @@

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.gcs.debugTrace

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Headings] 'storage.gcs.debugTrace' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'storage.gcs.debugTrace' should use sentence-style capitalization.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 353, "column": 5}}}, "severity": "WARNING"}

*Type*: boolean

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

View workflow job for this annotation

GitHub Actions / vale

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

[Vale.Spelling] Did you really mean 'boolean'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'boolean'?", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 355, "column": 9}}}, "severity": "ERROR"}
*Required*: NO

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

View workflow job for this annotation

GitHub Actions / vale

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

[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": 356, "column": 11}}}, "severity": "WARNING"}

When set to `true`, activates detailed logging of HTTP requests and responses between PBM and GCS.

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Acronyms] Spell out 'GCS', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'GCS', if it's unfamiliar to the audience.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 358, "column": 95}}}, "severity": "INFO"}

## Filesystem storage options

```yaml
Expand Down