Skip to content

PBM-1474 Updated the description of DebugLogLevel param #249

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

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

PBM-1474 Updated the description of DebugLogLevel param #249

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
16 changes: 14 additions & 2 deletions docs/reference/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,21 @@

Enables S3 debug logging for different types of S3 requests. S3 log messages are printed in the `pbm logs` output.

Supported values are: `LogDebug`, `Signing`, `HTTPBody`, `RequestRetries`, `RequestErrors`, `EventStreamBody`.
Starting with version 2.9.0, PBM uses AWS SDK v2. The AWS SDK v1 values are deprecated. They are kept for backward compatibility.

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

View workflow job for this annotation

GitHub Actions / vale

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

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

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Contractions] Use 'they're' instead of 'They are'.
Raw output 
{"message": "[Google.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "docs/reference/configuration-options.md", "range": {"start": {"line": 161, "column": 89}}}, "severity": "INFO"}

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

View workflow job for this annotation

GitHub Actions / vale

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

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

To specify several event types, separate them by comma. To lean more about the event types, see [the documentation](https://pkg.go.dev/github.com/aws/[email protected]/aws#LogLevelType)
Please find the mapping table below:

| AWS SDK v1 value | AWS SDK v2 value |
|------------------|------------------|
| `LogDebug` | `LogRequest` <br> `LogResponse`|
| `Signing` | `LogSigning`|
| `HTTPBody` | `LogRequestWithBody` <br> LogResponseWithBody|
| `RequestRetries` | `LogDebugWithRequestRetries`|
| `RequestErrors` | `LogDebugWithRequestErrors`|
| `EventStreamBody`| `LogRequestWithBody` <br> `LogResponseWithBody`|


To specify several event types, separate them by comma. To learn more about the event types, see [the documentation :octicons-link-external-16:](https://pkg.go.dev/github.com/aws/[email protected]/aws#LogLevelType)

When undefined, no S3 debug logging is performed.

Expand Down