ratify icon indicating copy to clipboard operation
ratify copied to clipboard

The brief error message is too short

Open yizha1 opened this issue 1 year ago • 5 comments

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 avatar May 07 '24 10:05 yizha1

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

binbin-li avatar May 20 '24 03:05 binbin-li

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?

fseldow avatar May 20 '24 07:05 fseldow

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.

binbin-li avatar May 21 '24 00:05 binbin-li

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

susanshi avatar Jun 19 '24 23:06 susanshi

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

susanshi avatar Jun 25 '24 00:06 susanshi