Add diagnostic command for debugging issues #463
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
mjcheetham
requested review from
jeffhostetler,
ldennington,
vdye and
derrickstolee
derrickstolee
approved these changes
Sep 22, 2021
Add the ability to read the current OS version string.
Add a diagnostic command `diagnose` that can run various tests to verify the operation of various components of GCM. Log files can be written to an output directory.
mjcheetham
force-pushed
the
diagnose
branch
from
3d93b11 to
837824e
Compare
derrickstolee
approved these changes
Sep 23, 2021
Merged
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.
Introduce a new command
diagnosethat can be run to execute various diagnostic tests. Tests exercise various parts of the product and dump out verbose environment/system information.This can be useful for debugging problems in the wild by allowing an easy way to narrow down crashing bugs, and to gather important environment information.
In addition, this diagnostic work is extensible so that host providers can create their own diagnostics to test their host-specific components and logic.
Sample output:
$ git-credential-manager-core diagnose Running diagnostics... [ OK ] Environment [ OK ] File system [ OK ] Networking [ OK ] Git [ OK ] Credential storage [ OK ] Microsoft authentication (AAD/MSA) [ OK ] GitHub API Diagnostic summary: 7 passed, 0 skipped, 0 failed. Log files: /Users/$USER/myrepo/gcm-diagnose.log Caution: Log files may include sensitive information - redact before sharing.