Split API call and traceback logging into different log files #760
Conversation
This file contains hidden or 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
neiljp
force-pushed
the
2020-08-01-separate-loggers
branch
from
71e348d to
fbbe9ba
Compare
preetmishra
reviewed
Aug 2, 2020
There was a problem hiding this comment.
@neiljp Thanks for extracting the API log. I tested this locally and it seems to work well. This would surely make debugging easier. 👍
I believe logging API calls only in the debug/development mode seems reasonable.
neiljp
force-pushed
the
2020-08-01-separate-loggers
branch
2 times, most recently
from
9159509 to
487b094
Compare
|
@preetmishra Thanks for the review 👍 Updated to use the more specific file and variable names, and only show API calls in debug mode. |
preetmishra
reviewed
Aug 3, 2020
There was a problem hiding this comment.
@neiljp Thanks for the amendments. I tested it locally and it works as expected. The commit looks good too. 👍
Let's add zulip-terminal-API-requests.log to our .gitignore before merging. 🎉
Previously the zulip-terminal-traceback.log file was polluted with urllib3/requests debug messages. This separates these two sources. The files are currently set as: * zulip-terminal-API-requests.log - urllib3 events (API calls) * zulip-terminal-tracebacks.log - exceptions specific to ZT The API log file is only generated when debug mode is enabled (-d/--debug), and the traceback log file is only opened when an exception gets logged (delay=True). When non-developer users run ZT, this should minimize the generated log files unless specifically requested or in case of bugs. Additional log file added to .gitignore.
neiljp
force-pushed
the
2020-08-01-separate-loggers
branch
from
487b094 to
f62515b
Compare
|
@preetmishra I have quite some extra files so .gitignore doesn't show a clean tree often, so thanks for the reminder 👍 |
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.
Previously the zulip-terminal-traceback.log file was polluted with urllib3/requests debug messages. This separates these two sources.
In future, we could enable API call logging only in a debug or development mode.
We could potentially do the latter sooner rather than later - thoughts?