Monitoramento do Gerenciamento de API

APLICA-SE A: todas as camadas do Gerenciamento de API

O Azure Monitor coleta e agrega métricas e logs do seu sistema para monitorar a disponibilidade, o desempenho e a resiliência e notificá-lo sobre problemas que afetam seu sistema. Você pode usar o portal do Azure, o PowerShell, a CLI do Azure, a API REST ou as bibliotecas de cliente para configurar e exibir dados de monitoramento.

Métricas e logs diferentes estão disponíveis para diferentes tipos de recursos. Este artigo descreve os tipos de dados de monitoramento que você pode coletar para esse serviço e as maneiras de analisar esses dados.

Coletar dados com o Azure Monitor

Esta tabela descreve como você pode coletar dados para monitorar seu serviço e o que você pode fazer com os dados depois de coletados:

Dados a serem coletados	Descrição	Como coletar e rotear os dados	Onde visualizar os dados	Tipos de dados compatíveis
Dados de métrica	As métricas são valores numéricos que descrevem um aspecto de um sistema em um ponto específico no tempo. As métricas podem ser agregadas usando algoritmos, comparadas a outras métricas e analisadas quanto a tendências ao longo do tempo.	- Coletado automaticamente em intervalos regulares. – Você pode rotear algumas métricas de plataforma para um workspace do Log Analytics para consultar outros dados. Verifique a configuração de exportação para o DS de cada métrica para ver se você pode usar uma configuração de diagnóstico para rotear os dados da métrica.	Metrics Explorer	Métricas do Gerenciamento de API do Azure com suporte do Azure Monitor
Dados do log de recursos	Os logs são eventos registrados do sistema com um carimbo de data/hora. Os logs podem conter diferentes tipos de dados e ser texto estruturado ou de forma livre. Você pode rotear dados de log de recursos para workspaces do Log Analytics para consulta e análise.	Crie uma configuração de diagnóstico para coletar e rotear dados de log de recursos.	Log Analytics	Dados de log de recurso do Gerenciamento de API do Azure com suporte do Azure Monitor
Dados do log de atividades	O log de atividades do Azure Monitor fornece informações sobre eventos no nível da assinatura. O log de atividades inclui informações sobre a alteração de um recurso ou a inicialização de uma máquina virtual.	- Coletado automaticamente. - Crie uma configuração de diagnóstico para um workspace do Log Analytics sem custo.	Log de atividades

Para obter a lista de todos os dados compatíveis com o Azure Monitor, consulte:

• Métricas com suporte do Azure Monitor
• Logs de recursos com suporte do Azure Monitor

Monitoramento interno do Gerenciamento de API

O gerenciamento de API do Azure tem os seguintes recursos de monitoramento internos.

Obter análises de API no Gerenciamento de API do Azure

O Gerenciamento de API do Azure fornece análises de suas APIs para que você possa analisar seu uso e desempenho. Use análises para o monitoramento de alto nível e a resolução de problemas em suas APIs. Para obter outros recursos de monitoramento, incluindo métricas quase em tempo real e registros de recursos para diagnóstico e auditoria, consulte Tutorial: Monitorar as APIs publicadas.

Observação

Atualmente, esse recurso não está disponível em workspaces.

• O Gerenciamento de API fornece análises usando um painel baseado no Azure Monitor. O painel agrega dados em um workspace do Log Analytics do Azure.
• Nas camadas de serviço clássicas do Gerenciamento de API, sua instância do Gerenciamento de API também inclui análises herdadas integradas no portal do Microsoft Azure, e os dados de análise podem ser acessados usando a API REST do Gerenciamento de API. Dados semelhantes são mostrados no painel baseado no Azure Monitor e na análise interna.

Importante

O painel baseado no Azure Monitor é a maneira recomendada de acessar os dados de análise. A análise interna (clássica) não está disponível nas camadas v2.

Com a análise de API, analise o uso e o desempenho das APIs em sua instância do Gerenciamento de API em várias dimensões, inclusive:

• Hora
• painel Geografia do app's selecionado
• APIs
• Operações de API
• Produtos
• Assinaturas
• Usuários
• Solicitações

A análise de API fornece dados sobre solicitações, incluindo solicitações com falha e não autorizadas. Os valores de geografia são baseados no mapeamento de endereços IP. Pode haver um atraso na disponibilidade dos dados de análise.

Painel de controle baseado no Azure Monitor

Para usar o painel baseado no Azure Monitor, você precisa de um workspace do Log Analytics como fonte de dados para logs de gateway de Gerenciamento de API.

Se precisar configurar um, veja a seguir as etapas resumidas para enviar logs de gateway para um workspace do Log Analytics. Para obter mais informações, consulte Tutorial: Monitorar as APIs publicadas. Esse procedimento é uma configuração única.

1. No portal do Azure, navegue até a instância do Gerenciamento de API.
2. No menu à esquerda, em Monitoramento, selecione Configurações de diagnóstico>+ Adicionar configuração de diagnóstico.
3. Digite um nome descritivo para a configuração de diagnóstico.
4. Em Logs, selecione Logs relacionados ao ApiManagement Gateway.
5. Em Detalhes do destino, selecione Enviar para o Log Analytics e selecione um workspace do Log Analytics na mesma assinatura ou em outra. Se precisar criar um espaço de trabalho, consulte Criar um workspace do Log Analytics.
6. Verifique se Recurso específico esteja selecionado como tabela de destino.
7. Selecione Salvar.

Importante

Um novo workspace do Log Analytics pode levar até 2 horas para começar a receber dados. Um workspace existente deve começar a receber dados em aproximadamente 15 minutos.

Acessar o painel

Depois que um workspace do Log Analytics estiver configurado, acesse o painel baseado no Azure Monitor para analisar o uso e o desempenho de suas APIs.

1. No portal do Azure, navegue até a instância do Gerenciamento de API.
2. No menu à esquerda, em Monitoramento, selecione Análises. O painel de análise é aberto.
3. Selecione um intervalo de tempo para os dados.
4. Selecione uma categoria de relatório para os dados de análise, como Linha do tempo, Geografia e assim por diante.

Análise incorporada herdada

Em determinadas camadas de serviço de Gerenciamento de API, a análise interna (também chamada de análise herdada ou análise clássica) também está disponível no portal do Azure e os dados de análise podem ser acessados usando a API REST de Gerenciamento de API.

Para acessar a análise interna (clássica) no portal do Azure:

1. No portal do Azure, navegue até a instância do Gerenciamento de API.
2. No menu à esquerda, em Monitoramento, selecione Análise (clássico).
3. Selecione um intervalo de tempo para os dados ou insira um do tipo personalizado.
4. Selecione uma categoria de relatório para os dados de análise, como Linha do tempo, Geografia e assim por diante.
5. Opcionalmente, filtre o relatório por uma ou mais outras categorias.

Use as operações de Relatórios na API REST do Gerenciamento de API para recuperar e filtrar os dados de análise de sua instância do Gerenciamento de API.

As operações disponíveis retornam os registros de relatório por API, geografia, operações de API, produto, solicitação, assinatura, tempo ou usuário.

Habilitar o registro em log do uso do portal do desenvolvedor no Gerenciamento de API do Azure

Essa seção mostra como habilitar os logs do Azure Monitor para auditoria e solução de problemas de uso do portal do desenvolvedor do Gerenciamento de API. Quando habilitados por meio de uma configuração de diagnóstico, os logs coletam informações sobre as solicitações recebidas e processadas pelo portal do desenvolvedor.

Os logs de uso do portal do desenvolvedor incluem dados sobre a atividade no portal do desenvolvedor, incluindo:

• Ações de autenticação do usuário, como entrada e saída
• Exibições de detalhes da API, detalhes da operação de API e produtos
• Teste de API no console de teste interativo

Habilitar a configuração de diagnóstico para logs do portal do desenvolvedor

Para definir uma configuração de diagnóstico para logs de uso do portal do desenvolvedor:

1. No portal do Azure, navegue até a instância do Gerenciamento de API.

2. No menu à esquerda, em Monitoramento, selecione Configurações de Diagnóstico>+ Adicionar configuração de diagnóstico.

   

3. Na página Configuração de diagnóstico, insira ou selecione detalhes para a configuração:

   1. Nome da configuração de diagnóstico: insira um nome descritivo.
   2. Grupos de categorias: opcionalmente, faça uma seleção para seu cenário.
   3. Em Categorias: selecione Logs relacionados ao uso do Portal do Desenvolvedor. Opcionalmente, selecione outras categorias conforme necessário.
   4. Em Detalhes de destino, selecione uma ou mais opções e especifique detalhes para o destino. Por exemplo, arquive os logs para uma conta de armazenamento ou transmita-os para um hub de eventos. Para obter mais informações, consulte as configurações de diagnóstico no Azure Monitor.
   5. Selecione Salvar.

Exibir dados do log de diagnóstico

Dependendo do destino de log escolhido, pode levar alguns minutos para que os dados apareçam.

Se você enviar logs para uma conta de armazenamento, poderá acessar os dados no portal do Azure e baixá-los para análise.

1. No portal do Azure, navegue até o destino da conta de armazenamento.
2. No menu à esquerda, selecione Navegador de Armazenamento.
3. Em contêineres de Blob, selecione insights-logs-developerportalauditlogs.
4. Navegue até o contêiner para obter os logs em sua instância de Gerenciamento de API. Os logs são particionados em intervalos de 1 hora.
5. Para recuperar os dados para análise adicional, selecione Baixar.

Usar as ferramentas do Azure Monitor para analisar os dados

Essas ferramentas do Azure Monitor estão disponíveis no portal do Azure para ajudar você a analisar os dados de monitoramento:

• Alguns serviços do Azure têm um painel de monitoramento interno no portal do Azure. Esses painéis são chamados de insights e você pode encontrá-los na seção insights do Azure Monitor no portal do Azure.

• Gerenciador de métricas permite exibir e analisar métricas para recursos do Azure. Para obter mais informações sobre essa ferramenta, consulte Analisar métricas com o explorador de métricas do Azure Monitor.

• O Log Analytics permite consultar e analisar dados de log usando a KQL (linguagem de consulta Kusto). Para obter mais informações, veja Introdução às consultas de log no Azure Monitor.

• O portal do Azure tem uma interface do usuário para exibição e pesquisas básicas do log de atividades. Para fazer uma análise mais aprofundada, roteie os dados para os logs do Azure Monitor e execute consultas mais complexas no Log Analytics.

• O Application Insights monitora a disponibilidade, o desempenho e o uso de seus aplicativos Web, para que você possa identificar e diagnosticar erros sem esperar que um usuário os relate. O
  Application Insights inclui pontos de conexão com várias ferramentas de desenvolvimento e se integra ao Visual Studio para dar suporte aos seus processos de DevOps. Para obter mais informações, confira Monitoramento de aplicativos do Serviço de Aplicativo.

As ferramentas que permitem uma visualização mais complexa incluem:

• Painéis, que permitem que você combine diferentes tipos de dados em um único painel no portal do Azure.
• Pastas de Trabalho, relatórios personalizáveis que você pode criar no portal do Azure. As pastas de trabalho podem incluir texto, métricas e consultas de log.
• Grafana, uma ferramenta de plataforma aberta que oferece excelência em termos de painéis operacionais. Você pode usar o Grafana para criar painéis que incluem dados de várias fontes além do Azure Monitor.
• Power BI, um serviço de análises corporativas que fornece visualizações interativas nas diversas fontes de dados. Você pode configurar o Power BI para importar dados de log automaticamente do Azure Monitor a fim de aproveitar essas visualizações.

Visualizar dados de monitoramento do Gerenciamento de API usando um painel do Espaço Gerenciado para Grafana

Você pode usar o Espaço Gerenciado do Azure para Grafana para visualizar dados de monitoramento do Gerenciamento de API coletados em um workspace do Log Analytics. Use um painel de Gerenciamento de API predefinido para visualização em tempo real de logs e métricas coletados da instância de Gerenciamento de API.

• Saiba mais sobre o Espaço Gerenciado do Azure para Grafana
• Saiba mais sobre observabilidade no Gerenciamento de API do Azure

Na sua instância do Gerenciamento de API:

• Para visualizar logs de recursos e métricas do Gerenciamento de API, defina as configurações de diagnóstico para coletar logs de recursos e enviá-los para um workspace do Log Analytics.

• Para visualizar dados detalhados sobre solicitações para o gateway de Gerenciamento de API, integre a instância de Gerenciamento de API ao Application Insights.

  Observação

  Para visualizar dados em um único painel, defina o workspace do Log Analytics para as configurações de diagnóstico e a instância do Application Insights no mesmo grupo de recursos que a instância de Gerenciamento de API.

No seu workspace do Grafana Gerenciado:

• Para criar uma instância e um workspace de Espaço Gerenciado para Grafana, confira o guia de início rápido para o portal ou a CLI do Azure.
• A instância de Espaço Gerenciado para Grafana deve estar na mesma assinatura que a instância de Gerenciamento de API.
• Quando criado, o workspace do Grafana recebe automaticamente uma identidade gerenciada do Microsoft Entra, que recebe a função de Leitor de Monitoramento na assinatura. Essa abordagem oferece acesso imediato ao Azure Monitor no novo workspace do Grafana sem a necessidade de definir permissões manualmente. Saiba mais sobre como configurar fontes de dados para o Espaço Gerenciado para Grafana.

Primeiro, importe o painel de Gerenciamento de API para o workspace de Gerenciamento do Grafana.

Para importar o painel:

1. Acesse o workspace do Espaço Gerenciado do Azure para Grafana. No portal, na página Visão geral da instância de Espaço Gerenciado para Grafana, selecione o link Ponto de Extremidade.
2. No workspace do Espaço Gerenciado para Grafana, acesse Painéis>Procurar>Importar.
3. Na página Importar, em Importar usando o grafana.com, insira 16604 e selecione Carregar.
4. Selecione uma fonte de dados do Azure Monitor, examine ou atualize as outras opções e selecione Importar.

Para usar o painel do Gerenciamento de API:

1. No workspace do Espaço Gerenciado para Grafana, acesse Painéis>Procurar e selecione o painel de Gerenciamento de API.
2. Nas listas suspensas na parte superior, faça seleções para a instância de Gerenciamento de API. Se configurado, selecione uma instância do Application Insights e um workspace do Log Analytics.

Revise as visualizações padrão no painel, que aparece semelhante à captura de tela a seguir:

Exportar dados do Azure Monitor

Você pode exportar dados do Azure Monitor para outras ferramentas usando:

• Métricas: Use a API REST para métricas para extrair dados de métricas do banco de dados de métricas do Azure Monitor. Para obter mais informações, confira Referência da API REST do Azure Monitor.

• Logs: Use a API REST ou as bibliotecas de cliente associadas.

• A exportação de dados do espaço de trabalho Log Analytics.

Para começar a usar a API REST do Azure Monitor, confira Passo a passo da API REST de monitoramento do Azure.

Usar consultas Kusto para analisar dados de log

Você pode analisar os dados de log do Azure Monitor usando a linguagem de consulta Kusto (KQL). Para obter mais informações, confira Consultas de log no Azure Monitor.

Usar alertas do Azure Monitor para notificá-lo sobre problemas

Os alertas do Azure Monitor permitem que você identifique e resolva problemas em seu sistema e notifique proativamente quando condições específicas são encontradas em seus dados de monitoramento antes que seus clientes as percebam. Você pode receber alertas sobre qualquer fonte de dados de log ou métrica na plataforma de dados do Azure Monitor. Há tipos diferentes de alertas do Azure Monitor dependendo dos serviços que você está monitorando e dos dados de monitoramento que está coletando. Consulte Escolhendo o tipo certo de regra de alerta.

Para saber como configurar uma regra de alerta no Gerenciamento de API do Azure, consulte Configurar uma regra de alerta.

Para obter exemplos de alertas comuns para recursos do Azure, confira Amostra de consultas de alerta de logs.

Implementando alertas em escala

No caso de alguns serviços, você pode monitorar em larga escala aplicando a mesma regra de alerta de métricas a vários recursos do mesmo tipo que existem na mesma região do Azure. Os Alertas de Linha de Base do Azure Monitor (AMBA) fornecem um método semiautomatizado de implementação de alertas de métrica de plataforma importantes, painéis e diretrizes em escala.

Obter recomendações personalizadas usando o Assistente do Azure

Para alguns serviços, se ocorrerem condições críticas ou alterações iminentes durante operações de recurso, um alerta será exibido na página de Visão geral do serviço no portal. Você pode encontrar mais informações e correções recomendadas para o alerta nas Recomendações do assistente em Monitoramento no menu à esquerda. Durante as operações normais, nenhuma recomendação do assistente será exibida.

Para obter mais informações sobre o Assistente do Azure, confira Visão geral do Assistente do Azure.

Conteúdo relacionado

• Referência de dados de monitoramento do Gerenciamento de API
• Monitorar recursos do Azure com o Azure Monitor