-
Notifications
You must be signed in to change notification settings - Fork 84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add --debug option to Notation CLI Sign and Verify commands to help with troubleshooting and logging #300
Comments
Could you give an example of the following items?
|
I've updated the list of log items (not exhaustive), and removed "Parse parameters" and "Formatted output". |
Per discussion on call today, I think this makes sense in RC.1 for just the sign and verify commands. 2nd priority may be the login. |
@iamsamirzon Can you please rescope this item to just sign/verify? |
Modified the issue description to just focus on Sign and Verify commands for RC-1. This limited scope was discussed and agreed in the NV2 meeting on 9/8/2022 |
@yizha1 - Now that we are doing refactoring, could you adjust the scope on this item down from 3 weeks to 0.8 weeks like you shared yesterday? Also, lets only focus on the use cases called out in this issue and not include "HTTP/REQ/RESP/POST" like things |
Some debug outputs are addressed in the following PRs:
More suggestions on Implementation can be kicked off after the spec is updated. @priteshbandi @iamsamirzon @vaninrao10 @gokarnm @FeynmanZhou @toddysm |
--debug for both sign and verify should also emit signature either in plain text(for jws) or and encoded format(for cose). |
update milestone to rc.2 per discussion. |
We need to outline or link to the issues to define 1. what work is remaining in this space for rc-2 and 2. What work is completed in rc-1. |
@vaninrao10 I think the debug log for |
@patrickzheng200 anything left for |
Closing this issue as it's completed in RC.1. |
As a user, I want the Notation Sign and Verify commands to generate additional info why a given CLI command is failing and/or to create logs of the actions being performed by a command.
When the Notation CLI reports an error that a user can get more detail about the error by running the command again with the --debug option. With this option, the Notation CLI outputs details about every step it takes. The details in the output can help a user to determine when the error occurs and provides clues about where it started. A user should be able to output to a text file for later review, or to post it as part of bug report.
When you include the --debug option, some of the details included in the logs could be.
General
Signing workflow
Verification workflow
--debug for both sign and verify should also emit signature either in plain text(for jws) or and encoded format(for cose).
The text was updated successfully, but these errors were encountered: