[docs] More detailed guide to investigating and enabling logs #4359
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
eloquence
requested review from
emkll,
kushaldas and
redshiftzero
as code owners
zenmonkeykstop
requested changes
Apr 23, 2019
"Look at these logs" is one of the most common support responses, so having canonical and correct information in the public docs is important and reduces the risk of small errors in these communications. I moved the `securedrop-admin logs` instructions into an include file, since it is a common operation we will likely want to refer to again in future, and renamed the section to "Investigating Logs", since it is now hopefully beginning to be deserving of such a title. ;) Resolves #4356
eloquence
force-pushed
the
docs-enable-logging
branch
from
141f855
to
433ead7
Compare
eloquence
changed the title
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.
"Look at these logs" is one of the most common support responses, so having canonical and correct information in the public docs is important and reduces the risk of small errors in these communications.
As part of this PR, I moved the
securedrop-admin logsinstructions into an include file, since it is a common operation we will likely want to refer to again in future, and renamed the section to "Investigating Logs", since it is now hopefully beginning to be deserving of such a title. ;)Resolves #4356
Status
Ready for review
Test plan
This PR includes instructions for enabling error logging on the source interface. To test, follow these instructions on production hardware or a prod VM (logging on the source interface is enabled in staging, but not in prod).
To verify that errors are logged, you may want to produce an exception by introducing an error into a component of the Source Interface in
/var/www/securedrop(and of course, later reverting it); I tested by making a syntax error modification insource.py. Confirm that you are in fact seeing the Internal Server Error on the Source Interface; if so, you should be seeing it in the log file, as well.Checklist
make docs-lint) passed locally