Habilitar o Depurador de Instantâneos para aplicativos .NET no Serviço de Aplicativo do Azure

Artigo
10/15/2024

Observação

Se você estiver usando uma versão prévia do .NET Core ou se o aplicativo referenciar o SDK do Application Insights (direta ou indiretamente por meio de um assembly dependente), siga as instruções para Habilitar o Depurador de Instantâneos em outros ambientes a fim de incluir o pacote NuGet Microsoft.ApplicationInsights.SnapshotCollector com o aplicativo.

Depurador de Instantâneos atualmente dá suporte ASP.NET e ASP.NET Core em execução Serviço de Aplicativo do Azure em planos de serviço do Windows.

Recomendamos que você execute o aplicativo na camada de serviço Básica ou superior ao usar Depurador de Instantâneos. Para a maioria dos aplicativos:

Para a maioria dos aplicativos, as camadas de serviço Gratuita e Compartilhada não têm memória ou espaço em disco suficiente para salvar instantâneos.
No momento, a camada de Consumo não está disponível para o Depurador de Instantâneos.

Embora o Depurador de Instantâneos seja pré-instalado como parte do tempo de execução dos serviços de aplicativo, mas você precisa ativá-lo para obter instantâneos para seu aplicativo do serviço de aplicativo. A instalação sem código do Depurador de Instantâneos do Application Insights segue a política de suporte do .NET Core.

Portal do Azure
Azure Resource Manager

Depois de implantar seu aplicativo Web do .NET App Services:

No portal do Azure, navegue até o Serviço de Aplicativo.
No menu à esquerda, selecione Configurações>Application Insights.
Clique em Ativar o Application Insights.
- Se você tiver um recurso existente do Application Insights que prefere usar, selecione essa opção em Alterar seu recurso.
Em Instrumentar seu aplicativo, selecione a guia .NET.
Mude o Depurador de Instantâneos para Ativado.
O Depurador de Instantâneos agora está habilitado.

Desabilitar o Depurador de Instantâneos

Para desabilitar o Depurador de Instantâneos para o recurso dos Serviços de Aplicativo:

No portal do Azure, navegue até o Serviço de Aplicativo.
No menu à esquerda, selecione Configurações>Application Insights.
Mude o Depurador de Instantâneos para Desativado.

Você também pode definir as configurações de aplicativo no modelo do Azure Resource Manager para habilitar o Depurador de Instantâneos e o Profiler. Por exemplo:

{
  "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"
      }
    }
  ]
},

Gere o tráfego para o aplicativo que pode disparar uma exceção. Em seguida, espere de 10 a 15 minutos para que os instantâneos comecem a ser enviados à instância do Application Insights.

Habilitar o Depurador de Instantâneos para outras regiões de nuvem

Atualmente, as únicas regiões que exigem modificações de ponto de extremidade são o Microsoft Azure Governamental e o Microsoft Azure operado pela 21Vianet por meio da Cadeia de conexão do visual Studio Online Application Insights.

Propriedade Cadeia de Conexão	Nuvem do governo dos EUA	Nuvem da China
SnapshotEndpoint	`https://snapshot.monitor.azure.us`	`https://snapshot.monitor.azure.cn`

Para obter mais informações sobre outras substituições de conexão, veja a documentação do Application Insights.

Configurar Depurador de Instantâneos

Habilitar a autenticação do Microsoft Entra para ingestão de instantâneo

O Depurador de Instantâneos dá suporte à autenticação do Microsoft Entra para ingestão de instantâneos. Para que todos os instantâneos do seu aplicativo sejam ingeridos, seu aplicativo precisa estar autenticado e fornecer as configurações de aplicativo necessárias para o agente do Depurador de Instantâneos.

A partir de hoje, o Depurador de Instantâneos só dá suporte à autenticação do Microsoft Entra quando você faz referência e configura a ID do Microsoft Entra usando o SDK do Application Insights em seu aplicativo.

Para ativar o Microsoft Entra ID para ingestão de instantâneo no recurso dos Serviços de Aplicativo:

Adicione a identidade gerenciada que se autentica com seu recurso do Application Insights para o Serviço de Aplicativo. Você pode criar:
- Adicionar uma identidade gerenciada atribuída pelo sistema.
- Adicionar uma identidade gerenciada atribuída pelo usuário.
Configure e ative a ID do Microsoft Entra em seu recurso do Application Insights. Para saber mais, confira a documentação a seguir
Adicione a configuração de aplicativo a seguir. Essa configuração informa ao agente do Depurador de Instantâneos qual identidade gerenciada usar:

Para identidade atribuída pelo sistema:

Configurações de Aplicativo	Valor
APPLICATIONINSIGHTS_AUTHENTICATION_STRING	Authorization=AD

Para identidade atribuída pelo usuário:

Configurações de Aplicativo	Valor
APPLICATIONINSIGHTS_AUTHENTICATION_STRING	Authorization=AD;ClientID={ID do Cliente da Identidade Atribuída pelo Usuário}

Cenários sem suporte

Abaixo, você encontra cenários em que não há suporte para o Snapshot Collector:

Cenário	Efeitos colaterais	Recomendação
Você está usando o SDK do Snapshot Collector no aplicativo diretamente (.csproj) e habilitou a opção avançada "Interop".	O SDK do Application Insights local (incluindo a telemetria do Snapshot Collector) é perdido, portanto, nenhum instantâneo está disponível. Seu aplicativo pode falhar na inicialização com `System.ArgumentException: telemetryProcessorTypedoes not implement ITelemetryProcessor.` Saiba mais sobre o recurso "Interop" do Application Insights.	Se você estiver usando a opção avançada "Interop", use a injeção do Snapshot Collector sem código (habilitada por meio do portal do Azure).

Próximas etapas

Exiba instantâneos no portal do Azure.
Solucione problemas do Depurador de Instantâneos.

Compartilhar via