Add support for (internal) debug logging output #289
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
atc0005
added
enhancement
atc0005
force-pushed
the
i271-add-support-for-debug-logging-output
branch
from
f3710cc
to
74a99ad
Compare
OVERVIEW
The changes provided by this commit were initially intended to provide
a minimal abstraction to support toggling the size of plugin output
off/on as needed for troubleshooting. From there the scope widened as
further iteration showed that it could be useful to add debug logging
support (internally for now) to the library as a whole.
To support toggling on/off specific debug log activity, debug log
output is currently split into two categories:
- debug logging of actions
- debug logging of plugin output size
The intent of these changes is to provide a way to easily toggle
on/off the internal workings of this library. If client code does not
enable debug logging, the result should be this library working just
as it did before.
The current implementation is subject to change as real world testing
is applied and feedback collected.
CHANGES
- allow toggling debug logging output on/off
- allow toggling specific debug logging output on/off
- e.g., allow all debug messages except for general plugin activity
- e.g., allow only debug messages for plugin output size calculations
- support setting custom debug logging output target
- e.g., redirect debug log messages to a target file instead of
stderr (the default debug log target)
- add test coverage for new behavior
- update documentation for (internal) debug logging
- update README and add example tests to illustrate new behavior
- log early exit behavior for section handlers
- add `p.logAction` calls to early exit points within each
applicable section handler to make troubleshooting unexpected
results involving empty input easier
REFERENCES
- refs GH-264
- refs GH-271
Log early exit behavior for section handlers
Add `p.logAction` calls to early exit points within each
applicable section handler to make troubleshooting unexpected
results involving empty input easier.
refs GH-271
atc0005
force-pushed
the
i271-add-support-for-debug-logging-output
branch
from
2cf8726
to
29aab3f
Compare
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.
Overview
The changes provided by this commit were initially intended to provide a minimal abstraction to support toggling the size of plugin output off/on as needed for troubleshooting. From there the scope widened as further iteration showed that it could be useful to add debug logging support (internally for now) to the library as a whole.
To support toggling on/off specific debug log activity, debug log output is currently split into two categories:
The intent of these changes is to provide a way to easily toggle on/off the internal workings of this library. If client code does not enable debug logging, the result should be this library working just as it did before.
The current implementation is subject to change as real world testing is applied and feedback collected.
Changes
p.logActioncalls to early exit points within each applicable section handler to make troubleshooting unexpected results involving empty input easier.References