-
Notifications
You must be signed in to change notification settings - Fork 726
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
Error codes #3908
Error codes #3908
Conversation
Signed-off-by: Elena Kolevska <[email protected]>
Signed-off-by: Elena Kolevska <[email protected]>
@msfussell pls let me know if this structure looks ok; I'm not sure if we want a new menu item for errors, but I couldn't see it anywhere else. |
Stale PR, paging all reviewers |
Stale PR, paging all reviewers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
quick initial grammar review
Co-authored-by: Hannah Hunter <[email protected]> Signed-off-by: Elena Kolevska <[email protected]>
Thanks for the review @hhunter-ms . All done! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments on what you have here so far. Primarily we should refer to these as enhanced error message rather than richer.
However there are two additional things that we need to add
- Any guidance on using (consuming) these errors. This may be language specific and therefore hard, but would be good if possible
- Guidance on generating these. There should at least be some guidance with a couple of examples of when to use which field in the case of Dapr errors. You have given one example, but can we have at least 2 more to learn from?
description: "Information on Dapr errors and how to handle them" | ||
--- | ||
|
||
# Dapr Error Handling: Understanding the Error Models |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Dapr Error Handling: Understanding the Error Models | |
# Error handling: Understanding errors model and reporting |
} | ||
``` | ||
|
||
You can find the specification of all the possible status details [here](https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be moved to after the first paragraph in the enhanced error section above, since this is what people will use to create/understand errors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So switch the order of the grpc and json examples, right? They're the same thing, it's just that we're showing the json representation (used in http connections) and the proto structure for gRPC connections.
Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Elena Kolevska <[email protected]>
Re: the suggestion to use the term "enhanced" instead of "richer" error model. |
|
Signed-off-by: Elena Kolevska <[email protected]>
Signed-off-by: Elena Kolevska <[email protected]>
Signed-off-by: Elena Kolevska <[email protected]>
@elena-kolevska - This looks good. I would just add at the end of the doc these references Related Links |
Signed-off-by: Elena Kolevska <[email protected]>
Thank @msfussell. Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!!
Description
This PR adds a page that explains the usage structure of the richer errors model in Dapr.
Issue reference
#3907
Please follow this checklist before submitting:
N/A:
In addition, please fill out the following to help reviewers understand this pull request: