Включение отладчика моментальных снимков для приложений .NET в Службе приложений Azure

Статья
11/05/2024

Примечание.

Если вы используете предварительную версию .NET Core или ваше приложение прямо или косвенно ссылается на SDK Application Insights через зависимую сборку, выполните инструкции из статьи Включить отладчик моментальных снимков для других сред, чтобы добавить пакет NuGet Microsoft.ApplicationInsights.SnapshotCollector с приложением.

Отладчик моментальных снимков в настоящее время поддерживает ASP.NET и приложения ASP.NET Core, работающие в службе приложение Azure в планах служб Windows.

При использовании отладчика моментальных снимков рекомендуется запустить приложение на уровнях служб "Базовый" или выше. Для большинства приложений:

Уровни бесплатных и общих служб не имеют достаточного объема памяти или дискового пространства для сохранения моментальных снимков.
Уровень потребления в настоящее время недоступен для отладчика моментальных снимков.

Хотя отладчик моментальных снимков предварительно установлен в рамках среды выполнения Служба приложений s, его необходимо включить, чтобы получить моментальные снимки для приложения Служба приложений. Без кода установка отладчика моментальных снимков следует политике поддержки .NET Core..

Портал Azure
Диспетчер ресурсов Azure Resource Manager

После развертывания веб-приложения .NET Служба приложений s:

Перейдите к Служба приложений в портал Azure.
В меню слева выберите "Параметры>Application Insights".
Щелкните Включить Application Insights.
- Если у вас есть существующий ресурс Application Insights, который вы хотите использовать, выберите этот параметр в разделе "Изменить ресурс".
В разделе Инструментирование приложения выберите вкладку .NET .
Переключите оба отладчика моментальных снимков в положение "Вкл.".
Теперь отладчик моментальных снимков включен.

Отключение Snapshot Debugger

Чтобы отключить отладчик моментальных снимков для ресурса Служба приложений s:

Перейдите к Служба приложений в портал Azure.
В меню слева выберите "Параметры>Application Insights".
Переключите переключатель отладчика моментальных снимков в положение "Отключить".

Вы также можете задать параметры приложения в шаблоне Azure Resource Manager, чтобы включить отладчик моментальных снимков и профилировщик. Например:

{
  "apiVersion": "2023-12-01",
  "name": "[parameters('webSiteName')]",
  "type": "Microsoft.Web/sites",
  "location": "[resourceGroup().location]",
  "dependsOn": [
    "[variables('hostingPlanName')]"
  ],
  "tags": { 
    "[concat('hidden-related:', resourceId('Microsoft.Web/serverfarms', variables('hostingPlanName')))]": "empty",
    "displayName": "Website"
  },
  "properties": {
    "name": "[parameters('webSiteName')]",
    "serverFarmId": "[resourceId('Microsoft.Web/serverfarms', variables('hostingPlanName'))]"
  },
  "resources": [
    {
      "apiVersion": "2015-08-01",
      "name": "appsettings",
      "type": "config",
      "dependsOn": [
        "[parameters('webSiteName')]",
        "[concat('AppInsights', parameters('webSiteName'))]"
      ],
      "properties": {
        "APPINSIGHTS_INSTRUMENTATIONKEY": "[reference(resourceId('Microsoft.Insights/components', concat('AppInsights', parameters('webSiteName'))), '2014-04-01').InstrumentationKey]",
        // "Turn on" a Snapshot Debugger version
        "APPINSIGHTS_SNAPSHOTFEATURE_VERSION": "1.0.0",
        "DiagnosticServices_EXTENSION_VERSION": "~3",
        "ApplicationInsightsAgent_EXTENSION_VERSION": "~2"
      }
    }
  ]
},

Создайте трафик для вашего приложения, который может вызвать исключение. После этого подождите 10–15 минут, пока снимки не будут отправлены в экземпляр Application Insights.

Включение отладчика моментальных снимков для других облачных регионов

В настоящее время единственными регионами, для которых требуются изменения конечных точек, являются Azure для государственных организаций и Microsoft Azure, управляемые 21Vianet через строку подключения Application Insights.

Свойство строки подключения	Облако для государственных организаций США	облако для Китая.
SnapshotEndpoint	`https://snapshot.monitor.azure.us`	`https://snapshot.monitor.azure.cn`

Дополнительные сведения о других переопределениях подключения см. в Документации по Application Insights.

Настройка Snapshot Debugger

Включение проверки подлинности Microsoft Entra для приема моментальных снимков

Отладчик моментальных снимков поддерживает проверку подлинности Microsoft Entra для приема моментальных снимков. Для приема всех моментальных снимков приложения необходимо пройти проверку подлинности и указать необходимые параметры приложения агенту отладчика моментальных снимков.

По состоянию на сегодняшний день отладчик моментальных снимков поддерживает проверку подлинности Microsoft Entra только при ссылке и настройке идентификатора Microsoft Entra с помощью пакета SDK Application Insights в приложении.

Чтобы включить идентификатор Microsoft Entra для приема моментальных снимков в ресурсе Служба приложений s:

Добавьте управляемое удостоверение, которое проходит проверку подлинности в ресурсе Application Insights в Служба приложений. Вы можете создать любой из следующих вариантов:
- Добавьте управляемое удостоверение, назначаемое системой.
- Добавьте управляемое удостоверение, назначаемое пользователем.
Настройте и включите идентификатор Microsoft Entra в ресурсе Application Insights. Дополнительные сведения см. в этой документации.
Добавьте следующий параметр приложения. Этот параметр сообщает агенту отладчика моментальных снимков, который будет использоваться управляемым удостоверением:

Для назначаемого системой удостоверения:

Параметр приложения	Значение
APPLICATIONINSIGHTS_AUTHENTICATION_STRING	Authorization=AD

Для назначаемого пользователем удостоверения:

Параметр приложения	Значение
APPLICATIONINSIGHTS_AUTHENTICATION_STRING	Authorization=AD; ClientID={Идентификатор клиента назначаемого пользователем удостоверения}

Неподдерживаемые сценарии

Ниже приведены сценарии, в которых Snapshot Collector не поддерживается.

Сценарий	Побочные эффекты	Рекомендация
Вы используете пакет SDK сборщика моментальных снимков в приложении напрямую (CSPROJ) и включили расширенный параметр "Взаимодействие".	Локальный пакет SDK Application Insights (включая данные телеметрии сборщика моментальных снимков) потерян, и моментальные снимки недоступны. Приложение может аварийно завершить работу при запуске с ошибкой `System.ArgumentException: telemetryProcessorTypedoes not implement ITelemetryProcessor.` Дополнительные сведения о возможности "Interop" в Application Insights.	Если вы используете расширенный параметр "Interop", используйте внедрение Snapshot Collector без кода (включается на портале Azure).

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

Просмотр моментальных снимков в портал Azure.
Устранение неполадок с отладчиком моментальных снимков.

Поделиться через