Observabilidade no Gerenciamento de API do Azure

APLICA-SE A: Todos os níveis do Gerenciamento de API

A observabilidade é a capacidade de entender o estado interno de um sistema por meio dos dados que ele produz, bem como analisar os dados para entender 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 de todo o tráfego das APIs, é um lugar ideal para observá-las.

Visão geral

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

A tabela a seguir resume todos os recursos de observabilidade compatíveis com o Gerenciamento de API para operar as APIs e os modelos de implantação compatíveis. Os editores de API e outros com permissões para operar ou gerenciar a instância de Gerenciamento de API podem usar esses recursos.

Observação

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 de API individual durante os 90 dias anteriores. Atualmente, o relatório de API integrado não está disponível no portal do desenvolvedor para os níveis de serviço v2.

Ferramenta Útil para Retardo de dados4 Retenção amostragem Tipo de dados Modelo(s) de implantação com suporte
Rastreamento de solicitação (Inspetor de API) Teste e depuração Instantâneo Últimos 100 rastreamentos Ativado por solicitação Rastreamento de requisições Gerenciado, Auto-hospedado, Azure Arc, Espaço de trabalho
Análise integrada Relatórios e monitoramento minutos Tempo de vida 100% Relatórios e logs Gerenciado
Métricas do Azure Monitor Relatórios e monitoramento minutos 90 dias (atualize para estender) 100% Métricas Gerenciado, auto-hospedado2, Azure Arc
Logs do Azure Monitor Relatórios, monitoramento e depuração minutos 31 dias/5 GB (atualize para estender) 100 % (ajustável) Registros Gerenciado1, Hospedado pelo cliente3, Azure Arc3
Aplicativo Azure Insights Relatórios, monitoramento e depuração Segundos 90 dias/5 GB (atualize para estender) Personalizado Logs, métricas Gerenciado1, Auto-hospedado1, Azure Arc1, Espaço de trabalho1
Registro via Hubs de Eventos do Azure Cenários personalizados Segundos Gerenciado pelo usuário Personalizado Personalizado Gerenciado1, auto-hospedado1, Azure Arc1
OpenTelemetry Monitoramento minutos Gerenciado pelo usuário 100% Métricas Hospedado localmente2

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

Práticas recomendadas

As práticas a seguir podem aprimorar a observabilidade da API:

  • Monitoramento granular: habilite as métricas por método para obter insights detalhados sobre os tempos de resposta e as taxas de erro.
  • Monitoramento de latência final: configurar alertas por método para latência final (por exemplo, 90º, 95º ou 99º percentil), pois a latência média pode ser enganosa. Para implementar esse recurso, use a Linguagem de Consulta Kusto (KQL) para encaminhar os logs 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 êxito, use as taxas em vez de contagens para garantir a precisão.
  • Rastreamento distribuído: habilite o rastreamento para identificar gargalos de desempenho e solucionar problemas.
  • Marcação de recursos: aplique tags às APIs para controle e alocação precisos de custos.

Conteúdo relacionado

  • Last updated on