Monitorar o desempenho do Serviço de Aplicativo do AzureMonitor Azure App Service performance

• 08/06/2020
• 14 minutos para o fim da leitura
• • 
  • 

Habilitar o monitoramento em seus ASP.NET e ASP.NET Core aplicativos Web com base em execução em serviços de Azure app agora está mais fácil do que nunca.Enabling monitoring on your ASP.NET and ASP.NET Core based web applications running on Azure App Services is now easier than ever. Enquanto anteriormente você precisava instalar manualmente uma extensão de site, a extensão/agente mais recente agora é compilado na imagem do serviço de aplicativo por padrão.Whereas previously you needed to manually install a site extension, the latest extension/agent is now built into the app service image by default. Este artigo o orientará na habilitação do monitoramento de Application Insights, bem como no fornecimento de diretrizes preliminares para automatizar o processo para implantações em larga escala.This article will walk you through enabling Application Insights monitoring as well as provide preliminary guidance for automating the process for large-scale deployments.

Habilitar o Application InsightsEnable Application Insights

Há duas maneiras de habilitar o monitoramento de aplicativos para aplicativos hospedados de serviços Azure Apps:There are two ways to enable application monitoring for Azure App Services hosted applications:

• Monitoramento de aplicativo baseado em agente (ApplicationInsightsAgent).Agent-based application monitoring (ApplicationInsightsAgent).

  • Esse método é o mais fácil de habilitar e nenhuma configuração avançada é necessária.This method is the easiest to enable, and no advanced configuration is required. Ele é geralmente chamado de monitoramento de "tempo de execução".It is often referred to as "runtime" monitoring. Para Azure App serviços, recomendamos, no mínimo, habilitar esse nível de monitoramento e, em seguida, com base em seu cenário específico, você pode avaliar se é necessário um monitoramento mais avançado por meio da instrumentação manual.For Azure App Services we recommend at a minimum enabling this level of monitoring, and then based on your specific scenario you can evaluate whether more advanced monitoring through manual instrumentation is needed.

• Instrumentar manualmente o aplicativo por meio do código instalando o SDK do Application insights.Manually instrumenting the application through code by installing the Application Insights SDK.

  • Essa abordagem é muito mais personalizável, mas requer a adição de uma dependência nos pacotes NuGet do SDK Application insights.This approach is much more customizable, but it requires adding a dependency on the Application Insights SDK NuGet packages. Esse método, também significa que você precisa gerenciar as atualizações para a versão mais recente dos pacotes por conta própria.This method, also means you have to manage the updates to the latest version of the packages yourself.

  • Se você precisar fazer chamadas à API personalizada para acompanhar eventos/dependências não capturadas por padrão com o monitoramento baseado em agente, você precisará usar esse método.If you need to make custom API calls to track events/dependencies not captured by default with agent-based monitoring, you would need to use this method. Confira o artigo API para eventos e métricas personalizados para saber mais.Check out the API for custom events and metrics article to learn more. Essa também é a única opção com suporte para cargas de trabalho baseadas em Linux.This is also currently the only supported option for Linux based workloads.

Habilitar o monitoramento baseado em agenteEnable agent-based monitoring

Habilitar monitoramento do lado do clienteEnable client-side monitoring

Automatizar monitoramentoAutomate monitoring

Para habilitar a coleta de telemetria com Application Insights, somente as configurações do aplicativo precisam ser definidas:In order to enable telemetry collection with Application Insights, only the Application settings need to be set:

Definições de configurações do aplicativoApplication settings definitions

Configurações de aplicativo do serviço de aplicativo com Azure Resource ManagerApp Service Application settings with Azure Resource Manager

As configurações de aplicativo para serviços de aplicativos podem ser gerenciadas e configuradas com modelos de Azure Resource Manager.Application settings for App Services can be managed and configured with Azure Resource Manager templates. Esse método pode ser usado ao implantar novos recursos do serviço de aplicativo com a automação Azure Resource Manager ou para modificar as configurações de recursos existentes.This method can be used when deploying new App Service resources with Azure Resource Manager automation, or for modifying the settings of existing resources.

A estrutura básica do JSON de configurações do aplicativo para um serviço de aplicativo está abaixo:The basic structure of the application settings JSON for an app service is below:

      "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 obter um exemplo de um modelo de Azure Resource Manager com configurações de aplicativo definidas para Application Insights, esse modelo pode ser útil, especificamente a seção que começa na linha 238.For an example of an Azure Resource Manager template with Application settings configured for Application Insights, this template can be helpful, specifically the section starting on line 238.

Automatize a criação de um recurso Application Insights e vincule ao seu serviço de aplicativo recém-criado.Automate the creation of an Application Insights resource and link to your newly created App Service.

Para criar um modelo de Azure Resource Manager com todas as configurações de Application Insights padrão configuradas, inicie o processo como se estivesse criando um novo aplicativo Web com Application Insights habilitado.To create an Azure Resource Manager template with all the default Application Insights settings configured, begin the process as if you were going to create a new Web App with Application Insights enabled.

Selecionar Opções de automaçãoSelect Automation options

Essa opção gera o modelo de Azure Resource Manager mais recente com todas as configurações necessárias definidas.This option generates the latest Azure Resource Manager template with all required settings configured.

Abaixo está um exemplo, substitua todas as instâncias de AppMonitoredSite pelo nome do seu site:Below is a sample, replace all instances of AppMonitoredSite with your site name:

{
    "resources": [
        {
            "name": "[parameters('name')]",
            "type": "Microsoft.Web/sites",
            "properties": {
                "siteConfig": {
                    "appSettings": [
                        {
                            "name": "APPINSIGHTS_INSTRUMENTATIONKEY",
                            "value": "[reference('microsoft.insights/components/AppMonitoredSite', '2015-05-01').InstrumentationKey]"
                        },
                        {
                            "name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
                            "value": "[reference('microsoft.insights/components/AppMonitoredSite', '2015-05-01').ConnectionString]"
                        },
                        {
                            "name": "ApplicationInsightsAgent_EXTENSION_VERSION",
                            "value": "~2"
                        }
                    ]
                },
                "name": "[parameters('name')]",
                "serverFarmId": "[concat('/subscriptions/', parameters('subscriptionId'),'/resourcegroups/', parameters('serverFarmResourceGroup'), '/providers/Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]",
                "hostingEnvironment": "[parameters('hostingEnvironment')]"
            },
            "dependsOn": [
                "[concat('Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]",
                "microsoft.insights/components/AppMonitoredSite"
            ],
            "apiVersion": "2016-03-01",
            "location": "[parameters('location')]"
        },
        {
            "apiVersion": "2016-09-01",
            "name": "[parameters('hostingPlanName')]",
            "type": "Microsoft.Web/serverfarms",
            "location": "[parameters('location')]",
            "properties": {
                "name": "[parameters('hostingPlanName')]",
                "workerSizeId": "[parameters('workerSize')]",
                "numberOfWorkers": "1",
                "hostingEnvironment": "[parameters('hostingEnvironment')]"
            },
            "sku": {
                "Tier": "[parameters('sku')]",
                "Name": "[parameters('skuCode')]"
            }
        },
        {
            "apiVersion": "2015-05-01",
            "name": "AppMonitoredSite",
            "type": "microsoft.insights/components",
            "location": "West US 2",
            "properties": {
                "ApplicationId": "[parameters('name')]",
                "Request_Source": "IbizaWebAppExtensionCreate"
            }
        }
    ],
    "parameters": {
        "name": {
            "type": "string"
        },
        "hostingPlanName": {
            "type": "string"
        },
        "hostingEnvironment": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "sku": {
            "type": "string"
        },
        "skuCode": {
            "type": "string"
        },
        "workerSize": {
            "type": "string"
        },
        "serverFarmResourceGroup": {
            "type": "string"
        },
        "subscriptionId": {
            "type": "string"
        }
    },
    "$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0"
}

Habilitando por meio do PowerShellEnabling through PowerShell

Para habilitar o monitoramento de aplicativos por meio do PowerShell, somente as configurações de aplicativo subjacentes precisam ser alteradas.In order to enable the application monitoring through PowerShell, only the underlying application settings need to be changed. Abaixo está um exemplo, que habilita o monitoramento de aplicativos para um site chamado "AppMonitoredSite" no grupo de recursos "AppMonitoredRG" e configura os dados a serem enviados para a chave de instrumentação "012345678-ABCD-EF01-2345-6789abcd".Below is a sample, which enables application monitoring for a website called "AppMonitoredSite" in the resource group "AppMonitoredRG", and configures data to be sent to the "012345678-abcd-ef01-2345-6789abcd" instrumentation key.

$app = Get-AzWebApp -ResourceGroupName "AppMonitoredRG" -Name "AppMonitoredSite" -ErrorAction Stop
$newAppSettings = @{} # case-insensitive hash map
$app.SiteConfig.AppSettings | %{$newAppSettings[$_.Name] = $_.Value} # preserve non Application Insights application settings.
$newAppSettings["APPINSIGHTS_INSTRUMENTATIONKEY"] = "012345678-abcd-ef01-2345-6789abcd"; # set the Application Insights instrumentation key
$newAppSettings["APPLICATIONINSIGHTS_CONNECTION_STRING"] = "InstrumentationKey=012345678-abcd-ef01-2345-6789abcd"; # set the Application Insights connection string
$newAppSettings["ApplicationInsightsAgent_EXTENSION_VERSION"] = "~2"; # enable the ApplicationInsightsAgent
$app = Set-AzWebApp -AppSettings $newAppSettings -ResourceGroupName $app.ResourceGroup -Name $app.Name -ErrorAction Stop

Atualizar a extensão/agente de monitoramentoUpgrade monitoring extension/agent

Atualizando das versões 2.8.9 e upUpgrading from versions 2.8.9 and up

A atualização da versão 2.8.9 ocorre automaticamente, sem nenhuma ação adicional.Upgrading from version 2.8.9 happens automatically, without any additional actions. Os novos bits de monitoramento são entregues em segundo plano ao serviço de aplicativo de destino e, na reinicialização do aplicativo, serão coletados.The new monitoring bits are delivered in the background to the target app service, and on application restart they will be picked up.

Para verificar qual versão da extensão você está executando, visite http://yoursitename.scm.azurewebsites.net/ApplicationInsightsTo check which version of the extension you are running visit http://yoursitename.scm.azurewebsites.net/ApplicationInsights

Atualização das versões 1.0.0-2.6.5Upgrade from versions 1.0.0 - 2.6.5

A partir da versão 2.8.9, a extensão de site pré-instalada é usada.Starting with version 2.8.9 the pre-installed site extension is used. Se você for uma versão anterior, poderá atualizar por meio de uma das duas maneiras:If you are an earlier version, you can update via one of two ways:

• Atualizar habilitando por meio do portal.Upgrade by enabling via the portal. (Mesmo que você tenha a extensão de Application Insights para Azure App Service instalado, a interface do usuário mostrará apenas o botão habilitar .(Even if you have the Application Insights extension for Azure App Service installed, the UI shows only Enable button. Nos bastidores, a extensão de site particular antigo será removida.)Behind the scenes, the old private site extension will be removed.)

• Atualizar por meio do PowerShell:Upgrade through PowerShell:

  1. Defina as configurações do aplicativo para habilitar a extensão de site pré-instalada ApplicationInsightsAgent.Set the application settings to enable the pre-installed site extension ApplicationInsightsAgent. Consulte habilitando por meio do PowerShell.See Enabling through PowerShell.
  2. Remova manualmente a extensão de site particular chamada Application Insights extensão para Azure App serviço.Manually remove the private site extension named Application Insights extension for Azure App Service.

Se a atualização for feita a partir de uma versão anterior à 2.5.1, verifique se as DLLs ApplicationInsigths são removidas da pasta bin do aplicativo consulte as etapas de solução de problemas.If the upgrade is done from a version prior to 2.5.1, check that the ApplicationInsigths dlls are removed from the application bin folder see troubleshooting steps.

Solução de problemasTroubleshooting

Abaixo está nosso guia de solução de problemas passo a passo para o monitoramento baseado em extensão/agente para aplicativos .NET e .NET Core em execução em serviços de Azure App.Below is our step-by-step troubleshooting guide for extension/agent based monitoring for .NET and .NET Core based applications running on Azure App Services.

1. Verifique se o aplicativo é monitorado via ApplicationInsightsAgent .Check that the application is monitored via ApplicationInsightsAgent.

   • Verifique se ApplicationInsightsAgent_EXTENSION_VERSION a configuração do aplicativo está definida com um valor de "~ 2".Check that ApplicationInsightsAgent_EXTENSION_VERSION app setting is set to a value of "~2".

2. Verifique se o aplicativo atende aos requisitos a serem monitorados.Ensure that the application meets the requirements to be monitored.

   • Navegue para https://yoursitename.scm.azurewebsites.net/ApplicationInsightsBrowse to https://yoursitename.scm.azurewebsites.net/ApplicationInsights

   

   • Confirme se o Application Insights Extension Status é Pre-Installed Site Extension, version 2.8.12.1527, is running.Confirm that the Application Insights Extension Status is Pre-Installed Site Extension, version 2.8.12.1527, is running.

   • Se não estiver em execução, siga as instruções de monitoramento habilitar Application insightsIf it is not running, follow the enable Application Insights monitoring instructions

   • Confirme se a origem do status existe e se tem a seguinte aparência: Status source D:\home\LogFiles\ApplicationInsights\status\status_RD0003FF0317B6_4248_1.jsonConfirm that the status source exists and looks like: 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.If a similar value is not present, it means the application is not currently running or is not supported. 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.To ensure that the application is running, try manually visiting the application url/application endpoints, which will allow the runtime information to become available.

   • Confirme se IKeyExists é trueConfirm that IKeyExists is true

     • Se for false , adicione APPINSIGHTS_INSTRUMENTATIONKEY e APPLICATIONINSIGHTS_CONNECTION_STRING com seu GUID iKey às configurações do aplicativo.If it is false, add APPINSIGHTS_INSTRUMENTATIONKEY and APPLICATIONINSIGHTS_CONNECTION_STRING with your ikey guid to your application settings.

   • Confirme se não há entradas para AppAlreadyInstrumented , AppContainsDiagnosticSourceAssembly e AppContainsAspNetTelemetryCorrelationAssembly .Confirm that there are no entries for AppAlreadyInstrumented, AppContainsDiagnosticSourceAssembly, and AppContainsAspNetTelemetryCorrelationAssembly.

     • Se qualquer uma dessas entradas existir, remova os seguintes pacotes do seu aplicativo: Microsoft.ApplicationInsights , System.Diagnostics.DiagnosticSource e Microsoft.AspNet.TelemetryCorrelation .If any of these entries exist, remove the following packages from your application: Microsoft.ApplicationInsights, System.Diagnostics.DiagnosticSource, and Microsoft.AspNet.TelemetryCorrelation.

A tabela a seguir fornece uma explicação mais detalhada do que esses valores significam, suas causas subjacentes e correções recomendadas:The table below provides a more detailed explanation of what these values mean, their underlying causes, and recommended fixes:

Não há suporte para APPINSIGHTS_JAVASCRIPT_ENABLED e urlCompressionAPPINSIGHTS_JAVASCRIPT_ENABLED and urlCompression is not supported

Se você usar APPINSIGHTS_JAVASCRIPT_ENABLED = true nos casos em que o conteúdo é codificado, poderá obter erros como:If you use APPINSIGHTS_JAVASCRIPT_ENABLED=true in cases where content is encoded, you might get errors like:

• erro de regravação de URL 500500 URL rewrite error
• 500,53 erro de módulo de regravação de URL com regras de regravação de mensagem de saída não podem ser aplicadas quando o conteúdo da resposta HTTP é codificado (' gzip ').500.53 URL rewrite module error with message Outbound rewrite rules cannot be applied when the content of the HTTP response is encoded ('gzip').

Isso ocorre porque a configuração do aplicativo APPINSIGHTS_JAVASCRIPT_ENABLED está sendo definida como true e a codificação de conteúdo está presente ao mesmo tempo.This is due to the APPINSIGHTS_JAVASCRIPT_ENABLED application setting being set to true and content-encoding being present at the same time. Este cenário ainda não tem suporte.This scenario is not supported yet. A solução alternativa é remover APPINSIGHTS_JAVASCRIPT_ENABLED das configurações do aplicativo.The workaround is to remove APPINSIGHTS_JAVASCRIPT_ENABLED from your application settings. Infelizmente, isso significa que se a instrumentação de JavaScript do lado do cliente/navegador ainda for necessária, as referências manuais do SDK serão necessárias para suas páginas da Web.Unfortunately this means that if client/browser-side JavaScript instrumentation is still required, manual SDK references are needed for your webpages. Siga as instruções para instrumentação manual com o SDK do JavaScript.Please follow the instructions for manual instrumentation with the JavaScript SDK.

Para obter as informações mais recentes sobre a extensão/agente de Application Insights, Confira as notas de versão.For the latest information on the Application Insights agent/extension, check out the release notes.

O site padrão implantado com aplicativos Web não dá suporte ao monitoramento automático do lado do clienteDefault website deployed with web apps does not support automatic client-side monitoring

Quando você cria um aplicativo Web com os ASP.NET tempos de execução do ou .NET Core no Azure app Services, ele implanta uma única página HTML estática como um site inicial.When you create a web app with the ASP.NET or .NET Core runtimes in Azure App Services it deploys a single static HTML page as a starter website. A página da Web estática também carrega um site gerenciado do .NET no IIS.The static webpage also loads a .NET managed web part in IIS. Isso 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.This allows for testing codeless server-side monitoring, but does not support automatic client-side monitoring.

Se você quiser testar o monitoramento do lado do cliente e do servidor sem código para ASP.NET ou ASP.NET Core em um aplicativo Web do Azure App Services, recomendamos seguir os guias oficiais para criar um aplicativo Web do ASP.NET Core e criar um aplicativo Web do ASP.NET Framework e, em seguida, usar as instruções no artigo atual para habilitar o monitoramento.If you wish to test out codeless server and client-side monitoring for ASP.NET or ASP.NET Core in a Azure App Services web app we recommend following the official guides for creating a ASP.NET Core web app and creating an ASP.NET Framework web app and then use the instructions in the current article to enable monitoring.

Não há suporte para PHP e WordPressPHP and WordPress are not supported

Não há suporte para sites PHP e WordPress.PHP and WordPress sites are not supported. Atualmente, não há um SDK/agente com suporte oficialmente para o monitoramento do lado do servidor dessas cargas de trabalho.There is currently no officially supported SDK/agent for server-side monitoring of these workloads. No entanto, instrumentar manualmente as transações do lado do cliente em um site do PHP ou do WordPress adicionando o JavaScript do lado do cliente às suas páginas da Web pode ser feito usando o SDK do JavaScript.However, manually instrumenting client-side transactions on a PHP or WordPress site by adding the client-side javascript to your web pages can be accomplished by using the JavaScript SDK.

Cadeia de conexão e chave de instrumentaçãoConnection string and instrumentation key

Quando o monitoramento sem código está sendo usado, somente a cadeia de conexão é necessária.When codeless monitoring is being used, only the connection string is required. No entanto, ainda recomendamos definir a chave de instrumentação para preservar a compatibilidade com versões anteriores do SDK quando a instrumentação manual está sendo executada.However, we still recommend setting the instrumentation key to preserve backwards compatibility with older versions of the SDK when manual instrumentation is being performed.

Notas de versãoRelease notes

Para obter as atualizações mais recentes e as correções de bugs, consulte as notas de versão.For the latest updates and bug fixes consult the release notes.

Próximas etapasNext steps

• Executar o criador de perfil em seu aplicativo ativo.Run the profiler on your live app.
• Azure Functions – monitorar o Azure Functions com o Application InsightsAzure Functions - monitor Azure Functions with Application Insights
• Permita que o diagnóstico do Azure seja enviado ao Application Insights.Enable Azure diagnostics to be sent to Application Insights.
• Monitore as métricas de integridade do serviço para se certificar de que o serviço esteja disponível e responsivo.Monitor service health metrics to make sure your service is available and responsive.
• Receba notificações de alerta sempre que ocorrerem eventos operacionais ou métricas ultrapassarem um limite.Receive alert notifications whenever operational events happen or metrics cross a threshold.
• Use o Application Insights para aplicativos JavaScript e páginas Web para obter a telemetria do cliente dos navegadores que visitam uma página da Web.Use Application Insights for JavaScript apps and web pages to get client telemetry from the browsers that visit a web page.
• Configure testes de disponibilidade da Web para ser alertado se o seu site for desativado.Set up Availability web tests to be alerted if your site is down.