Skip to content

Conversation

shiyueZ6
Copy link

@shiyueZ6 shiyueZ6 commented Aug 4, 2025

What does this PR do? What is the motivation?

  • This PR adds a section to error tracking issues states page, explaining what a excluded issue state means and how can you exclude and undo a exclude change.
  • updating the screenshot

TODO:

  • update issue state diagram. (non blocking, we can release the text update first and update with the diagram when it is ready.)

Merge instructions

🔴 DON'T MERGE

Merge readiness:

  • Ready for merge

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

@github-actions github-actions bot added the Images Images are added/removed with this PR label Aug 4, 2025
Copy link
Contributor

github-actions bot commented Aug 4, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

Copy link
Contributor

github-actions bot commented Aug 4, 2025

Preview links (active after the build_preview check completes)

Modified Files

@shiyueZ6 shiyueZ6 force-pushed the shiyue.zhang/error-tracking-exclude-issue branch from 03a8429 to d6dc403 Compare August 4, 2025 08:38
@shiyueZ6 shiyueZ6 force-pushed the shiyue.zhang/error-tracking-exclude-issue branch from d6dc403 to 8c0f7b7 Compare August 4, 2025 08:44
@shiyueZ6 shiyueZ6 marked this pull request as ready for review August 4, 2025 09:49
@shiyueZ6 shiyueZ6 requested a review from a team as a code owner August 4, 2025 09:49
@shiyueZ6 shiyueZ6 added the Do Not Merge Just do not merge this PR :) label Aug 4, 2025
@shiyueZ6 shiyueZ6 requested a review from meghanlo August 4, 2025 11:13
Copy link
Contributor

@meghanlo meghanlo left a 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

Copy link
Contributor

@iadjivon iadjivon left a 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!

@shiyueZ6
Copy link
Author

Approved but we need to change the image to one from the demo org
hey @meghanlo ! the images are from demo org, do we need one of a specific issue?

@shiyueZ6 shiyueZ6 requested a review from iadjivon August 18, 2025 08:09
Copy link
Contributor

@rtrieu rtrieu left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Do Not Merge Just do not merge this PR :) Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants