Como configurar o monitoramento para o Azure Functions

As Funções do Azure podem ser integradas no Application Insights para lhe permitir monitorizar melhor as suas aplicações de funções. O Application Insights, um recurso do Azure Monitor, é um serviço extensível de Gerenciamento de Desempenho de Aplicativo (APM) que coleta dados gerados pelo seu aplicativo de função, incluindo informações que seu aplicativo grava em logs. A integração do Application Insights normalmente é habilitada quando seu aplicativo de função é criado. Se seu aplicativo não tiver a chave de instrumentação definida, você deve primeiro habilitar a integração do Application Insights.

Pode utilizar o Application Insights sem qualquer configuração personalizada. No entanto, a configuração padrão pode resultar em grandes volumes de dados. Se você estiver usando uma assinatura do Visual Studio Azure, poderá atingir seu limite de dados para o Application Insights. Para obter informações sobre os custos do Application Insights, consulte Faturamento do Application Insights. Para obter mais informações, consulte Soluções com alto volume de telemetria.

Neste artigo, você aprenderá a configurar e personalizar os dados que suas funções enviam para o Application Insights. Você pode definir configurações comuns de log no arquivo host.json . Por padrão, essas configurações também controlam os logs personalizados emitidos pelo seu código. No entanto, em alguns casos, esse comportamento pode ser desativado em favor de opções que lhe dão mais controle sobre o registro. Para obter mais informações, consulte Logs de aplicativos personalizados.

Logs de aplicativos personalizados

Por padrão, os logs de aplicativos personalizados que você grava são enviados para o host Functions, que os envia para o Application Insights na categoria Trabalhador. Algumas pilhas de idiomas permitem que você envie os logs diretamente para o Application Insights, o que lhe dá controle total sobre como os logs que você escreve são emitidos. Nesse caso, o pipeline de registro em log muda de worker -> Functions host -> Application Insights para worker -> Application Insights.

A tabela a seguir resume as opções de configuração disponíveis para cada pilha:

Quando você configura logs de aplicativos personalizados para serem enviados diretamente, o host não os emite mais e host.json não controla mais seu comportamento. Da mesma forma, as opções expostas por cada pilha se aplicam apenas a logs personalizados e não alteram o comportamento dos outros logs de tempo de execução descritos neste artigo. Nesse caso, para controlar o comportamento de todos os logs, talvez seja necessário fazer alterações em ambas as configurações.

Configurar categorias

O registador do Azure Functions inclui uma categoria para cada registo. A categoria indica que parte do código do runtime ou do código de função escreveu o registo. As categorias diferem entre a versão 1.x e versões posteriores.

Os nomes de categoria são atribuídos de forma diferente no Functions em comparação com outros frameworks .NET. Por exemplo, quando você usa ILogger<T> no ASP.NET, a categoria é o nome do tipo genérico. As funções C# também usam ILogger<T>, mas em vez de definir o nome do tipo genérico como uma categoria, o tempo de execução atribui categorias com base na fonte. Por exemplo:

• Às entradas relacionadas com a execução de uma função é atribuída uma categoria de Function.<FUNCTION_NAME>.
• As entradas criadas pelo código do usuário dentro da função, como ao chamar logger.LogInformation(), recebem uma categoria de Function.<FUNCTION_NAME>.User.

A tabela a seguir descreve as principais categorias de logs que o tempo de execução cria:

A coluna Tabela indica em qual tabela do Application Insights o log está gravado.

Configurar níveis de log

Um nível de log é atribuído a cada log. O valor é um inteiro que indica importância relativa:

A configuração do arquivo host.json determina a quantidade de registro em log que um aplicativo de funções envia para o Application Insights.

Para cada categoria, você indica o nível mínimo de log a ser enviado. As configurações de host.json variam dependendo da versão de tempo de execução do Functions.

Os exemplos a seguir definem o log com base nas seguintes regras:

• O nível de log padrão é definido para Warning evitar log excessivo para categorias imprevistas.
• Host.Aggregator e Host.Results são definidos para níveis mais baixos. Definir níveis de log muito altos (especialmente mais altos do que Information) pode resultar na perda de métricas e dados de desempenho.
• O registro em log para execuções de função é definido como Information. Se necessário, você pode substituir essa configuração no desenvolvimento local para Debug ou Trace.

{
  "logging": {
    "fileLoggingMode": "debugOnly",
    "logLevel": {
      "default": "Warning",
      "Host.Aggregator": "Trace",
      "Host.Results": "Information",
      "Function": "Information"
    }
  }
}

{
  "logger": {
    "categoryFilter": {
      "defaultLevel": "Warning",
      "categoryLevels": {
        "Host.Results": "Information",
        "Host.Aggregator": "Trace",
        "Function": "Information"
      }
    }
  }
}

Se host.json incluir vários logs que começam com a mesma cadeia de caracteres, os logs mais definidos serão correspondidos primeiro. Considere o exemplo a seguir que registra tudo no tempo de execução, exceto Host.Aggregator, no Error nível:

{
  "logging": {
    "fileLoggingMode": "debugOnly",
    "logLevel": {
      "default": "Information",
      "Host": "Error",
      "Function": "Error",
      "Host.Aggregator": "Information"
    }
  }
}

{
  "logger": {
    "categoryFilter": {
      "defaultLevel": "Information",
      "categoryLevels": {
        "Host": "Error",
        "Function": "Error",
        "Host.Aggregator": "Information"
      }
    }
  }
}

Você pode usar uma configuração de nível de log de None para impedir que quaisquer logs sejam gravados para uma categoria.

Configurar o agregador

Como observado na seção anterior, o tempo de execução agrega dados sobre execuções de função durante um período de tempo. O período padrão é de 30 segundos ou 1.000 execuções, o que ocorrer primeiro. Você pode definir essa configuração no arquivo host.json. Por exemplo:

{
    "aggregator": {
      "batchSize": 1000,
      "flushTimeout": "00:00:30"
    }
}

Configurar amostragem

O Application Insights tem um recurso de amostragem que pode protegê-lo contra a produção de muitos dados de telemetria em execuções concluídas em momentos de pico de carga. Quando a taxa de execuções recebidas excede um limiar especificado, o Application Insights começa a ignorar aleatoriamente algumas das execuções recebidas. A predefinição do número máximo de execuções por segundo é de 20 (cinco na versão 1.x). Você pode configurar a amostragem no host.json. Eis um exemplo:

{
  "logging": {
    "applicationInsights": {
      "samplingSettings": {
        "isEnabled": true,
        "maxTelemetryItemsPerSecond" : 20,
        "excludedTypes": "Request;Exception"
      }
    }
  }
}

{
  "applicationInsights": {
    "sampling": {
      "isEnabled": true,
      "maxTelemetryItemsPerSecond" : 5
    }
  }
}

Se seu projeto usa uma dependência do SDK do Application Insights para fazer o rastreamento manual de telemetria, você pode enfrentar um comportamento incomum se sua configuração de amostragem for diferente da configuração de amostragem em seu aplicativo de função. Nesses casos, use a mesma configuração de amostragem que o aplicativo de função. Para obter mais informações, consulte Amostragem no Application Insights.

Habilitar a coleta de consultas SQL

O Application Insights coleta automaticamente dados sobre dependências para solicitações HTTP, chamadas de banco de dados e para várias associações. Para obter mais informações, veja Dependências. Para chamadas SQL, o nome do servidor e do banco de dados é sempre coletado e armazenado, mas o texto da consulta SQL não é coletado por padrão. Você pode usar dependencyTrackingOptions.enableSqlCommandTextInstrumentation para habilitar o log de texto de consulta SQL usando as seguintes configurações (no mínimo) em seu arquivo host.json:

"logging": {
    "applicationInsights": {
        "enableDependencyTracking": true,    
        "dependencyTrackingOptions": {
            "enableSqlCommandTextInstrumentation": true
        }
    }
}

Para obter mais informações, consulte Rastreamento SQL avançado para obter consulta SQL completa.

Configurar logs do controlador de escala

Este recurso está em pré-visualização.

Você pode fazer com que o controlador de escala do Azure Functions emita logs para o Application Insights ou para o armazenamento de Blob para entender melhor as decisões que o controlador de escala está tomando para seu aplicativo de função.

Para habilitar esse recurso, adicione uma configuração de aplicativo nomeada SCALE_CONTROLLER_LOGGING_ENABLED às configurações do seu aplicativo de função. O seguinte valor da configuração deve estar no formato <DESTINATION>:<VERBOSITY>. Para obter mais informações, consulte a tabela a seguir:

Por exemplo, o seguinte comando da CLI do Azure ativa o log detalhado do controlador de escala para o Application Insights:

az functionapp config appsettings set --name <FUNCTION_APP_NAME> \
--resource-group <RESOURCE_GROUP_NAME> \
--settings SCALE_CONTROLLER_LOGGING_ENABLED=AppInsights:Verbose

Neste exemplo, substitua <FUNCTION_APP_NAME> e <RESOURCE_GROUP_NAME> pelo nome do seu aplicativo de função e o nome do grupo de recursos, respectivamente.

O seguinte comando da CLI do Azure desabilita o registro em log definindo a verbosidade como None:

az functionapp config appsettings set --name <FUNCTION_APP_NAME> \
--resource-group <RESOURCE_GROUP_NAME> \
--settings SCALE_CONTROLLER_LOGGING_ENABLED=AppInsights:None

Você também pode desabilitar o registro em log removendo a SCALE_CONTROLLER_LOGGING_ENABLED configuração usando o seguinte comando da CLI do Azure:

az functionapp config appsettings delete --name <FUNCTION_APP_NAME> \
--resource-group <RESOURCE_GROUP_NAME> \
--setting-names SCALE_CONTROLLER_LOGGING_ENABLED

Com o registro do controlador de escala habilitado, agora você pode consultar os logs do controlador de escala.

Ativar a integração do Application Insights

Para que um aplicativo de função envie dados para o Application Insights, ele precisa se conectar ao recurso do Application Insights usando apenas uma destas configurações do aplicativo:

Quando você cria seu aplicativo de função no portal do Azure a partir da linha de comando usando as Ferramentas Principais do Azure Functions ou o Visual Studio Code, a integração do Application Insights é habilitada por padrão. O recurso do Application Insights tem o mesmo nome do seu aplicativo de função e é criado na mesma região ou na região mais próxima.

Exigir autenticação do Microsoft Entra

Você pode usar a configuração para habilitar conexões com o Application Insights usando a APPLICATIONINSIGHTS_AUTHENTICATION_STRING autenticação do Microsoft Entra. Isso cria uma experiência de autenticação consistente em todos os pipelines do Application Insights, incluindo o Profiler e o Depurador de Instantâneo, bem como a partir do host do Functions e de agentes específicos do idioma.

O valor contém Authorization=AAD para uma identidade gerenciada atribuída ao sistema ou ClientId=<YOUR_CLIENT_ID>;Authorization=AAD para uma identidade gerenciada atribuída pelo usuário. A identidade gerenciada já deve estar disponível para o aplicativo de função, com uma função atribuída equivalente ao Monitoring Metrics Publisher. Para obter mais informações, consulte Autenticação do Microsoft Entra para Application Insights.

A APPLICATIONINSIGHTS_CONNECTION_STRING configuração ainda é necessária.

Nova aplicação de função no portal

Para revisar o recurso do Application Insights que está sendo criado, selecione-o para expandir a janela do Application Insights . Você pode alterar o nome do novo recurso ou selecionar um local diferente em uma geografia do Azure onde deseja armazenar seus dados.

Quando você seleciona Criar, um recurso do Application Insights é criado com seu aplicativo de função, que tem o conjunto nas configurações do APPLICATIONINSIGHTS_CONNECTION_STRING aplicativo. Está tudo pronto.

Adicionar a um aplicativo de função existente

Se um recurso do Application Insights não tiver sido criado com seu aplicativo de função, use as etapas a seguir para criar o recurso. Em seguida, você pode adicionar a cadeia de conexão desse recurso como uma configuração de aplicativo em seu aplicativo de função.

1. No portal do Azure, procure e selecione o aplicativo de função e, em seguida, selecione seu aplicativo de função.

2. Selecione a faixa O Application Insights não está configurado na parte superior da janela. Se você não vir esse banner, talvez seu aplicativo já tenha o Application Insights habilitado.

   

3. Expanda Alterar seu recurso e crie um recurso do Application Insights usando as configurações especificadas na tabela a seguir:

   Definição	Valor sugerido	Description
   Novo nome do recurso	Nome de aplicação exclusivo	É mais fácil utilizar o mesmo nome da aplicação de funções, que tem de ser exclusivo na subscrição.
   Location	Europa Ocidental	Se possível, use a mesma região do seu aplicativo de função ou a que estiver próxima a essa região.

   

4. Selecione Aplicar.

   O recurso do Application Insights é criado no mesmo grupo de recursos e subscrição da aplicação de funções. Depois que o recurso for criado, feche a janela do Application Insights .

5. Na sua aplicação de funções, expanda Definições e, em seguida, selecione Variáveis de ambiente. Na guia Configurações do aplicativo , se você vir uma configuração de aplicativo chamada APPLICATIONINSIGHTS_CONNECTION_STRING, a integração do Application Insights está habilitada para seu aplicativo de função em execução no Azure. Se essa configuração não existir, adicione-a usando sua cadeia de conexão do Application Insights como o valor.

Desativar o registo integrado

As primeiras versões do Functions usavam monitoramento integrado, o que não é mais recomendado. Ao habilitar o Application Insights, desabilite o log interno que usa o Armazenamento do Azure. O registro interno é útil para testes com cargas de trabalho leves, mas não se destina ao uso de produção de alta carga. Para monitoramento de produção, recomendamos o Application Insights. Se você usar o log interno na produção, o registro de log pode estar incompleto devido à limitação no Armazenamento do Azure.

Para desativar o registo incorporado, elimine a definição da AzureWebJobsDashboard aplicação. Para obter mais informações sobre como excluir configurações de aplicativo no portal do Azure, consulte a seção Configurações do aplicativo de Como gerenciar um aplicativo de função. Antes de excluir a configuração do aplicativo, verifique se nenhuma função existente no mesmo aplicativo de função usa a configuração para gatilhos ou associações do Armazenamento do Azure.

Soluções com alto volume de telemetria

Os aplicativos funcionais são uma parte essencial de soluções que podem causar grandes volumes de telemetria, como soluções de IoT, soluções orientadas a eventos rápidos, sistemas financeiros de alta carga e sistemas de integração. Nesse caso, você deve considerar uma configuração extra para reduzir custos, mantendo a observabilidade.

A telemetria gerada pode ser consumida em painéis em tempo real, alertas, diagnósticos detalhados e assim por diante. Dependendo de como a telemetria gerada é consumida, você precisa definir uma estratégia para reduzir o volume de dados gerados. Essa estratégia permite que você monitore, opere e diagnostique adequadamente seus aplicativos funcionais em produção. Considere as seguintes opções:

• Use a amostragem: Como mencionado anteriormente, a amostragem ajuda a reduzir drasticamente o volume de eventos de telemetria ingeridos, mantendo uma análise estatisticamente correta. Pode acontecer que, mesmo usando amostragem, você ainda obtenha um alto volume de telemetria. Inspecione as opções que a amostragem adaptável oferece a você. Por exemplo, defina o maxTelemetryItemsPerSecond como um valor que equilibra o volume gerado com suas necessidades de monitoramento. Lembre-se de que a amostragem de telemetria é aplicada por host que executa seu aplicativo de função.

• Nível de log padrão: use Warning ou Error como o valor padrão para todas as categorias de telemetria. Mais tarde, você pode decidir quais categorias deseja definir no Information nível, para que possa monitorar e diagnosticar suas funções corretamente.

• Ajuste a telemetria de suas funções: com o nível de log padrão definido como Error ou Warning, nenhuma informação detalhada de cada função é coletada (dependências, métricas personalizadas, eventos personalizados e rastreamentos). Para as funções que são fundamentais para o monitoramento da produção, defina uma entrada explícita para a categoria e defina-a Function.<YOUR_FUNCTION_NAME> como , para Informationque você possa coletar informações detalhadas. Para evitar a coleta de logs gerados pelo usuário no Information nível, defina a Function.<YOUR_FUNCTION_NAME>.User categoria para o Error nível ou Warning log.

• Categoria Host.Aggregator: Conforme descrito em configurar categorias, esta categoria fornece informações agregadas de invocações de funções. As informações dessa categoria são coletadas na tabela do Application Insights customMetrics e mostradas na guia Visão geral da função no portal do Azure. Dependendo de como você configura o agregador, considere que pode haver um atraso flushTimeout , determinado pela configuração, na telemetria coletada. Se você definir essa categoria para um valor diferente de , interromperá Informationa coleta de dados na customMetrics tabela e não exibirá métricas na guia Visão geral da função.

  A captura de tela a seguir mostra Host.Aggregator os dados de telemetria exibidos na guia Visão geral da função:

  

  A captura de tela a seguir mostra Host.Aggregator dados de telemetria na tabela do Application Insights customMetrics :

  

• Categoria Host.Results: Conforme descrito em configurar categorias, essa categoria fornece os logs gerados pelo tempo de execução indicando o sucesso ou a falha de uma chamada de função. As informações dessa categoria são coletadas na tabela Application Insights requests e mostradas na guia Monitor de função e em diferentes painéis do Application Insights (Desempenho, Falhas e assim por diante). Se você definir essa categoria para um valor diferente de Information, coletará apenas a telemetria gerada no nível de log definido (ou superior). Por exemplo, defini-lo para error resulta no rastreamento de dados de solicitações somente para execuções com falha.

  A captura de tela a seguir mostra os dados de telemetria Host.Results exibidos na guia Monitor de função:

  

  A captura de tela a seguir mostra Host.Results os dados de telemetria exibidos no painel de desempenho do Application Insights:

  

• Host.Aggregator vs Host.Results: Ambas as categorias fornecem bons insights sobre execuções de funções. Se necessário, você pode remover as informações detalhadas de uma dessas categorias, para que possa usar a outra para monitoramento e alerta. Exemplo:

{
  "version": "2.0",  
  "logging": {
    "logLevel": {
      "default": "Warning",
      "Function": "Error",
      "Host.Aggregator": "Error",
      "Host.Results": "Information", 
      "Function.Function1": "Information",
      "Function.Function1.User": "Error"
    },
    "applicationInsights": {
      "samplingSettings": {
        "isEnabled": true,
        "maxTelemetryItemsPerSecond": 1,
        "excludedTypes": "Exception"
      }
    }
  }
} 

{
  "logger": {
    "categoryFilter": {
      "defaultLevel": "Warning",
      "categoryLevels": {
        "Function": "Error",
        "Host.Aggregator": "Error",
        "Host.Results": "Information",
        "Host.Executor": "Warning"
      }
    }
  },
  "applicationInsights": {
    "sampling": {
      "isEnabled": true,
      "maxTelemetryItemsPerSecond" : 5
    }
  }
}

Com esta configuração:

• O valor padrão para todas as funções e categorias de telemetria é definido como Warning (incluindo as categorias Microsoft e Worker). Assim, por padrão, todos os erros e avisos gerados pelo tempo de execução e pelo log personalizado são coletados.

• O Function nível de log de categoria é definido como Error, portanto, para todas as funções, por padrão, apenas exceções e logs de erro são coletados. Dependências, métricas geradas pelo usuário e eventos gerados pelo usuário são ignorados.

• Para a Host.Aggregator categoria, como ela é definida para o Error nível de log, as informações agregadas de invocações de função não são reunidas customMetrics na tabela do Application Insights, e as informações sobre contagens de execuções (total, bem-sucedida e falhada) não são mostradas no painel de visão geral da função.

• Para a Host.Results categoria, todas as informações de execução do host são reunidas requests na tabela Application Insights. Todos os resultados das invocações são mostrados no painel Monitor da função e nos painéis do Application Insights.

• Para a função chamada Function1, definimos o nível de log como Information. Assim, para esta função concreta, toda a telemetria é reunida (dependência, métricas personalizadas e eventos personalizados). Para a mesma função, definimos a categoria (rastreamentos gerados pelo usuário) como , para Errorque apenas o Function1.User log de erros personalizado seja coletado.

  Nota

  A configuração por função não é suportada na v1.x do tempo de execução do Functions.

• A amostragem é configurada para enviar um item de telemetria por segundo por tipo, excluindo as exceções. Essa amostragem acontece para cada host de servidor que executa nosso aplicativo de função. Portanto, se tivermos quatro instâncias, essa configuração emitirá quatro itens de telemetria por segundo por tipo e todas as exceções que possam ocorrer.

  Nota

  As contagens métricas, como taxa de solicitação e taxa de exceção, são ajustadas para compensar a taxa de amostragem, de modo que mostrem valores aproximadamente corretos no Metric Explorer.

Substituindo a configuração de monitoramento em tempo de execução

Finalmente, pode haver situações em que você precise alterar rapidamente o comportamento de log de uma determinada categoria em produção e não queira fazer uma implantação inteira apenas para uma alteração no arquivo host.json . Para esses casos, você pode substituir os valores host.json.

Para configurar esses valores no nível de configurações do aplicativo (e evitar a reimplantação em apenas host.json alterações), você deve substituir valores específicos host.json criando um valor equivalente como uma configuração do aplicativo. Quando o tempo de execução encontra uma configuração de aplicativo no formato AzureFunctionsJobHost__path__to__setting, ele substitui a configuração equivalente host.json localizada no path.to.setting JSON. Quando expresso como uma configuração de aplicativo, um sublinhado duplo (__) substitui o ponto (.) usado para indicar a hierarquia JSON. Por exemplo, você pode usar as seguintes configurações de aplicativo para configurar níveis de log de função individuais no host.json.

Você pode substituir as configurações diretamente no painel Configuração do Aplicativo de Função do portal do Azure ou usando um script da CLI ou do PowerShell do Azure.

az functionapp config appsettings set --name MyFunctionApp --resource-group MyResourceGroup --settings "AzureFunctionsJobHost__logging__logLevel__Host__Aggregator=Information"

Update-AzFunctionAppSetting -Name MyAppName -ResourceGroupName MyResourceGroupName -AppSetting @{"AzureFunctionsJobHost__logging__logLevel__Host__Aggregator" = "Information"}

Monitorar aplicativos de função usando a verificação de integridade

Você pode usar o recurso Verificação de integridade para monitorar aplicativos funcionais nos planos Premium (Elastic Premium) e Dedicado (Serviço de Aplicativo). A verificação de integridade não é uma opção para o plano de consumo. Para saber como configurá-lo, consulte Monitorar instâncias do Serviço de Aplicativo usando a verificação de integridade. Seu aplicativo de função deve ter uma função de gatilho Path HTTP que responda com um código de status HTTP de 200 no mesmo ponto de extremidade configurado no parâmetro da verificação de integridade. Você também pode fazer com que essa função execute verificações extras para garantir que os serviços dependentes estejam acessíveis e funcionando.

Conteúdos relacionados

Para obter mais informações sobre monitoramento, consulte:

• Monitorizar as Funções do Azure
• Analisar dados de telemetria do Azure Functions no Application Insights
• Visão geral do Application Insights