Skip to content
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

The brief error message is too short #1453

Closed
1 task
yizha1 opened this issue May 7, 2024 · 5 comments · Fixed by #1734
Closed
1 task

The brief error message is too short #1453

yizha1 opened this issue May 7, 2024 · 5 comments · Fixed by #1734
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@yizha1
Copy link
Collaborator

yizha1 commented May 7, 2024

What would you like to be added?

The brief error message is too short, which is about 30 characters. It should be extended to more characters, for instance 150 characters.

An example of current brief error message

brieferror: failed to get key objectName:t...
error: 'failed to get key objectName:test-cosign, objectVersion:849bc642cb674e0aa4cc5573e692209a,
  error: keyvault.BaseClient#GetKey: Failure responding to request: StatusCode=404
  -- Original Error: autorest/azure: Service returned an error. Status=404 Code="KeyNotFound"
  Message="A key with (name/id) test-cosign/849bc642cb674e0aa4cc5573e692209a was
  not found in this key vault. If you recently deleted this key you may be able
  to recover it using the correct recovery command. For help resolving this issue,
  please see https://go.microsoft.com/fwlink/?linkid=2125182"'

Anything else you would like to add?

No response

Are you willing to submit PRs to contribute to this feature?

  • Yes, I am willing to implement it.
@yizha1 yizha1 added enhancement New feature or request triage Needs investigation labels May 7, 2024
@binbin-li
Copy link
Collaborator

@fseldow wonder if extending the brief error message would impact your user scenario?

@fseldow
Copy link
Contributor

fseldow commented May 20, 2024

i have not applied breif error for now, since image integrity on AKS side is still v1.0.
Is breif error in verifierReport? or keyCertificateManagement status?

@binbin-li
Copy link
Collaborator

i have not applied breif error for now, since image integrity on AKS side is still v1.0. Is breif error in verifierReport? or keyCertificateManagement status?

thanks for confirming! It only applies to CR status, not in verifierReport.

@susanshi susanshi added this to the v1.3.0 milestone Jun 19, 2024
@susanshi
Copy link
Collaborator

Hi @binbin-li , can you confirm this will address as apart of error message improvements in 1.3?

@susanshi susanshi removed the triage Needs investigation label Jun 19, 2024
@susanshi
Copy link
Collaborator

discussion from PR reviewing meeting: Ideally Breif error should contains only the error code, or a concise error message.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants