diff --git a/howto/README.md b/howto/README.md index 4f5ae1dfe..8f9385e15 100644 --- a/howto/README.md +++ b/howto/README.md @@ -46,6 +46,10 @@ Here you'll find a list of How To guides that walk you through accomplishing spe * [Debugging with daprd](./vscode-debugging-daprd) +## Configuring IntelliJ + +* [Debugging with daprd](./intellij-debugging-daprd) + ## SDKs * [Serialize objects](./serialize) diff --git a/howto/intellij-debugging-daprd/README.md b/howto/intellij-debugging-daprd/README.md new file mode 100644 index 000000000..61e831093 --- /dev/null +++ b/howto/intellij-debugging-daprd/README.md @@ -0,0 +1,75 @@ +# Configuring IntelliJ Community Edition for debugging with daprd + +When developing Dapr applications, you typically use the Dapr cli to start your 'Daprized' service similar to this: + +```bash +dapr run --app-id nodeapp --app-port 3000 --port 3500 app.js +``` + +This will generate the components yaml files (if they don't exist) so that your service can interact with the local redis container. This is great when you are just getting started but what if you want to attach a debugger to your service and step through the code? This is where you can use the dapr runtime (daprd) to help facilitate this. + +>Note: The Dapr runtime (daprd) will not automatically generate the components yaml files for Redis. These will need to be created manually or you will need to run the dapr cli (dapr) once in order to have them created automatically. + +One approach to attaching the debugger to your service is to first run `daprd` or `dapr` with the correct arguments from the command line and then launch your code and attach the debugger. While this is a perfectly acceptable solution, it does require a few extra steps and some instruction to developers who might want to clone your repo and hit the "play" button to begin debugging. + +This document will explain how to use `daprd` directly from IntelliJ. As a pre-requisite, make sure you have initialized the Dapr's dev environment via `dapr init`. + +Let's get started! + +## Add daprd as an 'External Tool' + +First, quit IntelliJ. + +Create or edit the file in `$HOME/.IdeaIC2019.3/config/tools/External\ Tools.xml` (change IntelliJ version in path if needed) to add a new `` entry: + +```xml + + ... + + + + + + + ... + +``` + +## Create or edit run configuration + +Now, create or edit the run configuration for the application to be debugged. It can be found in the menu next to the `main()` function. + +![Edit run configuration menu](../../images/intellij_debug_menu.png) + +Now, add the program arguments and environment variables. These need to match the ports defined in the entry in 'External Tool' above. + +* Command line arguments for this example: `-p 3000` +* Environment variables for this example: `DAPR_HTTP_PORT=3005;DAPR_GRPC_PORT=5200` + +![Edit run configuration](../../images/intellij_edit_run_configuration.png) + +## Start debugging + +Once the one-time config above is done, there are two steps required to debug a Java application with Dapr in IntelliJ: + +1. Start `daprd` via `Tools` -> `External Tool` in IntelliJ. + +![Run daprd as 'External Tool'](../../images/intellij_start_daprd.png) + +2. Start your application in debug mode. + +![Start application in debug mode](../../images/intellij_debug_app.png) + +## Wrapping up + +After debugging, make sure you stop both `daprd` and your app in IntelliJ. + + +>Note: Since you didn't launch the service(s) using the **dapr** ***run*** cli command, but instead by running **daprd**, the **dapr** ***list*** command will not show a list of apps that are currently running. + +Happy debugging! diff --git a/images/intellij_debug_app.png b/images/intellij_debug_app.png new file mode 100644 index 000000000..5727e0cb6 Binary files /dev/null and b/images/intellij_debug_app.png differ diff --git a/images/intellij_debug_menu.png b/images/intellij_debug_menu.png new file mode 100644 index 000000000..03a34b559 Binary files /dev/null and b/images/intellij_debug_menu.png differ diff --git a/images/intellij_edit_run_configuration.png b/images/intellij_edit_run_configuration.png new file mode 100644 index 000000000..1f297bf52 Binary files /dev/null and b/images/intellij_edit_run_configuration.png differ diff --git a/images/intellij_start_daprd.png b/images/intellij_start_daprd.png new file mode 100644 index 000000000..27a07f06d Binary files /dev/null and b/images/intellij_start_daprd.png differ