Observabilidade no Gerenciamento de API do Azure

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

Observabilidade é a capacidade de entender o estado interno de um sistema a partir dos dados que ele produz e a capacidade de explorar esses dados para responder a perguntas sobre o que aconteceu e por quê.

O Gerenciamento de API do Azure ajuda as organizações a centralizar o gerenciamento de todas as APIs. Como serve como um ponto único de entrada para todo o tráfego das APIs, é um local ideal para observar as APIs.

Descrição geral

O Gerenciamento de API do Azure permite que você escolha usar o gateway gerenciado ou o gateway autohospedado, implantado automaticamente ou usando uma extensão do Azure Arc.

A tabela a seguir resume todos os recursos de observabilidade suportados pelo Gerenciamento de API para operar APIs e quais modelos de implantação eles suportam. Os editores de API e outras pessoas com permissões para operar ou gerenciar a instância de Gerenciamento de API podem usar esses recursos.

O Application Insights também fornece telemetria externa de dependências para execuções de políticas suportadas. Para mais informações, consulte Integrar API Management do Azure com Application Insights.

Nota

Para consumidores de API que usam o portal do desenvolvedor, um relatório de API interno está disponível. Ele fornece apenas informações sobre o uso individual da API durante os 90 dias anteriores. Atualmente, o relatório de API interno não está disponível no portal do desenvolvedor para as camadas de serviço v2.

Ferramenta Útil para Defasagem de dados4 Retenção Amostragem Tipo de dados Modelo(s) de implantação suportado(s)
Rastreamento de solicitações (Inspetor de API) Teste e depuração Instantâneo Últimos 100 vestígios Ativado por solicitação Solicitar rastreamentos Gerenciado, Auto-hospedado, Azure Arc, Espaço de trabalho
Análise integrada Relatórios e monitorização Minutos Vitalício 100% Relatórios e registos Gerido
Métricas do Azure Monitor Relatórios e monitorização Minutos 90 dias (upgrade para prorrogação) 100% Métricas Gerenciado, Auto-hospedado2, Azure Arc
Registos do Azure Monitor Relatórios, monitoramento e depuração Minutos 31 dias/5GB (atualização para extensão) 100% (ajustável) Registos Gerenciado1, Auto-hospedado3, Azure Arc3
Aplicação Azure Insights Relatórios, monitoramento e depuração Segundos 90 dias/5GB (atualização para extensão) Personalizado Registos, métricas Gerenciado1, Auto-hospedado1, Azure Arc1, Espaço de trabalho1
Registo através dos Hubs de Eventos do Azure Cenários personalizados Segundos Gerido pelo utilizador Personalizado Personalizado Gerenciado1, Auto-hospedado1, Azure Arc1
OpenTelemetria Monitorização Minutos Gerido pelo utilizador 100% Métricas Autoalojado2

1 Opcional, dependendo da configuração do recurso no Gerenciamento de API do Azure.
2 Opcional, dependendo da configuração do gateway.
3 Atualmente, o gateway auto-hospedado não envia logs de diagnóstico para o Azure Monitor. No entanto, é possível configurar e persistir logs localmente onde o gateway auto-hospedado é implantado. Para obter mais informações, consulte Configurando métricas e logs locais para gateway auto-hospedado.
4 Com exceção do rastreamento de solicitações, todo o registro em log no Gerenciamento de API ocorre de forma assíncrona.

Melhores práticas

As seguintes práticas podem melhorar a observabilidade da sua API:

  • Monitorização granular: Permitir métricas por método para obter informações detalhadas sobre tempos de resposta e taxas de erro.
  • Monitorização da latência da cauda: Configure alertas por método para a latência da cauda (por exemplo, percentil 90, 95 ou 99), pois a latência média pode ser enganadora. Para implementar esta funcionalidade, utilize a Linguagem de Consulta Kusto (KQL) para encaminhar registos para um espaço de trabalho do Log Analytics.
  • Alertas proativos: Estabeleça alertas por método para taxas de erro e baixas taxas de sucesso, use taxas em vez de contagens para garantir a precisão.
  • Rastreamento distribuído: Permitir o rastreamento para identificar gargalos de desempenho e resolver problemas.
  • Etiquetagem de recursos: Aplique etiquetas às APIs para um acompanhamento e alocação de custos precisos.

Conteúdo relacionado

  • Last updated on