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

[error-tracking] add Suspected Cause documentation #26909

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion content/en/error_tracking/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,30 @@

{{< img src="/error_tracking/create-monitor.mp4" alt="Export your search query to an Error Tracking monitor" video=true >}}

## Suspected Cause

Check warning on line 65 in content/en/error_tracking/explorer.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.headings

'Suspected Cause' should use sentence-style capitalization.

Suspected Cause assigns a label to issues at creation time, representing the first hypothesis a developer may have regarding the root cause of an error. This preliminary classification helps teams streamline their troubleshooting efforts and enhances their understanding of recurring problems.

The Suspected Cause can be one of the following categories:

- **Network**: A server took long to respond or the network was slow.
- **Failed Request**: An API endpoint responded with an error status code.
- **Code Exception**: An error was caused by a flaw in your code.
- **Illegal Object Access**: Your code accessed an object which was null or undefined.
- **Invalid Argument**: A function was called with an invalid argument.

Suspected Causes can be used as filters in search, enabling you to easily locate relevant issues.

Check warning on line 77 in content/en/error_tracking/explorer.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.words

Use '' instead of 'easily'.
{{< img src="/error_tracking/suspected-cause-filter.png" alt="Filter your search by Suspected Cause" >}}

Suspected Cause enables quicker filtering and prioritization of errors, empowering teams to address potential root causes more effectively.

### Overriding suspected causes

Suspected Causes can be manually edited if they are deemed incorrect, allowing for continuous improvement of the labeling process.

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: /events
[2]: /monitors/types/event/
[2]: /monitors/types/event/
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading