Compartilhar via

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

  • Artigo

APLICA-SE A: Desenvolvedor | Básico | Básico v2 | Standard | Standard v2 | Premium

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.

Captura de tela da análise de API no portal.

Sobre a análise de API

  • 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 equivalentes são mostrados no painel baseado no Azure Monitor e na análise integrada.

Importante

  • O painel baseado no Azure Monitor é a maneira recomendada de acessar os dados de análise.
  • A análise incorporada herdada 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
  • Requests

Observação

  • 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 aproximados com base no mapeamento de endereço IP.
  • Pode haver um atraso de 15 minutos ou mais na disponibilidade dos dados de análise.

Painel de controle baseado no Azure Monitor

Para usar o painel baseado no Azure Monitor, você precisa configurar um workspace do Log Analytics como uma fonte de dados para os logs do gateway do 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. Essa é uma configuração que só precisa ser realizada uma vez.

  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. Aceite os padrões para outras configurações ou personalize-as conforme necessário. Selecione Salvar.

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 Insights. 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 do Gerenciamento de API, a análise integrada também está disponível no portal do Microsoft Azure, e os dados da análise podem ser acessados usando a API REST do Gerenciamento de API.

Análise integrada - portal

Para acessar a análise integrada no portal do Microsoft Azure:

  1. No portal do Azure, navegue até a instância do Gerenciamento de API.
  2. No menu à esquerda, em Monitoramento, selecione Análises.
  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 com relação a uma ou mais categorias adicionais.

Análises - API REST

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.

Conteúdo relacionado