Datadog Extension for Visual Studio Code

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Overview

The Datadog extension for Visual Studio Code (VS Code) integrates with Datadog to accelerate your development.

The Datadog for VS Code extension

It packs several features, including:

Requirements

  • A Datadog account: The extension requires a Datadog account (except when using Static Analysis features). If you’re new to Datadog, go to the Datadog website to learn more about Datadog’s observability tools and sign up for a free trial.

  • VS Code Git: The extension works better when VS Code Git integration is enabled. You can ensure that the integration is enabled by checking the git.enabled setting.

Setup

Install the Datadog Extension from the Visual Studio Marketplace.

Code Insights

The Code Insights tree displays insights generated by the Datadog platform that are relevant to your code-base. The insights are grouped into three categories: performance, reliability, and security.

The Code Insights view.

Code Insights include a detailed description for each issue, and links to:

  • The related source code location
  • The Datadog platform for additional information

You can dismiss individual Code Insights and set filters to view the ones you are most interested in.

Synthetic Tests

The Datadog extension enables you to run Synthetic HTTP tests and browser tests on local environments directly in VS Code. You can identify and address potential issues resulting from code changes before they are deployed into production and impact your end users.

The Datadog Extension in VS Code

Run Synthetic tests locally

  1. Select a Synthetic test to execute. You can search for specific tests by clicking the Search icon.
  2. Change the test’s configuration to convert the start URL and specify a localhost URL on the Settings page.
  3. Run the test.
The Test Configuration panel and Settings page where you can specify the start URL of a Synthetics test to a localhost URL

If you haven’t set up Synthetic tests already, create a test in Datadog. For more information about running tests on a local environment, see Getting Started with API Tests, Getting Started with Browser Tests, and the Continuous Testing documentation.

Permissions

By default, only users with the Datadog Admin and Datadog Standard roles can create, edit, and delete Synthetic HTTP and browser tests. To get create, edit, and delete access to Synthetic HTTP and browser tests, upgrade your user to one of those two default roles.

If you are using the custom role feature, add your user to any custom role that includes synthetics_read and synthetics_write permissions.

View in VS Code

The View in VS Code 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):

A stack trace on the Datadog platform showing the View in VS Code button.
To use this feature, first configure source code integration for your service.

Logs navigation

You can navigate to the Log Explorer on the Datadog platform directly from your source code files.

If you’re using a supported logging library, the extension is able to show you code lenses on the lines where it has detected log patterns that match the Datadog platform records:

The supported logging libraries are:

Alternatively, you can select some text in your source code, right click on them, and look for the Datadog > Search Logs With Selected Text option.

Using the Datadog Logs explorer feature

Code Delta

Code Delta matches the line numbers included in Datadog telemetry to the line numbers of the files you are currently working on in VS Code.

For example, all View in VS Code links on the Datadog platform encode runtime version info, and the extension uses that to compute the corresponding line of code in your editor, taking into account version changes.

You can tweak the Code Delta settings to change how the matching algorithm works. In particular, you can modify the Minimum Affinity value, which determines the degree of confidence required to match lines.

Static Analysis

The Static Analysis integration analyzes your code (locally) against predefined rules to detect and fix problems.

The Datadog extension runs Static Analysis rules on the source files you have open in your Workspace. The goal is to detect and fix problems such as maintainability issues, bugs, or security vulnerabilities in your code before you commit your changes.

Static Analysis supports scanning for many programming languages. For a complete list, see Static Analysis Rules. For file types belonging to supported languages, issues are shown in the source code editor with the VS Code inspection system, and suggested fixes can be applied directly.

Getting started

When you start editing a source file, the extension checks for static-analysis.datadog.yml at your source repository’s root. It prompts you to create it if necessary.

A banner for onboarding.

Once the configuration file is created, the static analyzer runs automatically in the background.

The Static Analysis feature does not require a Datadog account, as source files are analyzed locally.

License

Please read this End-User License Agreement carefully before downloading or using the Datadog Visual Studio Code Extension.

Data and telemetry

Datadog anonymously collects information about your usage of this IDE, including how you interact with it, whether errors occurred while using it, and what caused those errors, in accordance with the Datadog Privacy Policy and Datadog’s VS Code extension EULA.

If you don’t wish to send this data to Datadog, you can opt out at any time in the VS Code extension settings: Datadog > Telemetry > Setup > Enable Telemetry and select disabled.

The Datadog extension also honors the VS Code telemetry telemetry setting.

Help and feedback

To share your feedback, email team-ide-integration@datadoghq.com or create an issue in the extension’s public repository.

Check out the issues section to discover known issues.

Further Reading