Compartilhar via

Habilitar o monitoramento de aplicativos no Serviço de Aplicativo do Azure para aplicativos .NET, Node.js, Python e Java

A autoinstrumentação, também conhecida como monitoramento de runtime, é a maneira mais fácil de ativar o Application Insights para o Azure App Service sem a necessidade de alterações de código ou configurações avançadas. Com base em seu cenário específico, avalie se você precisa de monitoramento mais avançado por meio de instrumentação manual.

Observação

Em 31 de março de 31, 2025, o suporte à ingestão de chave de instrumentação será encerrado. A ingestão de chave de instrumentação continuará funcionando, mas não forneceremos mais atualizações ou suporte para o recurso. Faça a transição para cadeias de conexão para aproveitar os novos recursos.

Habilitar o Application Insights

Importante

Se o monitoramento de instrumentação automática e a instrumentação baseada em SDK manual forem detectados, somente as configurações de instrumentação manual serão respeitadas. Essa disposição impede que dados duplicados sejam enviados. Para saber mais, confira solução de problemas.

Observação

Autoinstrumentação no portal do Azure

  1. Selecione Application Insights no menu de navegação à esquerda do serviço de aplicativo e selecione Habilitar.

    Captura de tela que mostra a guia Application Insights com Habilitar selecionado.

  2. Crie um recurso ou selecione um recurso do Application Insights existente para o aplicativo.

    Observação

    Quando você seleciona OK para criar um novo recurso, é solicitado que você aplique as configurações de monitoramento. Selecionar Continuar vincula seu novo recurso do Application Insights ao serviço de aplicativo. Em seguida, o serviço de aplicativo é reiniciado.

    Captura de tela que mostra a lista suspensa Alterar seu recurso.

  3. Depois de especificar qual recurso usar, você poderá escolher como deseja que o Application Insights colete dados por plataforma para seu aplicativo. as opções da coleção ASP.NET Core são recomendadas ou desabilitadas.

    Captura de tela que mostra a seção de instrumentação do aplicativo.

Atualizar manualmente o agente/extensão de monitoramento

Atualização das versões 2.8.9 e superiores

A atualização da versão 2.8.9 ocorre automaticamente, sem nenhuma ação adicional. Os novos bits de monitoramento são entregues em segundo plano ao serviço de aplicativo de destino e são coletados na reinicialização do aplicativo.

Para verificar qual versão da extensão você está executando, acesse https://yoursitename.scm.azurewebsites.net/ApplicationInsights.

Captura de tela que mostra o caminho da URL para verificar a versão da extensão que você está executando.

Atualização das versões 1.0.0-2.6.5

A partir da versão 2.8.9, a extensão de site pré-instalada é usada. Se você estiver com uma versão anterior, poderá fazer a atualização por meio de uma das duas maneiras:

  • Atualize habilitando por meio do portal do Azure: mesmo se você tiver a extensão do Application Insights para o Serviço de Aplicativo instalada, a interface do usuário mostrará apenas o botão Habilitar . Nos bastidores, a extensão de site particular antigo é removida.

  • Atualizar por meio do PowerShell:

    1. Defina as configurações do aplicativo para habilitar a extensão de site ApplicationInsightsAgent pré-instalada. Para obter mais informações, consulte Habilitar por meio do PowerShell.
    2. Remova manualmente a extensão de site privado chamada extensão Application Insights para o Serviço de Aplicativo do Azure.

Se a atualização for feita de uma versão anterior à 2.5.1, verifique se as DLLs ApplicationInsights foram removidas da pasta bin do aplicativo. Para obter mais informações, consulte Solução de problemas.

Configurar o agente/extensão de monitoramento

No momento, não oferecemos opções para configurar a extensão de monitoramento do ASP.NET Core.

Habilitar monitoramento do lado do cliente

O monitoramento do lado do cliente é habilitado por padrão para aplicativos do ASP.NET Core com coleção recomendada , independentemente de a configuração APPINSIGHTS_JAVASCRIPT_ENABLED do aplicativo estar presente.

Se quiser desabilitar o monitoramento do lado do cliente:

  1. Selecione Configurações>.

  2. Nas configurações do aplicativo, crie uma nova configuração de aplicativo com as seguintes informações:

    • Nome: APPINSIGHTS_JAVASCRIPT_ENABLED
    • Valor: false

  3. Salve as configurações. Reinicie o aplicativo.

Automatizar monitoramento

Para habilitar a coleta de telemetria com o Application Insights, somente as seguintes configurações do aplicativo precisam ser definidas:

Captura de tela que mostra as configurações do aplicativo do Serviço de Aplicativo com as configurações do Application Insights.

Definições de configurações do aplicativo

Nome da configuração do aplicativo Definição Valor
ApplicationInsightsAgent_EXTENSION_VERSION Extensão principal, que controla o monitoramento do tempo de execução. ~2 para Windows ou ~3 para Linux
XDT_MicrosoftApplicationInsights_Mode No modo padrão, somente os recursos essenciais são habilitados para garantir um desempenho ideal. disabled ou recommended.
XDT_MicrosoftApplicationInsights_PreemptSdk Somente para aplicativos ASP.NET Core. Habilita a interoperabilidade (interoperação) com o SDK do Application Insights. Carrega a extensão lado a lado com o SDK e a usa para enviar telemetria. (Desabilita o SDK do Application Insights.) 1

Configurações de aplicativo do Serviço de Aplicativo com o Azure Resource Manager

As configurações de aplicativo para o Serviço de Aplicativo do Azure podem ser gerenciadas e configuradas com modelos do Azure Resource Manager. Você pode usar esse método ao implantar novos recursos de Serviço de Aplicativo com a automação do Resource Manager ou modificar as configurações dos recursos existentes.

A estrutura básica das configurações do aplicativo JSON para um recurso do Serviço de Aplicativo:

      "resources": [
        {
          "name": "appsettings",
          "type": "config",
          "apiVersion": "2015-08-01",
          "dependsOn": [
            "[resourceId('Microsoft.Web/sites', variables('webSiteName'))]"
          ],
          "tags": {
            "displayName": "Application Insights Settings"
          },
          "properties": {
            "key1": "value1",
            "key2": "value2"
          }
        }
      ]

Para criar um modelo do Resource Manager com as configurações do Application Insights padrão, inicie o processo como se estivesse criando um novo aplicativo Web com o Application Insights habilitado.

  1. No portal do Azure, crie um novo recurso de Aplicativo Web com as informações desejadas. Habilite o Application Insights na guia Monitor + Seguro .

  2. Vá para Examinar + criar e, em seguida, selecione Baixar um modelo para automação. Essa opção gera o modelo do Resource Manager mais recente com todas as configurações necessárias definidas.

    Captura de tela que mostra o menu de criação do aplicativo Web do Serviço de Aplicativo.

Observação

O modelo de exemplo a seguir é para um aplicativo .NET 8 (LTS) em execução no Windows. Ele usa marcadores de posição my-monitored-web-app para o nome do aplicativo e aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e para o ID da assinatura.

Não recomendamos copiar e usá-lo diretamente. Em vez disso, gere seu próprio modelo com base nas instruções acima.


Expandir para exibir o modelo de exemplo 
{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "subscriptionId": {
            "type": "string"
        },
        "resourceGroupName": {
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "hostingPlanName": {
            "type": "string"
        },
        "serverFarmResourceGroup": {
            "type": "string"
        },
        "alwaysOn": {
            "type": "bool"
        },
        "ftpsState": {
            "type": "string"
        },
        "autoGeneratedDomainNameLabelScope": {
            "type": "string"
        },
        "sku": {
            "type": "string"
        },
        "skuCode": {
            "type": "string"
        },
        "workerSize": {
            "type": "string"
        },
        "workerSizeId": {
            "type": "string"
        },
        "numberOfWorkers": {
            "type": "string"
        },
        "currentStack": {
            "type": "string"
        },
        "phpVersion": {
            "type": "string"
        },
        "netFrameworkVersion": {
            "type": "string"
        }
    },
    "variables": {},
    "resources": [
        {
            "apiVersion": "2022-03-01",
            "name": "[parameters('name')]",
            "type": "Microsoft.Web/sites",
            "location": "[parameters('location')]",
            "tags": null,
            "dependsOn": [
                "microsoft.insights/components/my-monitored-web-app",
                "[concat('Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]"
            ],
            "properties": {
                "name": "[parameters('name')]",
                "siteConfig": {
                    "appSettings": [
                        {
                            "name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
                            "value": "[reference('microsoft.insights/components/my-monitored-web-app', '2015-05-01').ConnectionString]"
                        },
                        {
                            "name": "ApplicationInsightsAgent_EXTENSION_VERSION",
                            "value": "~2"
                        },
                        {
                            "name": "XDT_MicrosoftApplicationInsights_Mode",
                            "value": "default"
                        }
                    ],
                    "metadata": [
                        {
                            "name": "CURRENT_STACK",
                            "value": "[parameters('currentStack')]"
                        }
                    ],
                    "phpVersion": "[parameters('phpVersion')]",
                    "netFrameworkVersion": "[parameters('netFrameworkVersion')]",
                    "alwaysOn": "[parameters('alwaysOn')]",
                    "ftpsState": "[parameters('ftpsState')]"
                },
                "serverFarmId": "[concat('/subscriptions/', parameters('subscriptionId'),'/resourcegroups/', parameters('serverFarmResourceGroup'), '/providers/Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]",
                "clientAffinityEnabled": true,
                "virtualNetworkSubnetId": null,
                "httpsOnly": true,
                "publicNetworkAccess": "Enabled",
                "autoGeneratedDomainNameLabelScope": "[parameters('autoGeneratedDomainNameLabelScope')]"
            },
            "resources": [
                {
                    "type": "Microsoft.Web/sites/basicPublishingCredentialsPolicies",
                    "apiVersion": "2022-09-01",
                    "name": "[concat(parameters('name'), '/scm')]",
                    "properties": {
                        "allow": true
                    },
                    "dependsOn": [
                        "[resourceId('Microsoft.Web/Sites', parameters('name'))]"
                    ]
                },
                {
                    "type": "Microsoft.Web/sites/basicPublishingCredentialsPolicies",
                    "apiVersion": "2022-09-01",
                    "name": "[concat(parameters('name'), '/ftp')]",
                    "properties": {
                        "allow": true
                    },
                    "dependsOn": [
                        "[resourceId('Microsoft.Web/Sites', parameters('name'))]"
                    ]
                }
            ]
        },
        {
            "apiVersion": "2018-11-01",
            "name": "[parameters('hostingPlanName')]",
            "type": "Microsoft.Web/serverfarms",
            "location": "[parameters('location')]",
            "kind": "",
            "tags": null,
            "dependsOn": [],
            "properties": {
                "name": "[parameters('hostingPlanName')]",
                "workerSize": "[parameters('workerSize')]",
                "workerSizeId": "[parameters('workerSizeId')]",
                "numberOfWorkers": "[parameters('numberOfWorkers')]",
                "zoneRedundant": false
            },
            "sku": {
                "Tier": "[parameters('sku')]",
                "Name": "[parameters('skuCode')]"
            }
        },
        {
            "apiVersion": "2020-02-02-preview",
            "name": "my-monitored-web-app",
            "type": "microsoft.insights/components",
            "location": "centralus",
            "tags": null,
            "dependsOn": [
                "newWorkspaceTemplate"
            ],
            "properties": {
                "ApplicationId": "[parameters('name')]",
                "Request_Source": "IbizaWebAppExtensionCreate",
                "Flow_Type": "Redfield",
                "Application_Type": "web",
                "WorkspaceResourceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/DefaultResourceGroup-CUS/providers/Microsoft.OperationalInsights/workspaces/DefaultWorkspace-aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e-CUS"
            }
        },
        {
            "type": "Microsoft.Resources/deployments",
            "apiVersion": "2021-04-01",
            "name": "newWorkspaceTemplate",
            "resourceGroup": "DefaultResourceGroup-CUS",
            "subscriptionId": "[parameters('subscriptionId')]",
            "properties": {
                "mode": "Incremental",
                "template": {
                    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
                    "contentVersion": "1.0.0.0",
                    "parameters": {},
                    "variables": {},
                    "resources": [
                        {
                            "apiVersion": "2020-08-01",
                            "name": "DefaultWorkspace-aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e-CUS",
                            "type": "Microsoft.OperationalInsights/workspaces",
                            "location": "centralus",
                            "properties": {}
                        }
                    ]
                }
            }
        }
    ]
}

Ativar através do Powershell

Para habilitar o monitoramento de aplicativos por meio do PowerShell, somente as configurações de aplicativo subjacentes devem ser alteradas. O exemplo a seguir habilita o monitoramento de aplicativos para um site chamado my-monitored-web-app no grupo de recursos my-resource-group. Ele configura os dados a serem enviados para a InstrumentationKey=012345678-abcd-ef01-2345-6789abcd cadeia de conexão.

Observação

Recomendamos que você use o módulo Az PowerShell do Azure para interagir com o Azure. Para começar, consulte Instalar o Azure PowerShell. Para saber como migrar para o módulo do Az PowerShell, confira Migrar o Azure PowerShell do AzureRM para o Az.

Observação

Para Windows, defina ApplicationInsightsAgent_EXTENSION_VERSION como ~2.

Para Linux, defina ApplicationInsightsAgent_EXTENSION_VERSION como ~3.

$app = Get-AzWebApp -ResourceGroupName "my-resource-group" -Name "my-monitored-web-app" -ErrorAction Stop
$newAppSettings = @{} # Case-insensitive hash map
$app.SiteConfig.AppSettings | %{$newAppSettings[$_.Name] = $_.Value} # Preserve non-Application-Insights application settings.
$newAppSettings["APPLICATIONINSIGHTS_CONNECTION_STRING"] = "InstrumentationKey=aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e"; # Set the Application Insights connection string
$newAppSettings["ApplicationInsightsAgent_EXTENSION_VERSION"] = "~3"; # Enable the ApplicationInsightsAgent.
$app = Set-AzWebApp -AppSettings $newAppSettings -ResourceGroupName $app.ResourceGroup -Name $app.Name -ErrorAction Stop

Perguntas frequentes

Esta seção fornece respostas para perguntas comuns.

O que o Application Insights modifica no meu projeto?

Os detalhes dependem do tipo de projeto. A lista a seguir é um exemplo para um aplicativo Web.

  • Adiciona arquivos ao seu projeto:

    • ApplicationInsights.config
    • ai.js

  • Instala pacotes NuGet:

    • API do Application Insights: a API principal
    • API do Application Insights para Aplicativos Web: usada para enviar telemetria do servidor
    • API do Application Insights para Aplicativos JavaScript: usada para enviar telemetria do cliente

  • Inclui assemblies em pacotes:

    • Microsoft.ApplicationInsights
    • Microsoft.ApplicationInsights.Platform

  • Insere itens em:

    • Web.config
    • packages.config

  • Insere snippets no código do cliente e do servidor para inicializá-los com a ID de recurso do Application Insights. Por exemplo, em um aplicativo MVC, o código é inserido na página principal Views/Shared/_Layout.cshtml. Somente para novos projetos, você adiciona o Application Insights a um projeto existente manualmente.

Qual a diferença entre as métricas padrão das métricas do serviço Application Insights vs Aplicativo do Azure?

O Application Insights coleta a telemetria das solicitações que chegaram no aplicativo. Se a falha ocorreu no WebApps/WebServer e a solicitação não chegou ao aplicativo do usuário, o Application Insights não terá telemetrias sobre ele.

A duração da serverresponsetime calculada pelo Application Insights não corresponderá necessariamente ao tempo de resposta do servidor observado pelos aplicativos Web. Esse comportamento ocorre porque o Application Insights só conta a duração quando a solicitação realmente chega ao aplicativo do usuário. Se a solicitação estiver presa ou enfileirada no WebServer, o tempo de espera será incluído nas métricas dos aplicativos Web, mas não nas métricas do Application Insights.

Solução de problemas

Testar a conectividade entre o host do aplicativo e o serviço de ingestão

Os SDKs e agentes do Application Insights enviam telemetria para serem ingeridos como chamadas REST para nossos pontos de extremidade de ingestão. Você pode testar a conectividade do servidor Web ou do computador host do aplicativo para os pontos de extremidade do serviço de ingestão usando clientes REST brutos do PowerShell ou comandos curl. Consulte Como solucionar problemas de ausência de telemetria de aplicativos no Azure Monitor Application Insights.

Observação

Quando você cria um aplicativo Web com os tempos de execução do ASP.NET Core no Serviço de Aplicativo, ele implanta uma única página HTML estática como um site inicial. Não recomendamos que você solucione um problema com o modelo padrão. Implante um aplicativo antes de solucionar um problema.

Telemetria ausente

Windows

  1. Verifique se a configuração do aplicativo ApplicationInsightsAgent_EXTENSION_VERSION está definida em um valor de ~2.

  2. Navegue até https://yoursitename.scm.azurewebsites.net/ApplicationInsights.

    Captura de tela que mostra o link acima da página de resultados.

    • Confirme se o Status da Extensão do Application Insights é Pre-Installed Site Extension, version 2.8.x.xxxx, is running.

      Se ele não estiver em execução, siga as instruções na seção Habilitar o monitoramento do Application Insights.

    • Confirme se a origem do status existe e se parece com Status source D:\home\LogFiles\ApplicationInsights\status\status_RD0003FF0317B6_4248_1.json.

      Se um valor semelhante não estiver presente, significa que o aplicativo não está em execução no momento ou não tem suporte. Para garantir que o aplicativo esteja em execução, tente visitar manualmente os pontos de extremidade do aplicativo/URL do aplicativo, o que permitirá que as informações de tempo de execução fiquem disponíveis.

    • Confirme se iKeyExists é True. Se está False, adicione APPINSIGHTS_INSTRUMENTATIONKEY e APPLICATIONINSIGHTS_CONNECTION_STRING com seu GUID iKey às configurações do aplicativo.

    • Caso seu aplicativo se refira a qualquer pacote do Application Insights, a habilitação da integração do Serviço de Aplicativo pode não ter efeito e os dados podem não aparecer no Application Insights. Um exemplo seria se você instrumentou anteriormente ou tentou instrumentar seu aplicativo com o SDK do ASP.NET Core. Para corrigir o problema, no portal do Azure, ative Interoperabilidade com o SDK do Application Insights.

      Importante

      Essa funcionalidade está em versão prévia.

      Captura de tela que mostra a configuração de interoperabilidade habilitada.

      Os dados são enviados usando uma abordagem sem código, mesmo se o SDK do Application Insights foi originalmente usado ou se houve uma tentativa de usá-lo.

      Importante

      Se o aplicativo usou o SDK do Application Insights para enviar alguma telemetria, a telemetria será desabilitada. Em outras palavras, a telemetria personalizada (por exemplo, um método Track*()) e as configurações personalizadas (por exemplo, amostragem) serão desabilitadas.

Linux

  1. Verifique se a configuração do aplicativo ApplicationInsightsAgent_EXTENSION_VERSION está definida em um valor de ~3.

  2. Navegue até https://your site name.scm.azurewebsites.net/ApplicationInsights.

  3. Neste site, confirme:

    • A origem do status existe e se parece com Status source /var/log/applicationinsights/status_abcde1234567_89_0.json.
    • O valor Auto-Instrumentation enabled successfully é exibido. Se não houver um valor semelhante presente, significa que o aplicativo não está em execução ou não tem suporte. Para garantir que o aplicativo esteja em execução, tente visitar manualmente os pontos de extremidade do aplicativo/URL do aplicativo, o que permitirá que as informações de tempo de execução fiquem disponíveis.
    • IKeyExists é True. Se está False, adicione APPINSIGHTS_INSTRUMENTATIONKEY e APPLICATIONINSIGHTS_CONNECTION_STRING com seu GUID iKey às configurações do aplicativo.

    Captura de tela que mostra a página da Web de status da instrumentação automática.

O site padrão implantado com aplicativos Web não dá suporte ao monitoramento automático do lado do cliente

Quando você cria um aplicativo Web com os tempos de execução do ASP.NET Core no Serviço de Aplicativo do Azure, ele implanta uma única página HTML estática como um site inicial. A página da Web estática também carrega um site ASP.NET gerenciado no IIS. Esse comportamento permite o teste do monitoramento do lado do servidor sem código, mas não dá suporte ao monitoramento automático do lado do cliente.

Se você quiser testar o servidor sem código e o monitoramento do lado do cliente para ASP.NET Core em um aplicativo Web do Serviço de Aplicativo, recomendamos seguir os guias oficiais para criar um aplicativo Web ASP.NET Core. Em seguida, use as instruções no artigo atual para habilitar o monitoramento.

Não há suporte para PHP, nem para WordPress

Não há suporte para sites em PHP e WordPress. Atualmente, não há um SDK/agente com suporte oficial para o monitoramento do lado do servidor dessas cargas de trabalho. Para acompanhar transações do lado do cliente em um site PHP ou WordPress, adicione o JavaScript do lado do cliente às suas páginas da Web usando o SDK do JavaScript.

A tabela a seguir fornece uma explicação do que esses valores significam, de suas causas subjacentes e das correções recomendadas.

Valor do problema Explicação Correção
AppAlreadyInstrumented:true Esse valor indica que a extensão detectou que algum aspecto do SDK já está presente no aplicativo e ela volta atrás. Uma referência a Microsoft.ApplicationInsights.AspNetCore ou Microsoft.ApplicationInsights pode causar esse valor. Remova as referências. Algumas dessas referências são adicionadas por padrão de determinados modelos do Visual Studio. As versões mais antigas do Visual Studio referenciam Microsoft.ApplicationInsights.
AppAlreadyInstrumented:true A presença da DLL Microsoft.ApplicationsInsights na pasta do aplicativo de uma implantação anterior também pode causar este valor. Limpe a pasta do aplicativo para garantir que essas DLLs sejam removidas. Verifique o diretório bin do aplicativo local e o diretório wwwroot no Serviço de Aplicativo. (Para verificar o diretório wwwroot do aplicativo Web do Serviço de Aplicativo, selecione Ferramentas Avançadas (Kudu) >Console de depuração>CMD>home\site\wwwroot).
IKeyExists:false Esse valor indica que a chave de instrumentação não está presente na configuração do aplicativo APPINSIGHTS_INSTRUMENTATIONKEY. As causas possíveis incluem remover acidentalmente os valores ou esquecer de definir os valores no script de automação. Verifique se a configuração está presente nas configurações do aplicativo do serviço de aplicativo.