Add debug information to the S3 adapter #45
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tw4l
approved these changes
Feb 25, 2021
administrators.rst
Outdated
| There is more information about overriding the Storage Service defaults in the | ||
| `installation README.md`_. | ||
|
|
||
| In the logging configuration, administrators should be able to find entries for |
There was a problem hiding this comment.
Maybe worth linking to the logging configuration file in the source code?
There was a problem hiding this comment.
Nice idea, will do!
administrators.rst
Outdated
| Debugging S3 | ||
| """""""""""" | ||
|
|
||
| There are times when the S3 storage adapter needs to be debugged. For example, |
There was a problem hiding this comment.
Maybe "may need to be debugged" would be more accurate? Should work out of the box for at least some folks.
Comment on lines
+789
to
+795
| From the documentation, the `Boto3 developers`_ are careful to note as follows: | ||
|
|
||
| .. warning:: | ||
|
|
||
| Be aware that when logging anything from 'botocore' the full wire trace | ||
| will appear in your logs. If your payloads contain sensitive data this | ||
| should not be used in production. |
There was a problem hiding this comment.
Nice touch! Glad this is in here.
administrators.rst
Outdated
|
|
||
| Changing the log level for these entries from INFO to DEBUG will output the | ||
| entire wire-trace between the Storage Service and your S3 implementation | ||
| through the lens of the Boto3 SDK. The standard boto3 logging will provide |
There was a problem hiding this comment.
We seem to be capitalizing "Boto3" elsewhere - might be good to be consistent
There was a problem hiding this comment.
Good catch! It will be a blessing you won't have too many more PRs from me you have to pickup my terribly consistent habit of inconsistency!! 😆
Using some of the lessons learned with S3 recently we update the documentation to provide more tips on debugging than was available before.
ross-spencer
force-pushed
the
dev/add-s3-logging-info
branch
from
1d2364a to
e62162b
Compare
|
Merci buckets! One last thing on the list! Thanks Tessa 🙇 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using some of the lessons learned with S3 recently we update the
documentation to provide more tips on debugging than was available
before.
Connected to archivematica/Issues#1346