Add exhaustive list of error codes and description of metric flag#4422
Conversation
Signed-off-by: Jake Engelberg <jake@diagrid.io>
|
Stale PR, paging all reviewers |
|
Stale PR, paging all reviewers |
|
Stale PR, paging all reviewers |
Signed-off-by: Jake Engelberg <jake@diagrid.io>
hhunter-ms
left a comment
hhunter-ms
left a comment
There was a problem hiding this comment.
quick review - thank you!
Signed-off-by: Jake Engelberg <jake@diagrid.io>
jake-engelberg
force-pushed
the
add-errorcode-metrics
branch
from
ab17803 to
a44a96a
Compare
|
Stale PR, paging all reviewers |
|
@jake-engelberg - I realize that we need to make error codes concept much more visible to developers by adding a topic under https://docs.dapr.io/developing-applications/building-blocks/ called "API Error codes" describing what they are and also how you can get metrics for them (This can point to the error codes list and the metrics configuration) Also in this article we should mention that each SDK can handle and return the error code in the language specific way. For example this is Go https://docs.dapr.io/developing-applications/sdks/go/go-client/#error-handling but we also need to discuss with each of the SDK maintainers how to handle these. I suggest raising an issue into each of SDK repos for this to track this (if my understanding is correct) @hhunter-ms can help as needed. Hannah - This reference article https://docs.dapr.io/reference/api/error_codes/ should be called "API Error codes" in the index file. I did not realize this was buried under Dapr API reference. |
| @@ -7,43 +7,150 @@ weight: 1400 | |||
| --- | |||
|
|
|||
| For http calls made to Dapr runtime, when an error is encountered, an error json is returned in http response body. The json contains an error code and an descriptive error message, e.g. | |||
There was a problem hiding this comment.
Yes, it is both and we'll update the wording soon to reflect the auto generated chart with both codes which at the moment sometimes differ:
| spec: | ||
| metrics: | ||
| enabled: true | ||
| recordErrorCodes: true |
There was a problem hiding this comment.
You also need to;
- update this table in configuration setting https://docs.dapr.io/operations/configuration/configuration-overview/#metrics And in that table point to this article for the details.
- Update the configuration schema to add this under metrics section here https://docs.dapr.io/reference/resource-specs/configuration-schema/
There was a problem hiding this comment.
@hhunter-ms - Will do this. Do Jake you can ignore this comment.
Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Jake Engelberg <152900222+jake-engelberg@users.noreply.github.com>
|
@holopin-bot @jake-engelberg Thanks Jake! |
|
Congratulations @jake-engelberg, the maintainer of this repository has issued you a badge! Here it is: https://holopin.io/claim/cm5qxvv6811300cmj4flegr8q This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account. |
6 participants
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Added the exhaustive set of error codes dapr emits as well as how to enable metric recording for these error codes based on the associated PR below which implements this.
Issue reference
dapr/dapr#8256