Skip to content

Commit 5aeedd5

Browse files
jfreealbertvakajoepeeples
authored
Add page for Error Tracking in the Datadog plugin (#34344)
* First draft of new page for Error Tracking in JetBrains IDE * Revisions * Apply suggestions from code review Co-authored-by: Albert Vaca Cintora <albert.vaca@datadoghq.com> * Use repository not repo * Text revisions and updated screenshots * Update editor filtering description * Update reference to Error Tracking on the parent page, and refresh images. * Update Live Debugger tool window tab screenshot * Apply suggestions from code review Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com> * Revert "Update Live Debugger tool window tab screenshot" This reverts commit b1b7f2e. * Use v2 in name of updated screenshot, as per PR feedback --------- Co-authored-by: Albert Vaca Cintora <albert.vaca@datadoghq.com> Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com>
1 parent 80cb3ed commit 5aeedd5

File tree

9 files changed

+84
-10
lines changed

9 files changed

+84
-10
lines changed

config/_default/menus/main.en.yaml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1070,21 +1070,26 @@ menu:
10701070
parent: ide_plugins
10711071
identifier: ide_plugins_idea
10721072
weight: 701
1073+
- name: Error Tracking
1074+
url: developers/ide_plugins/idea/error_tracking/
1075+
parent: ide_plugins_idea
1076+
identifier: ide_plugins_idea_error_tracking
1077+
weight: 7011
10731078
- name: Logs
10741079
url: developers/ide_plugins/idea/logs/
10751080
parent: ide_plugins_idea
10761081
identifier: ide_plugins_idea_logs
1077-
weight: 7011
1082+
weight: 7012
10781083
- name: Live Debugger
10791084
url: developers/ide_plugins/idea/live_debugger/
10801085
parent: ide_plugins_idea
10811086
identifier: ide_plugins_idea_debugger
1082-
weight: 7012
1087+
weight: 7013
10831088
- name: Code Security
10841089
url: developers/ide_plugins/idea/code_security/
10851090
parent: ide_plugins_idea
10861091
identifier: ide_plugins_idea_code_security
1087-
weight: 7013
1092+
weight: 7014
10881093
- name: VS Code & Cursor
10891094
url: developers/ide_plugins/vscode/
10901095
parent: ide_plugins

content/en/developers/ide_plugins/idea/_index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ further_reading:
3131

3232
## Overview
3333

34-
The Datadog plugin for JetBrains IDEs helps improve software performance by providing code insights in the IDE based on real-time observability data. The plugin is for developers that use Datadog products including [Error Tracking][6], [Logs][23], [Live Debugger][21] and [Code Security][24] to monitor their services. It is available for IntelliJ IDEA, GoLand, PyCharm, WebStorm, and PhpStorm.
34+
The Datadog plugin for JetBrains IDEs helps improve software performance by providing code insights in the IDE based on real-time observability data. The plugin is for developers that use Datadog products including [Error Tracking][25], [Logs][23], [Live Debugger][20] and [Code Security][24] to monitor their services. It is available for IntelliJ IDEA, GoLand, PyCharm, WebStorm, and PhpStorm.
3535

3636
{{< img src="/developers/ide_plugins/idea/overview1.png" alt="The Datadog tool window open in IDEA" style="width:100%;" >}}
3737

@@ -74,11 +74,11 @@ To remove a service, select it in the **Services** table and click the minus ico
7474
## Core features
7575

7676
### Error Tracking
77-
The [**Error Tracking**][6] integration helps you find and fix runtime errors from Error Tracking.
77+
The [**Error Tracking**][25] integration helps you find and fix runtime errors from Error Tracking.
7878

79-
{{< img src="/developers/ide_plugins/idea/error-tracking-in-editor.png" alt="Error tracking in the source editor" style="width:100%;" >}}
79+
{{< img src="/developers/ide_plugins/idea/error_tracking/editor.png" alt="Error tracking in the source editor" style="width:100%;" >}}
8080

81-
Click the inlay to open the Datadog tool-window and inspect details of the runtime error.
81+
Click the gutter icon to open the Datadog tool window and inspect details of the runtime error.
8282

8383
### Logs
8484

@@ -92,7 +92,7 @@ Find out more in the [Logs][23] sub-section.
9292

9393
The [**Live Debugger**][20] enables you to add logpoints—auto-expiring, non-breaking breakpoints—to your runtime code to collect information for debugging.
9494

95-
{{< img src="/developers/ide_plugins/idea/live_debugger/tool-window-tab.png" alt="The Live Debugger tab" style="width:100%;" >}}
95+
{{< img src="/developers/ide_plugins/idea/live_debugger/tool-window-tab-v2.png" alt="The Live Debugger tab" style="width:100%;" >}}
9696

9797
Find out more in the [Live Debugger][20] sub-section.
9898

@@ -175,4 +175,5 @@ You can give feedback in the [discussion forum][1], or send an e-mail to [team-i
175175
[21]: /tracing/live_debugger/
176176
[22]: /tracing/code_origin?tab=java
177177
[23]: /developers/ide_plugins/idea/logs/
178-
[24]: /developers/ide_plugins/idea/code_security/
178+
[24]: /developers/ide_plugins/idea/code_security/
179+
[25]: /developers/ide_plugins/idea/error_tracking/
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Error Tracking
3+
type: documentation
4+
further_reading:
5+
- link: "/tracing/error_tracking/"
6+
tag: "Documentation"
7+
text: "Learn more about Error Tracking"
8+
---
9+
10+
## Overview
11+
The [Error Tracking][1] integration in the Datadog plugin for JetBrains IDEs helps you find and fix runtime errors from production, without leaving your IDE.
12+
13+
## Source editor
14+
Errors are highlighted in the source editor with a distinctive icon in the gutter, for lines that appear in error stack frames (lines of code on the execution path that led to an observed runtime error). Click the icon to select an error and display it in the Datadog tool window.
15+
16+
{{< img src="/developers/ide_plugins/idea/error_tracking/editor.png" alt="Error Tracking in the source editor" style="width:100%;" >}}
17+
18+
Errors shown in the editor are filtered by controls on the Error Tracking tab, described in the next section.
19+
20+
## Error Tracking tab
21+
Use the Error Tracking tab in the tool window to filter, sort and inspect errors, view stack traces, navigate to relevant locations in your source code, attempt fixes with your local agent, or navigate to Datadog to continue your investigations.
22+
23+
{{< img src="/developers/ide_plugins/idea/error_tracking/toolwindow.png" alt="The Error Tracking tool window" style="width:100%;" >}}
24+
25+
Additional information shown in this view includes the count, service, first-seen and last-seen timestamps.
26+
27+
### Sorting and filtering
28+
Set filters to show errors that are relevant to you:
29+
30+
* **Issue type** - The source of issues (backend, browser, or mobile)
31+
* **Team** - Issues for selected teams
32+
* **Assignee** - Issues assigned to selected users
33+
* **Status** - Issues for selected statuses, from `For Review`, `Reviewed`, `Resolved`, `Ignored`, `Excluded`
34+
* **Repository** - Issues linked to the repository for the current project
35+
* **Service** - Issues for selected services
36+
* **Environment** - Issues for selected environments
37+
* **Time frame** - Issues that fall within the selected time frame (the last-seen timestamp is on or after the start of the time frame)
38+
39+
Errors can be sorted by:
40+
41+
* **Relevance** (highest to lowest) - A score based on recency, number of occurrences, and other factors
42+
* **Recency** (newest to oldest) - Based on first-seen
43+
* **Count** (highest to lowest) - The number of error occurrences
44+
45+
### Issue list
46+
Errors are displayed in a list on the left-side of the tool window, with the type, service, filename, error count and assignee listed.
47+
48+
{{< img src="/developers/ide_plugins/idea/error_tracking/errorlist.png" alt="Error Tracking list" style="width:60%;" >}}
49+
50+
Select an issue to display its details on the right-side of the tool window.
51+
52+
### Issue details
53+
The issue details pane shows detailed information about the selected error, including the error description, the service, the count, first-seen and last-seen information, and a stack trace.
54+
55+
{{< img src="/developers/ide_plugins/idea/error_tracking/details.png" alt="Error Tracking details" style="width:100%;" >}}
56+
57+
Click the **View in Datadog** link to open the selected issue in Datadog.
58+
59+
Click on a file and line link in the stack trace to navigate to the code.
60+
61+
### Fix With AI
62+
When a local agent is detected (you have the Claude Code, Gemini, or Codex CLI installed locally), a **Fix with Local Agent** button will appear. Click this to open a new terminal and launch the local agent with a custom prompt from Datadog requesting the agent to fix the error.
63+
64+
## Further reading
65+
66+
{{< partial name="whats-next/whats-next.html" >}}
67+
68+
[1]: /tracing/error_tracking/

content/en/developers/ide_plugins/idea/live_debugger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Live Debugger enables you to add logpoints—auto-expiring, non-breaking bre
1616
## Live Debugger tab
1717
The **Live Debugger** tab in the Datadog tool window shows the current session, its logpoints, and the data captured by the selected logpoint:
1818

19-
{{< img src="/developers/ide_plugins/idea/live_debugger/tool-window-tab.png" alt="The Live Debugger tab" style="width:100%;" >}}
19+
{{< img src="/developers/ide_plugins/idea/live_debugger/tool-window-tab-v2.png" alt="The Live Debugger tab" style="width:100%;" >}}
2020

2121
The panel has three sections:
2222

90.1 KB
Loading
104 KB
Loading
68.8 KB
Loading
168 KB
Loading
217 KB
Loading

0 commit comments

Comments
 (0)