Skip to content

Conversation

@sarahkianfar
Copy link

As part of the actionable errors initiative, I have modified the error message to be more descriptive and included a link to documentation. This is based on our recommended guidelines in the design process: https://docs.google.com/document/d/19z0AMtEqsG_d44sEVgNST0JN7NBWBHWjBAmWVA8yR38/edit#bookmark=id.rsxve02tqdl4

I have also changed the error reason to resource availability according to this guide: https://cloud.google.com/compute/docs/troubleshooting/troubleshooting-resource-availability#resolve_resource_errors

These changes have been approved by Bryan Z. and Julie S., PM and IX lead of actionable errors. Please update the example on the AIP-193 website accordingly.

As part of the actionable errors initiative, I have modified the error message to be more descriptive and included a link to documentation. This is based on our recommended guidelines in the design process: https://docs.google.com/document/d/19z0AMtEqsG_d44sEVgNST0JN7NBWBHWjBAmWVA8yR38/edit#bookmark=id.rsxve02tqdl4

I have also changed the error reason to resource availability according to this guide: https://cloud.google.com/compute/docs/troubleshooting/troubleshooting-resource-availability#resolve_resource_errors

These changes have been approved by Bryan Z. and Julie S., PM and IX lead of actionable errors. Please update the example on the AIP-193 website accordingly.
@sarahkianfar sarahkianfar requested a review from a team as a code owner October 23, 2023 20:47
@sarahkianfar
Copy link
Author

I understand there were some formatting issues, sorry about that.
Here is the reformatted JSON and hopefully it should be valid: https://paste.googleplex.com/6318147803021312
Let me know if I need to edit the PR or create a new one. It's the first time I am doing this and I am not a SWE so new to this whole process. Appreciate your patience/

{
"@type": "type.googleapis.com/google.rpc.ErrorInfo",
"reason": "STOCKOUT",
"reason": "resource_availability",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be in all-caps?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point. I think it should be yes.

"@type": "type.googleapis.com/google.rpc.LocalizedMessage",
"locale": "en-US",
"message": "A e2-medium with local-ssd=3,nvidia-t4=2 is currently unavailable in the us-east1-a zone.\nCapacity changes frequently, so try your request in a different zone, with a different VM hardware configuration, or at a later time. For more information, see troubleshooting documentation."
"message": An <e2-medium> VM instance with <local-ssd=3,nvidia-t4=2> is currently unavailable in the <us-east1-a> zone.\n
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this field cannot contain line breaks, as it breaks json formatting. Please keep the content on a single line and use just escaped line breaks, '\n', instead.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, thank you.

I fixed the formatting issues. let me know if there is anything else
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants