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 8 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: 14 additions & 9 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2036,36 +2036,41 @@ menu:
parent: error_tracking
identifier: error_tracking_states
weight: 2
- name: Suspected Causes
url: error_tracking/suspected_causes
parent: error_tracking
identifier: error_tracking_suspected_causes
weight: 3
- name: Regression Detection
url: error_tracking/regression_detection
parent: error_tracking
identifier: error_tracking_regression_detection
weight: 3
weight: 4
- name: Default Grouping
url: error_tracking/default_grouping
parent: error_tracking
identifier: error_tracking_default_grouping
weight: 4
weight: 5
- name: Monitors
url: error_tracking/monitors
parent: error_tracking
identifier: error_tracking_monitors
weight: 5
weight: 6
- name: Custom Grouping
url: error_tracking/custom_grouping
parent: error_tracking
identifier: error_tracking_custom_grouping
weight: 6
weight: 7
- name: Identify Suspect Commits
url: error_tracking/suspect_commits
parent: error_tracking
identifier: error_tracking_suspect_commits
weight: 7
weight: 8
- name: Track Browser and Mobile Errors
url: error_tracking/frontend
parent: error_tracking
identifier: error_tracking_frontend
weight: 8
weight: 9
- name: Browser Error Tracking
url: error_tracking/frontend/browser
parent: error_tracking_frontend
Expand Down Expand Up @@ -2095,7 +2100,7 @@ menu:
url: error_tracking/backend
parent: error_tracking
identifier: error_tracking_backend
weight: 9
weight: 10
- name: Exception Replay
url: error_tracking/backend/exception_replay
parent: error_tracking_backend
Expand All @@ -2105,12 +2110,12 @@ menu:
url: error_tracking/apm
parent: error_tracking_backend
identifier: error_tracking_apm
weight: 102
weight: 103
- name: Logs
url: error_tracking/backend/logs
parent: error_tracking_backend
identifier: error_tracking_be_logs
weight: 103
weight: 104
- name: Manage Data Collection
url: error_tracking/manage_data_collection
parent: error_tracking
Expand Down
4 changes: 2 additions & 2 deletions content/en/error_tracking/backend/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Datadog's standalone backend Error Tracking is in Preview. If you're interested

{{< img src="real_user_monitoring/error_tracking/rum-et-explorer.png" alt="The details of an issue in the Error Tracking Explorer" style="width:100%;" >}}

It is critical for your systems health to consistently monitor the errors that Datadog collects. When there are many individual error events, it becomes hard to prioritize errors for troubleshooting.
It is critical for your system's health to consistently monitor the errors that Datadog collects. When there are many individual error events, it becomes hard to prioritize errors for troubleshooting.

Error Tracking simplifies debugging by grouping thousands of similar errors into a single issue. Error Tracking enables you to:

- Track, triage, and debug fatal errors
- Group similar errors into issues, so that you can more easily identify important errors and reduce noise
- Group similar errors into issues, so that you can identify important errors and reduce noise
- Set monitors on error tracking events, such as high error volume or new issues
- Follow issues over time to know when they first started, if they are still ongoing, and how often they occur
- Automatically capture local variable values so you can reproduce exceptions, simplifying the process to resolve errors quickly
Expand Down
7 changes: 6 additions & 1 deletion content/en/error_tracking/explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,14 @@ Each event generated is tagged with the version, the service, and the environmen

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

## Suspected Cause

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

## Further Reading

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

[1]: /events
[2]: /monitors/types/event/
[2]: /monitors/types/event/
[3]: /error_tracking/suspected_cause
37 changes: 37 additions & 0 deletions content/en/error_tracking/suspected_causes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Suspected Causes
description: Learn about suspected causes in backend Error Tracking.
further_reading:
- link: '/error_tracking/monitors'
tag: 'Documentation'
text: 'Learn about Error Tracking Monitors'

---

## Overview

Datadog assigns a suspected cause label to issues at creation time. The suspected cause label represents the first hypothesis a developer may have about the root cause of an error. This initial classification helps teams streamline their troubleshooting efforts and enhance their understanding of recurring problems.

The suspected cause can be one of the following categories:

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

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

{{< img src="/error_tracking/suspected-cause.png" alt="Filter your search by the suspected cause." >}}

### Updating suspected cause labels

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

To update the suspected cause, click the label and select a different one.

{{< img src="/error_tracking/suspected-cause-labels.png" alt="Update the suspected cause label." >}}

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading