-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[error-tracking] Add excluding an issue section #30872
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
base: master
Are you sure you want to change the base?
Conversation
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
Preview links (active after the
|
03a8429
to
d6dc403
Compare
d6dc403
to
8c0f7b7
Compare
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.
Approved but we need to change the image to one from the demo org
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.
Hi there, I added some edit suggestions. Let me know if you have any questions!
Co-authored-by: Ida Adjivon <[email protected]>
Co-authored-by: Ida Adjivon <[email protected]>
Co-authored-by: Ida Adjivon <[email protected]>
|
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.
My suggestions are mostly around clarity. I personally found the various arrows hard to follow in issue-states-diagram.png
because it's not clear how or why a status can go from one to the other.
|
||
## Excluding an issue | ||
|
||
The `EXCLUDED` status, allows you to prevent specific errors from being tracked, ensuring they are not collected or counted toward billing. This helps you remove non-actionable errors or expected failures issues without needing complex exclusion rules. |
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.
The `EXCLUDED` status, allows you to prevent specific errors from being tracked, ensuring they are not collected or counted toward billing. This helps you remove non-actionable errors or expected failures issues without needing complex exclusion rules. | |
The `EXCLUDED` status lets you prevent specific errors from being tracked, ensuring they are not collected or counted toward billing. This helps you remove non-actionable errors or issues caused by expected failures without needing complex exclusion rules. |
|
||
The `EXCLUDED` status, allows you to prevent specific errors from being tracked, ensuring they are not collected or counted toward billing. This helps you remove non-actionable errors or expected failures issues without needing complex exclusion rules. | ||
|
||
To manually exclude an issue, click the issue status and choose **EXCLUDED** in the dropdown menu. Excluded issues remain accessible in the **IGNORED** tab, and you can review their history at any time. |
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.
To manually exclude an issue, click the issue status and choose **EXCLUDED** in the dropdown menu. Excluded issues remain accessible in the **IGNORED** tab, and you can review their history at any time. | |
To exclude an issue, click its status and choose **EXCLUDED** in the dropdown menu. Excluded issues are still accessible in the **IGNORED** tab. You can review their history at any time. |
|
||
{{< img src="error_tracking/issue-states-excluded.png" alt="Excluded in issue status dropdown" style="width:100%;" >}} | ||
|
||
To restart the error collection of an excluded issue, choose a status other than **EXCLUDED**. |
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.
To restart the error collection of an excluded issue, choose a status other than **EXCLUDED**. | |
To resume collecting errors for an excluded issue, select any status other than **EXCLUDED**. |
@@ -8,12 +8,13 @@ further_reading: | |||
|
|||
## Overview | |||
|
|||
All issues in Error Tracking have a status to help you triage and prioritize issues or dismiss noise. There are four statuses: | |||
All issues in Error Tracking have a status to help you triage and prioritize issues or dismiss noise. There are five statuses: | |||
|
|||
- **FOR REVIEW**: Ongoing and in need of attention because the issue is new or it's a regression. |
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.
- **FOR REVIEW**: Ongoing and in need of attention because the issue is new or it's a regression. | |
- **FOR REVIEW**: New or regressed issues that need attention. |
@@ -8,12 +8,13 @@ further_reading: | |||
|
|||
## Overview | |||
|
|||
All issues in Error Tracking have a status to help you triage and prioritize issues or dismiss noise. There are four statuses: | |||
All issues in Error Tracking have a status to help you triage and prioritize issues or dismiss noise. There are five statuses: | |||
|
|||
- **FOR REVIEW**: Ongoing and in need of attention because the issue is new or it's a regression. | |||
- **REVIEWED**: Triaged and needs to be fixed, either now or later. |
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.
- **REVIEWED**: Triaged and needs to be fixed, either now or later. | |
- **REVIEWED**: Triaged issues that need to be fixed, now or later. |
|
||
- **FOR REVIEW**: Ongoing and in need of attention because the issue is new or it's a regression. | ||
- **REVIEWED**: Triaged and needs to be fixed, either now or later. | ||
- **IGNORED**: Requiring no additional investigation or action. | ||
- **RESOLVED**: Fixed and no longer occurring. |
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.
- **RESOLVED**: Fixed and no longer occurring. | |
- **RESOLVED**: Issues that have been fixed and are no longer occurring. |
- **RESOLVED**: Fixed and no longer occurring. | ||
- **IGNORED**: Requiring no additional investigation or action. |
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.
- **IGNORED**: Requiring no additional investigation or action. | |
- **IGNORED**: Issues that require no further investigation or action. |
- **RESOLVED**: Fixed and no longer occurring. | ||
- **IGNORED**: Requiring no additional investigation or action. | ||
- **EXCLUDED**: Requiring no additional investigation or action, stops collecting new errors, and no longer count towards usage or billing |
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.
- **EXCLUDED**: Requiring no additional investigation or action, stops collecting new errors, and no longer count towards usage or billing | |
- **EXCLUDED**: Issues that require no further investigation, stops collecting new errors, and no longer count towards usage or billing |
What does this PR do? What is the motivation?
TODO:
Merge instructions
🔴 DON'T MERGE
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>
convention and include the forward slash (/
). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes