Edit

Debug your apps remotely in Azure Spring Apps

  • Article

Note

Azure Spring Apps is the new name for the Azure Spring Cloud service. Although the service has a new name, you'll see the old name in some places for a while as we work to update assets such as screenshots, videos, and diagrams.

This article applies to: ✔️ Basic/Standard ✔️ Enterprise

This feature describes how to enable remote debugging of your applications in Azure Spring Apps.

Prerequisites

  • Azure CLI with the Azure Spring Apps extension. Use the following command to remove previous versions and install the latest extension. If you previously installed the spring-cloud extension, uninstall it to avoid configuration and version mismatches.

    az extension remove --name spring
az extension add --name spring
az extension remove --name spring-cloud

  • A deployed application in Azure Spring Apps.

Enable or disable remote debugging

For security reasons, Azure Spring Apps disables remote debugging by default. Based on your company policy, you can enable remote debugging for your app yourself or see an admin to enable it for you. You can enable or disable remote debugging using Azure CLI, Azure portal, or the VS Code extension.

Use the following steps to enable remote debugging for your application using the Azure portal:

  1. Navigate to your application page.

  2. Under Settings in the left navigation pane, select Remote debugging.

  3. On the Remote debugging page, enable remote debugging and specify the debugging port.

    Screenshot of the Azure portal that shows the Remote debugging page with the Remote debugging and Debugging port options selected.

Assign an Azure role

To remotely debug an app instance, you must be granted the role Azure Spring Apps Remote Debugging Role, which includes the Microsoft.AppPlatform/Spring/apps/deployments/remotedebugging/action data action permission.

You can assign an Azure role using the Azure portal or Azure CLI.

Use the following steps to assign an Azure role using the Azure portal.

  1. Open the Azure portal.

  2. Open your Azure Spring Apps service instance.

  3. In the navigation pane, select Access Control (IAM).

  4. On the Access Control (IAM) page, select Add, and then select Add role assignment.

    Screenshot of the Azure portal Access Control (IAM) page for an Azure Spring Apps instance with the Add role assignment option highlighted.

  5. On the Add role assignment page, in the Name list, search for and select Azure Spring Apps Remote Debugging Role, and then select Next.

    Screenshot of the Azure portal that shows the Add role assignment page with the Azure Spring Apps Remote Debugging Role name highlighted.

  6. Select Members, and then search for and select your username.

  7. Select Review + assign.

Debug an app instance remotely

You can debug an app instance remotely using the Azure Toolkit for IntelliJ or the Azure Spring Apps for VS Code extension.

This section describes how to debug an app instance remotely using the Azure Toolkit for IntelliJ.

Prerequisites

Enable or disable remote debugging

Use the following steps to enable or disable remote debugging:

  1. Sign in to your Azure account in Azure Explorer.

  2. Select an app instance, and then select Enable Remote Debugging.

    Screenshot of IntelliJ that shows the Enable Remote Debugging menu option.

Attach debugger

Use the following steps to attach debugger.

  1. Select an app instance, and then select Attach Debugger. IntelliJ connects to the app instance and starts remote debugging.

    Screenshot of IntelliJ that shows the Attach Debugger menu option.

  2. Azure Toolkit for IntelliJ creates the remote debugging configuration. You can find it under Remote Jvm Debug" Configure the module class path to the source code that you use for remote debugging.

    Screenshot of IntelliJ that shows the Run/Debug Configurations page.

Troubleshooting

This section provides troubleshooting information.

  • Take the following actions if you fail to attach debugger and receive an error similar to java.net.SocketException, connection reset or Failed to attach to remote debugger, ClosedConnectionException:

    • Check the RBAC role to make sure that you're authorized to remotely debug an app instance.

    • Make sure that you're connecting to a valid instance. Refresh the deployment to get the latest instances.

      Screenshot of the IntelliJ project explorer that shows the Refresh menu option for the App Instances node.

  • Take the following actions if you successfully attach debugger but can't remotely debug the app instance:

    • Make sure that your IDE contains the source code you want to debug.
    • Make sure that the debug configuration has the correct module class path.

Limitations

Remote debugging is only supported for Java applications.

Plan Deployment type Supported
Standard and basic plan Jar Yes
Standard and basic plan Source code(Java) Yes
Standard and basic plan Custom Image No
Enterprise plan Java Application Yes
Enterprise plan Source code(Java) Yes
Enterprise plan Custom Image No

Tips

  • Java remote debugging is dangerous because it allows remote code execution. Azure Spring Apps helps you secure the communication between your client IDE and the remote application. However, you should disable remote debugging and remove the RBAC role after you're finished.
  • You should scale in the app instance to one to ensure that traffic can go to the instance.

Next steps