Monitorar o gerenciamento de API

APLICA-SE A: Todas as camadas de gerenciamento de API

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

Diferentes métricas e logs 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 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 recolher	Description	Como recolher e encaminhar os dados	Onde visualizar os dados	Dados suportados
Dados métricos	As métricas são valores numéricos que descrevem um aspeto de um sistema em um determinado momento. As métricas podem ser agregadas usando algoritmos, em comparação com outras métricas, e analisadas quanto às tendências ao longo do tempo.	- Recolhido automaticamente a intervalos regulares. - Você pode rotear algumas métricas da plataforma para um espaço de trabalho do Log Analytics para consultar outros dados. Verifique a configuração de exportação DS para cada métrica para ver se você pode usar uma configuração de diagnóstico para rotear os dados da métrica.	Explorador de métricas	Métricas de Gerenciamento de API do Azure suportadas pelo Azure Monitor
Dados do log de recursos	Os logs são eventos do sistema gravados 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 espaços de trabalho 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 recursos do Gerenciamento de API do Azure suportados pelo Azure Monitor
Dados do registo de atividades	O log de atividades do Azure Monitor fornece informações sobre eventos no nível de assinatura. O registo de atividades inclui informações como quando um recurso é modificado ou uma máquina virtual é iniciada.	- Recolhido automaticamente. - Crie uma configuração de diagnóstico para um espaço de trabalho do Log Analytics gratuitamente.	Registo de atividades

Para obter a lista de todos os dados suportados pelo Azure Monitor, consulte:

• Métricas suportadas do Azure Monitor
• Logs de recursos suportados do Azure Monitor

Monitoramento integrado para gerenciamento de API

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

Obter a análise de APIs na Gestão de API do Azure

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

Nota

Atualmente, esse recurso não está disponível em espaços de trabalho.

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

Importante

O painel baseado no Azure Monitor é a maneira recomendada de acessar dados de análise. A análise integrada (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 de Gerenciamento de API em várias dimensões, incluindo:

• Hora
• Geografia
• APIs
• Operações de API
• Produtos
• Subscrições
• Utilizadores
• Pedidos do

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

Painel baseado no Azure Monitor

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

Se você precisar configurar um, a seguir estão algumas etapas breves para enviar logs de gateway para um espaço de trabalho do Log Analytics. Para obter mais informações, consulte Tutorial: Monitorar APIs publicadas. Este procedimento é uma configuração única.

1. No portal do Azure, navegue até sua instância de Gerenciamento de API.
2. No menu à esquerda, em Monitoramento, selecione Configurações de diagnóstico>+ Adicionar configuração de diagnóstico.
3. Insira 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 espaço de trabalho do Log Analytics na mesma assinatura ou em uma assinatura diferente. Se você precisar criar um espaço de trabalho, consulte Criar um espaço de trabalho do Log Analytics.
6. Verifique se Específico do recurso está selecionado como a tabela de destino.
7. Selecione Guardar.

Importante

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

Aceda ao painel

Depois que um espaço de trabalho do Log Analytics for 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é sua instância de Gerenciamento de API.
2. No menu à esquerda, em Monitoramento, selecione Análise. O painel de análise é aberto.
3. Selecione um intervalo de tempo para os dados.
4. Selecione uma categoria de relatório para dados de análise, como Linha do tempo, Geografia e assim por diante.

Análise integrada legada

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 analíticos podem ser acessados usando a API REST de Gerenciamento de API.

Para aceder à análise incorporada (clássica) no portal do Azure:

1. No portal do Azure, navegue até sua instância de Gerenciamento de API.
2. No menu à esquerda, em Monitoramento, selecione Analytics (clássico).
3. Selecione um intervalo de tempo para os dados ou insira um intervalo de tempo personalizado.
4. Selecione uma categoria de relatório para 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 de gerenciamento de API para recuperar e filtrar dados de análise para sua instância de gerenciamento de API.

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

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

Esta 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
• Visualizações de detalhes da API, detalhes da operação da 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é sua instância de 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 o 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 do destino, selecione uma ou mais opções e especifique detalhes para o destino. Por exemplo, arquive logs em uma conta de armazenamento ou transmita-os para um hub de eventos. Para obter mais informações, consulte Configurações de diagnóstico no Azure Monitor.
   5. Selecione Guardar.

Exibir dados de log de diagnóstico

Dependendo do destino do 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 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 posterior, selecione Download.

Usar as ferramentas do Azure Monitor para analisar os dados

Estas ferramentas do Azure Monitor estão disponíveis no portal do Azure para ajudá-lo a analisar 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.

• O explorador de métricas permite que você exiba e analise métricas para recursos do Azure. Para obter mais informações, 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 linguagem de consulta Kusto (KQL). Para obter mais informações, consulte Introdução às consultas de log no Azure Monitor.

• O portal do Azure tem uma interface de usuário para exibição e pesquisas básicas do log de atividades. Para fazer uma análise mais aprofundada, encaminhe 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 para várias ferramentas de desenvolvimento e integra-se ao Visual Studio para dar suporte aos seus processos de DevOps. Para obter mais informações, consulte Monitoramento de aplicativos para o Serviço de Aplicativo.

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

• Painéis que permitem combinar 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 se destaca em dashboards operacionais. Você pode usar o Grafana para criar painéis que incluem dados de várias fontes diferentes do Azure Monitor.
• Power BI, um serviço de análise de negócios que fornece visualizações interativas em várias fontes de dados. Você pode configurar o Power BI para importar automaticamente dados de log do Azure Monitor para aproveitar essas visualizações.

Visualizar os dados de monitorização da Gestão de API com um dashboard do Managed Grafana

Você pode usar o Azure Managed Grafana para visualizar os dados de monitoramento do Gerenciamento de API coletados em um espaço de trabalho do Log Analytics. Use um painel de Gerenciamento de API pré-criado para visualização em tempo real de logs e métricas coletados de sua instância de Gerenciamento de API.

• Saiba mais sobre o Azure Managed Grafana
• Saiba mais sobre a observabilidade no Gerenciamento de API do Azure

Na sua instância de Gerenciamento de API:

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

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

  Nota

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

No seu espaço de trabalho Managed Grafana:

• Para criar uma instância e um espaço de trabalho do Grafana gerenciado, consulte o início rápido do portal ou da CLI do Azure.
• A instância do Managed Grafana deve estar na mesma assinatura que a instância de Gerenciamento de API.
• Quando criado, o espaço de trabalho Grafana recebe automaticamente uma identidade gerenciada do Microsoft Entra, à qual é atribuída a função Leitor de Monitor na assinatura. Essa abordagem oferece acesso imediato ao Azure Monitor a partir do novo espaço de trabalho do Grafana sem a necessidade de definir permissões manualmente. Saiba mais sobre como configurar fontes de dados para o Managed Grafana.

Primeiro, importe o painel de Gerenciamento de API para seu espaço de trabalho do Management Grafana.

Para importar o painel:

1. Vá para seu espaço de trabalho do Azure Managed Grafana. No portal, na página Visão geral da sua instância do Managed Grafana, selecione o link Ponto de extremidade .
2. No espaço de trabalho Grafana gerenciado, vá para Dashboards>Browse>Import.
3. Na página Importar, em Importar via grafana.com, digite 16604 e selecione Carregar.
4. Selecione uma fonte de dados do Azure Monitor, revise ou atualize as outras opções e selecione Importar.

Para usar o painel Gerenciamento de API:

1. No espaço de trabalho Managed Grafana, vá para Dashboards>Browse e selecione seu painel de Gerenciamento de API.
2. Nos menus suspensos na parte superior, faça seleções para sua instância de Gerenciamento de API. Se configurado, selecione uma instância do Application Insights e um espaço de trabalho do Log Analytics.

Analise as visualizações padrão no painel, que são semelhantes à 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, consulte 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 do Log Analytics.

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

Usar consultas Kusto para analisar dados de log

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

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

Os alertas do Azure Monitor permitem-lhe identificar e resolver problemas no seu sistema e notificá-lo proativamente quando são encontradas condições específicas nos seus dados de monitorização antes que os seus clientes as percebam. Você pode alertar sobre qualquer fonte de dados de métrica ou log na plataforma de dados do Azure Monitor. Há diferentes tipos de alertas do Azure Monitor, dependendo dos serviços que você está monitorando e dos dados de monitoramento que você está coletando. Consulte Escolher o tipo correto de regra de alerta.

Para ver 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, consulte Consultas de alerta de log de exemplo.

Implementação de alertas em escala

Para alguns serviços, você pode monitorar em escala aplicando a mesma regra de alerta de métrica 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 métricos de plataforma importantes, painéis e diretrizes em escala.

Obtenha recomendações personalizadas usando o Azure Advisor

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

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

Conteúdos relacionados

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