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

Add exhaustive list of error codes and description of metric flag #4422

Open
wants to merge 1 commit into
base: v1.15
Choose a base branch
from

Conversation

jake-engelberg
Copy link

@jake-engelberg jake-engelberg commented Nov 6, 2024

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

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

@@ -70,6 +70,22 @@ spec:
enabled: false
```

## Configuring metrics for error codes

You can enable additional metrics for [Dapr API error codes](https://github.com/dapr/dapr/blob/master/docs/reference/api/error_codes/) by setting `spec.metrics.recordErrorCodes` to `true`. See the specific metrics described in the [Dapr development docs](https://github.com/dapr/dapr/blob/master/docs/development/dapr-metrics.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this section should answer:

  • why do I want to enable this?
  • what happens when I enable this?

Also, mention metrics are collected and maybe add some metric examples

Copy link

Stale PR, paging all reviewers

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.

3 participants