Partilhar via

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

  • Artigo

APLICA-SE A: Developer | Básico | Básico v2 | Padrão | Padrão v2 | Prémio | Premium v2

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.

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

Nota

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

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 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

Nota

  • 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 aproximados com base no mapeamento de endereços IP.
  • Pode haver um atraso na disponibilidade dos 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. Esta é 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.

Análise integrada - portal

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.

Analytics - REST API

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.

Conteúdos relacionados