dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md

4.7 KiB
Raw Blame History

type title linkTitle weight description
docs Dapr Visual Studio Code extension overview Dapr extension 10000 How to develop and run Dapr applications with the Dapr extension

Dapr offers a preview Dapr Visual Studio Code extension for local development and debugging of your Dapr applications.

Open in VSCode

Features

Scaffold Dapr debugging tasks

The Dapr extension helps you debug your applications with Dapr using Visual Studio Code's built-in debugging capability.

Using the Dapr: Scaffold Dapr Tasks Command Palette operation, you can update your existing task.json and launch.json files to launch and configure the Dapr sidecar when you begin debugging.

  1. Make sure you have a launch configuration set for your app. (Learn more)
  2. Open the Command Palette with Ctrl+Shift+P
  3. Select Dapr: Scaffold Dapr Tasks
  4. Run your app and the Dapr sidecar with F5 or via the Run view.

Scaffold Dapr components

When adding Dapr to your application, you may want to have a dedicated components directory, separate from the default components initialized as part of dapr init.

To create a dedicated components folder with the default statestore, pubsub, and zipkin components, use the Dapr: Scaffold Dapr Components Command Palette operation.

  1. Open your application directory in Visual Studio Code
  2. Open the Command Palette with Ctrl+Shift+P
  3. Select Dapr: Scaffold Dapr Components
  4. Run your application with dapr run --components-path ./components -- ...

View running Dapr applications

The Applications view shows Dapr applications running locally on your machine.


Screenshot of the Dapr VSCode extension view running applications option

Invoke Dapr application methods

  • Allows users to select a Dapr application found in the tree view "Applications" and invoke GET/POST methods by name.
  • Allows users to specify an optional payload for POST methods
    Screenshot of the Dapr VSCode extension invoke option

Publish events to Dapr applications

Within the Applications view, users can right-click and publish messages to a running Dapr application, specifying the topic and payload.

Users can also publish messages to all running applications.


Screenshot of the Dapr VSCode extension publish option

Telemetry

Data collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Microsoft's privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and privacy statement. Your use of the software operates as your consent to these practices.

Disabling Telemetry

If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in the VSCode FAQ.

Additional resources

Debugging multiple Dapr applications at the same time

Using the VS Code extension, you can debug multiple Dapr applications at the same time with Multi-target debugging.

Community call demo

Watch this video on how to use the Dapr VS Code extension: