From b2c1ae7920fbf17294a7ca93eae5708df2f374d0 Mon Sep 17 00:00:00 2001 From: Roberto Huertas Date: Tue, 2 Jun 2026 12:59:37 +0200 Subject: [PATCH] docs(ide-plugins/vscode): reorganize VS Code extension docs to lead with Code Security - Moved Code Security to the top of the feature list and Core features section in `_index.md` - Restructured page into Core features (Code Security, Code Insights, View in IDE, Fix in Chat) and Other features (Logs, Exception Replay, Live Debugger) - Added "in limited support" alerts to Logs, Exception Replay, and Live Debugger in `_index.md` and their respective subpages - Updated Code Insights description to focus on code and library vulnerabilities as the primary use case - Moved runtime errors and flaky tests to a new "Other insight types" subsection in `code_insights.md` with a limited support note - Reordered VS Code submenu in `main.en.yaml`: Code Security (101), Code Insights (102), Logs (103), Exception Replay (104), Live Debugger (105) K9VULN-15558 --- config/_default/menus/main.en.yaml | 12 +-- content/en/ide_plugins/vscode/_index.md | 96 ++++++++++--------- .../en/ide_plugins/vscode/code_insights.md | 21 ++-- .../en/ide_plugins/vscode/exception_replay.md | 2 + .../en/ide_plugins/vscode/live_debugger.md | 2 + content/en/ide_plugins/vscode/logs.md | 2 + 6 files changed, 75 insertions(+), 60 deletions(-) diff --git a/config/_default/menus/main.en.yaml b/config/_default/menus/main.en.yaml index 77e50b15c2a..8bdb208a79b 100644 --- a/config/_default/menus/main.en.yaml +++ b/config/_default/menus/main.en.yaml @@ -6312,20 +6312,20 @@ menu: parent: ide_plugins identifier: ide_plugins_vscode weight: 2 - - name: Logs - url: ide_plugins/vscode/logs/ + - name: Code Security + url: ide_plugins/vscode/code_security/ parent: ide_plugins_vscode - identifier: ide_plugins_vscode_logs + identifier: ide_plugins_vscode_code_security weight: 101 - name: Code Insights url: ide_plugins/vscode/code_insights/ parent: ide_plugins_vscode identifier: ide_plugins_vscode_code_insights weight: 102 - - name: Code Security - url: ide_plugins/vscode/code_security/ + - name: Logs + url: ide_plugins/vscode/logs/ parent: ide_plugins_vscode - identifier: ide_plugins_vscode_code_security + identifier: ide_plugins_vscode_logs weight: 103 - name: Exception Replay url: ide_plugins/vscode/exception_replay/ diff --git a/content/en/ide_plugins/vscode/_index.md b/content/en/ide_plugins/vscode/_index.md index 2eeac1000b7..40c5fa4aedf 100644 --- a/content/en/ide_plugins/vscode/_index.md +++ b/content/en/ide_plugins/vscode/_index.md @@ -29,6 +29,7 @@ further_reading: {{% site-region region="gov,gov2" %}} +
The Datadog extension for Visual Studio Code is not supported for your selected Datadog site ({{< region-param key="dd_site_name" >}}).
@@ -42,32 +43,31 @@ The Datadog extension for VS Code and Cursor brings Datadog to your code editor The extension includes these features: -- [**Model Context Protocol (MCP) Server**](?tab=cursor#installation): Connect the editor's AI agent to production telemetry, tools, and context from Datadog. +- [**Code Security**](#code-security): Detect and fix security issues before you commit, and write custom rules. -- [**Logs**](#logs): Gauge log volumes and search logs from your code. +- [**Model Context Protocol (MCP) Server**](?tab=cursor#installation): Connect the editor's AI agent to production telemetry, tools, and context from Datadog. -- [**Code Insights**](#code-insights): Stay informed about runtime errors, vulnerabilities, and flaky tests without leaving the code. +- [**Code Insights**](#code-insights): Stay informed about code and library vulnerabilities without leaving the code. -- [**View in IDE**](#view-in-ide): Jump directly from code references in Datadog to your source files. +- [**View in IDE**](#view-in-ide): Jump directly from code references in Datadog to your source files. -- [**Code Security**](#code-security): Detect and fix security issues before you commit, and write custom rules. +- [**Fix in Chat**](?tab=cursor#fix-in-chat): Fix code errors, vulnerabilities, and flaky tests with AI-powered suggestions and explanations. -- [**Exception Replay**](#exception-replay): Debug your production code. +- [**Logs**](#logs): Gauge log volumes and search logs from your code. -- [**Live Debugger**](#live-debugger): Add non-breaking logpoints to running services to capture runtime data without redeploying. +- [**Exception Replay**](#exception-replay): Debug your production code. -- [**Fix in Chat**](?tab=cursor#fix-in-chat): Fix code errors, vulnerabilities, and flaky tests with AI-powered suggestions and explanations. +- [**Live Debugger**](#live-debugger): Add non-breaking logpoints to running services to capture runtime data without redeploying.
Unless stated otherwise, all extension features are available for both VS Code and any other IDEs based on VS Code forks, such as Cursor.
## Requirements -- **Datadog account**: Most features require a Datadog account. - - - New to Datadog? [Learn more][3] about Datadog's monitoring and security tools and sign up for a free trial. - - If your organization uses a [custom sub-domain][18] such as `myorg.datadoghq.com`, you must indicate it using the `datadog.connection.oauth.setup.domain` setting in the IDE. +- **Datadog account**: Most features require a Datadog account. + - New to Datadog? [Learn more][3] about Datadog's monitoring and security tools and sign up for a free trial. + - If your organization uses a [custom sub-domain][18] such as `myorg.datadoghq.com`, you must indicate it using the `datadog.connection.oauth.setup.domain` setting in the IDE. -- **Git**: The extension works better when Git is enabled in the IDE. Ensure this is enabled by checking the `git.enabled` setting. +- **Git**: The extension works better when Git is enabled in the IDE. Ensure this is enabled by checking the `git.enabled` setting. ## Installation @@ -77,9 +77,9 @@ Installation steps may vary for other VS Code-based editors. {{% tab "VS Code" %}} Install the extension either directly in the IDE, or from the web: -- **In VS Code**: Open the Extensions view (`Shift` + `Cmd/Ctrl` + `X`), search for `datadog`, and select the official extension from Datadog. +- **In VS Code**: Open the Extensions view (`Shift` + `Cmd/Ctrl` + `X`), search for `datadog`, and select the official extension from Datadog. -- **From the web**: Install from the extension's page on [Visual Studio Marketplace][1]. +- **From the web**: Install from the extension's page on [Visual Studio Marketplace][1]. ### MCP Server setup @@ -98,9 +98,9 @@ The extension includes access to the [Datadog Model Context Protocol (MCP) Serve {{% tab "Cursor" %}} Install the extension either directly in the IDE, or from the web: -- **In Cursor**: Open the Extensions view (`Shift` + `Cmd/Ctrl` + `X`), search for `datadog`, and select the official extension from Datadog. +- **In Cursor**: Open the Extensions view (`Shift` + `Cmd/Ctrl` + `X`), search for `datadog`, and select the official extension from Datadog. -- **From the web**: Download the VSIX file from [Open VSX Registry][2], and install with `Extensions: Install from VSIX` in the command palette (`Shift` + `Cmd/Ctrl` + `P`). +- **From the web**: Download the VSIX file from [Open VSX Registry][2], and install with `Extensions: Install from VSIX` in the command palette (`Shift` + `Cmd/Ctrl` + `P`). ### Datadog MCP Server setup @@ -115,67 +115,73 @@ Install the Datadog Plugin to enable the [Datadog MCP Server][3]. You can instal ## Core features -### Logs +### Code Security -Use **Logs** to gauge the volume of logs generated by a given log line in your code. The extension adds annotations above your code to detected logging patterns that match log records in Datadog. +The [**Code Security**][19] features analyze your code locally against predefined rules to detect and fix security issues and vulnerabilities before you commit changes. -{{< img src="/ide_plugins/vscode/logs_navigation.mp4" alt="Preview of Logs Navigation" style="width:100%" video=true >}} +{{< img src="/ide_plugins/vscode/static_analysis.mp4" alt="Preview of Static Analysis" style="width:100%" video=true >}} -Find out more in the [Logs][20] sub-section. +Find out more in the [Code Security][19] sub-section. ### Code insights -**Code insights** keep you informed with Datadog-generated insights relevant to your code base, including runtime errors, code vulnerabilities, and flaky tests. +**Code insights** keep you informed with code and library vulnerabilities relevant to your codebase. {{< img src="/ide_plugins/vscode/code-insights-2.png" alt="The Code Insights view." style="width:100%;" >}} Find out more in the [Code Insights][21] sub-section. -### Code Security +### View in IDE -The [**Code Security**][19] features analyze your code locally against predefined rules to detect and fix security issues and vulnerabilities before you commit changes. +
This feature is only available for VS Code and Cursor. Other forks of VS Code are not supported.
-{{< img src="/ide_plugins/vscode/static_analysis.mp4" alt="Preview of Static Analysis" style="width:100%" video=true >}} +The **View in VS Code** or **View in Cursor** feature provides a link from Datadog directly to your source files. Look for the button next to frames in stack traces displayed in the UI (for example, in [Error Tracking][5]): -Find out more in the [Code Security][19] sub-section. +{{< img src="/ide_plugins/vscode/view-in-vscode-2.png" alt="A stack trace in Datadog showing the View in VS Code button" style="width:100%;" >}} -### Exception Replay +You can also use this feature to open your source files from an insight (such as an error from Error Tracking): -**Exception Replay** allows you to inspect the stack trace frames of any Error Tracking code insight and get information about the values of the variables of the code running in production. +{{< img src="/ide_plugins/vscode/view-in-vscode-error.png" alt="An Error Tracking issue in Datadog showing the View in VS Code button" style="width:100%;" >}} -{{< img src="/ide_plugins/vscode/exception_replay.mp4" alt="Preview of Exception Replay" style="width:100%" video=true >}} +
To use this feature, first configure source code integration for your service.
-Find out more in the [Exception Replay][22] sub-section. +### Fix in Chat -### Live Debugger +The **Fix in Chat** button appears in several contexts when the extension identifies errors or issues. Click the button to generate an AI chat prompt that summarizes the problem, includes relevant details and context, and gives specific instructions for the agent. -The **Live Debugger** lets you add logpoints—auto-expiring, non-breaking breakpoints—to your running services to capture runtime data for debugging without redeploying your code. +{{< img src="/ide_plugins/vscode/cursor_fix_in_chat.mp4" alt="Using Fix in Chat to fix an inline code error" style="width:100%" video=true >}} -{{< img src="/ide_plugins/vscode/live_debugger_overview.mp4" alt="Overview of the Datadog Live Debugger activity" style="width:100%" video=true >}} +## Other features -Find out more in the [Live Debugger][23] sub-section. +### Logs -## Other features +
This feature is in limited support.
-### View in IDE +Use **Logs** to gauge the volume of logs generated by a given log line in your code. The extension adds annotations above your code to detected logging patterns that match log records in Datadog. -
This feature is only available for VS Code and Cursor. Other forks of VS Code are not supported.
+{{< img src="/ide_plugins/vscode/logs_navigation.mp4" alt="Preview of Logs Navigation" style="width:100%" video=true >}} -The **View in VS Code** or **View in Cursor** feature provides a link from Datadog directly to your source files. Look for the button next to frames in stack traces displayed in the UI (for example, in [Error Tracking][5]): +Find out more in the [Logs][20] sub-section. -{{< img src="/ide_plugins/vscode/view-in-vscode-2.png" alt="A stack trace in Datadog showing the View in VS Code button" style="width:100%;" >}} +### Exception Replay -You can also use this feature to open your source files from an insight (such as an error from Error Tracking): +
This feature is in limited support.
-{{< img src="/ide_plugins/vscode/view-in-vscode-error.png" alt="An Error Tracking issue in Datadog showing the View in VS Code button" style="width:100%;" >}} +**Exception Replay** allows you to inspect the stack trace frames of any Error Tracking code insight and get information about the values of the variables of the code running in production. -
To use this feature, first configure source code integration for your service.
+{{< img src="/ide_plugins/vscode/exception_replay.mp4" alt="Preview of Exception Replay" style="width:100%" video=true >}} -### Fix in Chat +Find out more in the [Exception Replay][22] sub-section. -The **Fix in Chat** button appears in several contexts when the extension identifies errors or issues. Click the button to generate an AI chat prompt that summarizes the problem, includes relevant details and context, and gives specific instructions for the agent. +### Live Debugger -{{< img src="/ide_plugins/vscode/cursor_fix_in_chat.mp4" alt="Using Fix in Chat to fix an inline code error" style="width:100%" video=true >}} +
This feature is in limited support.
+ +The **Live Debugger** lets you add logpoints—auto-expiring, non-breaking breakpoints—to your running services to capture runtime data for debugging without redeploying your code. + +{{< img src="/ide_plugins/vscode/live_debugger_overview.mp4" alt="Overview of the Datadog Live Debugger activity" style="width:100%" video=true >}} + +Find out more in the [Live Debugger][23] sub-section. ## Data and telemetry diff --git a/content/en/ide_plugins/vscode/code_insights.md b/content/en/ide_plugins/vscode/code_insights.md index 705091abedb..820fefde7d3 100644 --- a/content/en/ide_plugins/vscode/code_insights.md +++ b/content/en/ide_plugins/vscode/code_insights.md @@ -2,12 +2,12 @@ title: Code Insights type: documentation further_reading: - - link: '/tracing/error_tracking/' - tag: 'Documentation' - text: 'Learn more about Error Tracking' - link: '/security/code_security/' tag: 'Documentation' text: 'Learn more about Code Security' + - link: '/tracing/error_tracking/' + tag: 'Documentation' + text: 'Learn more about Error Tracking' - link: '/tests/explorer/' tag: 'Documentation' text: 'Learn more about Test Optimization' @@ -15,13 +15,9 @@ further_reading: ## Overview -**Code Insights** keep you informed with Datadog-generated insights that are relevant to your codebase: - -- Runtime errors collected by [Error Tracking][1] -- Code and library vulnerabilities reported by [Code Security][2] -- Flaky tests detected by [Test Optimization][3] +**Code Insights** keep you informed with code and library vulnerabilities reported by [Code Security][2] that are relevant to your codebase. -The extension identifies errors and vulnerabilities in the code with colored squiggles; hover over the line for more details. +The extension identifies vulnerabilities in the code with colored squiggles; hover over the line for more details. {{< img src="/ide_plugins/vscode/code-insights-inline-hover.mp4" alt="Hovering over inline code insights" style="width:100%" video=true >}} @@ -35,6 +31,13 @@ For specific insights about the file currently open in the active editor, check {{< img src="/ide_plugins/vscode/file_insights_view.mp4" alt="File Insights view" style="width:100%" video=true >}} +### Other insight types + +The following insight types are in limited support: + +- Runtime errors collected by [Error Tracking][1] +- Flaky tests detected by [Test Optimization][3] + ## Further reading {{< partial name="whats-next/whats-next.html" >}} diff --git a/content/en/ide_plugins/vscode/exception_replay.md b/content/en/ide_plugins/vscode/exception_replay.md index 3b5bd4be182..c2732799342 100644 --- a/content/en/ide_plugins/vscode/exception_replay.md +++ b/content/en/ide_plugins/vscode/exception_replay.md @@ -9,6 +9,8 @@ further_reading: ## Overview +
This feature is in limited support.
+ **Exception Replay** allows you to inspect the stack trace frames of any Error Tracking code insight and get information about variable values from the code running in production. To access this feature, you must enable [Error Tracking Exception Replay][1] on Datadog. diff --git a/content/en/ide_plugins/vscode/live_debugger.md b/content/en/ide_plugins/vscode/live_debugger.md index 8d4c64a5ccd..ade333ffedc 100644 --- a/content/en/ide_plugins/vscode/live_debugger.md +++ b/content/en/ide_plugins/vscode/live_debugger.md @@ -13,6 +13,8 @@ further_reading: ## Overview +
This feature is in limited support.
+ The **Live Debugger** lets you add logpoints—auto-expiring, non-breaking breakpoints—to your running services to collect information for debugging. Logpoints are set dynamically, so you don't need to redeploy your code to investigate an issue. Logpoints are grouped into sessions, and you can activate, edit, deactivate, or delete sessions (or individual logpoints) at any time. All sessions and logpoints automatically deactivate after 60 minutes, and log events are rate-limited to one execution per second. To use this feature, your service must be set up for [Datadog Dynamic Instrumentation][1], and remote code is matched to your local files using [Source Code Integration][2]. diff --git a/content/en/ide_plugins/vscode/logs.md b/content/en/ide_plugins/vscode/logs.md index 0add03fc75f..96f5645c77a 100644 --- a/content/en/ide_plugins/vscode/logs.md +++ b/content/en/ide_plugins/vscode/logs.md @@ -9,6 +9,8 @@ further_reading: ## Overview +
This feature is in limited support.
+ The **Logs** feature detects logging patterns in your source code and displays the volume of matching log records from Datadog. Click an annotation to open the [Log Explorer][1] and view the matching logs. {{< img src="/ide_plugins/vscode/logs_navigation.mp4" alt="Preview of Logs Navigation" style="width:100%" video=true >}}