Удаленная отладка приложений в Azure Spring Apps

Примечание.

Azure Spring Apps — это новое название службы Azure Spring Cloud. Старое название будет еще некоторое время встречаться в наших материалах, пока мы не обновим ресурсы, такие как снимки экрана, видео и схемы.

Эта статья относится к: ✔️ Basic/Standard ✔️ Enterprise

Эта функция описывает, как включить удаленную отладку приложений в Azure Spring Apps.

Необходимые компоненты

• Azure CLI с расширением Azure Spring Apps. Используйте следующую команду, чтобы удалить предыдущие версии и установить последнее расширение. Если вы ранее установили расширение Spring-Cloud, удалите его, чтобы избежать несоответствий конфигурации и версий.

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

• Развернутое приложение в Azure Spring Apps.

Включение или отключение удаленной отладки

По соображениям безопасности Azure Spring Apps по умолчанию отключает удаленную отладку. В соответствии с политикой компании вы можете включить удаленную отладку для вашего приложения или увидеть администратора, чтобы включить его для вас. Вы можете включить или отключить удаленную отладку с помощью Azure CLI, портал Azure или расширения VS Code.

Портал Azure

Выполните следующие действия, чтобы включить удаленную отладку для приложения с помощью портал Azure:

1. Перейдите на страницу приложения.

2. В разделе Параметры в области навигации слева выберите "Удаленная отладка".

3. На странице удаленной отладки включите удаленную отладку и укажите порт отладки.

   

Azure CLI

Используйте следующую команду, чтобы включить удаленную отладку для приложения с помощью Azure CLI:

az spring app enable-remote-debugging \
    --name <application-name> \
    --deployment <deployment-name> \
    --resource-group <resource-group-name> \
    --service <service-name> \
    --port <port>

Используйте следующую команду, чтобы отключить удаленную отладку для приложения:

az spring app disable-remote-debugging \
    --name <application-name> \
    --deployment <deployment-name> \
    --resource-group <resource-group-name> \
    --service <service-name> \

Используйте следующую команду, чтобы отобразить конфигурацию удаленной отладки:

az spring app get-remote-debugging-config \
    --name <application-name> \
    --deployment <deployment-name> \
    --resource-group <resource-group-name> \
    --service <service-name> \

Назначение роли Azure

Для удаленной отладки экземпляра приложения необходимо предоставить роль Azure Spring Apps Remote Debugging Role, включающую Microsoft.AppPlatform/Spring/apps/deployments/remotedebugging/action разрешение действия данных.

Вы можете назначить роль Azure с помощью портал Azure или Azure CLI.

Портал Azure

Чтобы назначить роль Azure с помощью портал Azure, выполните следующие действия.

1. Откройте портал Azure.

2. Откройте экземпляр службы Azure Spring Apps.

3. В области навигации выберите контроль доступа (IAM).

4. На странице контроль доступа (IAM) выберите "Добавить" и выберите "Добавить назначение роли".

   

5. На странице "Добавление назначения ролей" в списке "Имя" найдите и выберите роль удаленной отладки Azure Spring Apps, а затем нажмите кнопку "Далее".

   

6. Выберите "Участники", а затем найдите и выберите имя пользователя.

7. Выберите Проверить + назначить.

Azure CLI

Используйте следующую команду, чтобы получить роль удаленной отладки Azure Spring Apps.

az role assignment create \
    --role "Azure Spring Apps Remote Debugging Role" \
    --scope "<service-instance-resource-id>" \
    --assignee "<your-identity>"

Удаленная отладка экземпляра приложения

Вы можете удаленно отлаживать экземпляр приложения с помощью набор средств Azure для IntelliJ или расширения Azure Spring Apps для VS Code.

Azure Toolkit for IntelliJ

В этом разделе описывается удаленное отладка экземпляра приложения с помощью Azure набор средств для IntelliJ.

Необходимые компоненты

• Набор средств Azure для IntelliJ.
• IntelliJ IDEA, Ultimate или Community edition.

Включение или отключение удаленной отладки

Чтобы включить или отключить удаленную отладку, выполните следующие действия.

1. Войдите в учетную запись Azure в Обозреватель Azure.

2. Выберите экземпляр приложения и нажмите кнопку "Включить удаленную отладку".

   

Подключение отладчика

Чтобы подключить отладчик, выполните следующие действия.

1. Выберите экземпляр приложения и нажмите кнопку "Подключить отладчик". IntelliJ подключается к экземпляру приложения и запускает удаленную отладку.

   

2. Azure набор средств для IntelliJ создает конфигурацию удаленной отладки. Его можно найти в разделе "Удаленная отладка Jvm" Настройте путь класса модуля к исходному коду, используемому для удаленной отладки.

   

Устранение неполадок

В этом разделе содержатся сведения об устранении неполадок.

• Выполните следующие действия, если не удается подключить отладчик и получить ошибку, аналогичную java.net.SocketException, connection reset или Failed to attach to remote debugger, ClosedConnectionException:

  • Проверьте роль RBAC, чтобы убедиться, что вы авторизованы для удаленной отладки экземпляра приложения.

  • Убедитесь, что вы подключаетесь к допустимому экземпляру. Обновите развертывание, чтобы получить последние экземпляры.

    

• Выполните следующие действия, если вы успешно подключили отладчик, но не сможете удаленно выполнить отладку экземпляра приложения:

  • Убедитесь, что интегрированная среда разработки содержит исходный код, который требуется выполнить отладку.
  • Убедитесь, что конфигурация отладки имеет правильный путь к классу модуля.

Расширение VS Code

В этом разделе описывается удаленное отладка экземпляра приложения с помощью расширения VS Code.

Необходимые компоненты

• Подключаемый модуль Azure Spring Apps для VS Code.
• Visual Studio Code.

Включение или отключение удаленной отладки

Чтобы включить или отключить удаленную отладку, выполните следующие действия.

1. Вход в вашу подписку Azure.

2. Выберите экземпляр приложения и нажмите кнопку "Включить удаленную отладку".

   

Подключение отладчика

Чтобы подключить отладчик, выполните следующие действия.

1. Выберите экземпляр приложения и нажмите кнопку "Подключить отладчик". VS Code подключается к экземпляру приложения и запускает удаленную отладку.

   

Устранение неполадок

В этом разделе содержатся сведения об устранении неполадок.

• Выполните следующие действия, если не удается подключить отладчик и получить ошибку, аналогичную java.net.SocketException, connection reset или Failed to attach to remote debugger, ClosedConnectionException:

  • Проверьте роль RBAC, чтобы убедиться, что вы авторизованы для удаленной отладки экземпляра приложения.

  • Убедитесь, что вы подключаетесь к допустимому экземпляру. Обновите развертывание, чтобы получить последние экземпляры.

    

• Выполните следующее действие, если вы успешно подключили отладчик, но не сможете удаленно выполнить отладку экземпляра приложения:

  • Убедитесь, что интегрированная среда разработки содержит исходный код, который требуется выполнить отладку.

Ограничения

Удаленная отладка поддерживается только для приложений Java.

Планирование	Тип развертывания	Поддерживается
Стандартный и базовый план	Jar	Да
Стандартный и базовый план	Исходный код (Java)	Да
Стандартный и базовый план	Пользовательский образ	No
План "Корпоративный"	Приложение Java	Да
План "Корпоративный"	Исходный код (Java)	Да
План "Корпоративный"	Пользовательский образ	No

Советы

• Удаленная отладка Java опасна, так как она позволяет выполнять удаленный код. Azure Spring Apps помогает защитить обмен данными между интегрированной средую разработки клиента и удаленным приложением. Однако после завершения необходимо отключить удаленную отладку и удалить роль RBAC.
• Необходимо масштабировать в экземпляре приложения до одного, чтобы убедиться, что трафик может перейти к экземпляру.

Следующие шаги

• Azure Spring Apps