Tutorial: Monitorizar as APIs publicadas

  • Artigo

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

Com o Azure Monitor, pode visualizar, consultar, encaminhar, arquivar e tomar medidas relativamente a métricas ou registos provenientes do serviço Gestão de API do Azure.

Neste tutorial, irá aprender a:

  • Ver métricas da API
  • Configurar uma regra de alerta
  • Ver registos de atividades
  • Habilitar e exibir logs de recursos

Nota

O Gerenciamento de API suporta uma variedade de ferramentas adicionais para observar APIs, incluindo análises internas e integração com o Application Insights. Mais informações

Pré-requisitos

Ver métricas das APIs

O Gerenciamento de API emite métricas a cada minuto, oferecendo visibilidade quase em tempo real do estado e da integridade de suas APIs. A seguir estão as duas métricas usadas com mais frequência. Para obter uma lista de todas as métricas disponíveis, veja Métricas suportadas.

  • Capacidade - ajuda você a tomar decisões sobre upgrade/downgrade de seus serviços de Gerenciamento de API. A métrica é emitida por minuto e reflete a capacidade estimada do gateway no momento do relatório. A métrica varia entre 0 e 100 e é calculada com base nos recursos do gateway, como a utilização da CPU e da memória.
  • Solicitações - ajuda você a analisar o tráfego de API que passa pelos serviços de Gerenciamento de API. A métrica é emitida por minuto e informa o número de solicitações de gateway com dimensões. Filtre solicitações por códigos de resposta, local, nome do host e erros.

Importante

As métricas a seguir foram preteridas a partir de maio de 2019 e serão desativadas em agosto de 2023: Total de solicitações de gateway, solicitações de gateway bem-sucedidas, solicitações de gateway não autorizadas, solicitações de gateway com falha, outras solicitações de gateway. Migre para a métrica Solicitações, que fornece funcionalidade equivalente.

Captura de tela da visão geral de métricas no gerenciamento de API

Para aceder a métricas:

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API. Na página Visão geral, na guia Monitor, revise as principais métricas de suas APIs.

  2. Para investigar métricas em detalhes, selecione Métricas no menu à esquerda.

    Captura de tela do item Métricas no menu Monitoramento no portal.

  3. Na lista suspensa, selecione as métricas em que você está interessado. Por exemplo, Solicitações.

  4. O gráfico mostra o número total de chamadas à API. Ajuste o intervalo de tempo para se concentrar em períodos de interesse.

  5. Você pode filtrar o gráfico usando as dimensões da métrica Solicitações . Por exemplo, selecione Adicionar filtro, selecione Categoria de código de resposta de back-end, insira 500 como o valor. O gráfico mostra o número de solicitações com falha no back-end da API.

Configurar uma regra de alerta

Você pode receber alertas com base em métricas e registros de atividades. No Azure Monitor, configure uma regra de alerta para executar uma ação quando ela for acionada. As ações comuns incluem:

  • Enviar uma notificação por e-mail
  • Chamar um webhook
  • Invocar uma Aplicação Lógica do Azure

Para configurar uma regra de alerta de exemplo com base em uma métrica de solicitação:

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.

  2. Selecione Alertas no menu à esquerda.

    Captura de tela da opção Alertas no menu Monitoramento no portal.

  3. Selecione + Criar>regra de alerta.

  4. Na janela Selecione um sinal na guia Condição:

    1. Em Tipo de sinal, selecione Métricas.
    2. Em Nome do sinal, selecione Solicitações.
    3. Em Lógica de alerta, especifique um valor de Limite, que é o número de ocorrências após as quais o alerta deve ser acionado.
    4. Em Dividir por dimensões, em Nome da dimensão, selecione Categoria do Código de Resposta do Gateway.
    5. Em Valores de dimensão, selecione 4xx, para erros de cliente, como solicitações não autorizadas ou inválidas. Se o valor da dimensão não aparecer, selecione Adicionar valor personalizado e insira 4xx.
    6. Em Quando avaliar, aceite as configurações padrão ou selecione outras configurações para definir a frequência de execução da regra. Selecione Seguinte.

    Captura de tela da configuração da lógica de alerta no portal.

  5. Na guia Ações, selecione ou crie um ou mais grupos de ações para notificar os usuários sobre o alerta e executar uma ação. Por exemplo, crie um novo grupo de ações para enviar um e-mail de notificação para .admin@contoso.com Para obter etapas detalhadas, consulte Criar e gerenciar grupos de ação no portal do Azure.

    Captura de tela da configuração de notificações para novo grupo de ações no portal.

  6. Na guia Detalhes de Criar uma regra de alerta, insira um nome e uma descrição da regra de alerta e selecione o nível de gravidade.

  7. Opcionalmente, configure as configurações restantes. Em seguida, no separador Rever + criar , selecione Criar.

  8. Agora, teste a regra de alerta chamando a API de conferência sem uma chave de API. Por exemplo:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    Um alerta é acionado com base no período de avaliação e ele enviará um e-mail para admin@contoso.com.

    Os alertas também aparecem na página Alertas da instância de Gerenciamento de API.

    Captura de ecrã de alertas no portal.

Registos de atividade

Os logs de atividades fornecem informações sobre as operações em seus serviços de Gerenciamento de API. Ao utilizar registos de atividades, pode determinar o "quê, quem e quando" de quaisquer operações de escrita (PUT, POST, DELETE) efetuadas nos seus serviços de Gestão de API.

Nota

Os registos de atividades não incluem operações de leitura (GET) nem operações executadas no Portal do Azure ou com as APIs de Gestão originais.

Pode aceder aos registos de atividades no serviço de Gestão de API ou aceder aos registos de todos os recursos do Azure no Azure Monitor.

Captura de ecrã do registo de atividades no portal.

Para visualizar o registo de atividades:

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.

  2. Selecione Registro de atividades.

    Captura de ecrã do item Registo de atividades no menu Monitorização no portal.

  3. Selecione o escopo de filtragem desejado e, em seguida, Aplicar.

Registos do recurso

Os logs de recursos (logs do Azure Monitor) fornecem informações detalhadas sobre operações e erros de Gerenciamento de API que são importantes para fins de auditoria e solução de problemas. Quando habilitados por meio de uma configuração de diagnóstico, os logs coletam informações sobre as solicitações de API recebidas e processadas pelo gateway de Gerenciamento de API.

Nota

A camada Consumo não oferece suporte à coleta de logs de recursos.

Para configurar logs de recursos:

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.

  2. Selecione Configurações de diagnóstico.

    Captura de tela do item Configurações de diagnóstico no menu Monitoramento no portal.

  3. Selecione +Adicionar definição de diagnóstico.

  4. Selecione os logs ou métricas que deseja coletar.

    Você tem várias opções sobre para onde enviar os logs e métricas. Por exemplo, arquive logs de recursos juntamente com métricas em uma conta de armazenamento, transmita-os para um hub de eventos ou envie-os para um espaço de trabalho do Log Analytics.

    Gorjeta

    Se você selecionar um espaço de trabalho do Log Analytics, poderá optar por armazenar os dados na tabela ApiManagementGatewayLogs específica do recurso ou armazenar na tabela geral AzureDiagnostics. Recomendamos que utilize a tabela específica do recurso para destinos de registo que a suportem. Mais informações

  5. Depois de configurar os detalhes para o(s) destino(s) do log, selecione Salvar.

Nota

Adicionar um objeto de configuração de diagnóstico pode resultar em uma falha se a propriedade MinApiVersion do seu serviço de Gerenciamento de API estiver definida como qualquer versão de API superior a 2022-09-01-preview.

Para obter mais informações, consulte Criar configurações de diagnóstico para enviar logs e métricas da plataforma para destinos diferentes.

Exibir dados de diagnóstico no Azure Monitor

Se você habilitar a coleta de logs ou métricas em um espaço de trabalho do Log Analytics, poderá levar alguns minutos para que os dados apareçam no Azure Monitor.

Para visualizar os dados:

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.

  2. Selecione Logs no menu à esquerda.

    Captura de tela do item Logs no menu Monitoramento no portal.

  3. Execute consultas para exibir os dados. Várias consultas de exemplo são fornecidas ou executam as suas próprias. Por exemplo, a consulta a seguir recupera as 24 horas mais recentes de dados da tabela ApiManagementGatewayLogs:

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Captura de tela da consulta da tabela ApiManagementGatewayLogs no portal.

Para obter mais informações sobre como usar logs de recursos para o Gerenciamento de API, consulte:

Modificar as configurações de log da API

Por padrão, quando você cria uma configuração de diagnóstico para habilitar a coleta de logs de recursos, o registro em log é habilitado para todas as APIs, com configurações padrão. Você pode ajustar as configurações de log para todas as APIs ou substituí-las para APIs individuais. Por exemplo, ajuste a taxa de amostragem ou a detalhamento dos dados ou desative o registro em log para algumas APIs.

Para obter detalhes sobre as configurações de log, consulte Referência de configurações de log de diagnóstico.

Para definir as configurações de log para todas as APIs:

  1. No menu esquerdo da sua instância de Gerenciamento de API, selecione APIs>Todas as APIs.
  2. Selecione a guia Configurações na barra superior.
  3. Role para baixo até a seção Logs de Diagnóstico e selecione a guia Azure Monitor .
  4. Revise as configurações e faça alterações, se necessário. Selecione Guardar.

Para definir as configurações de log para uma API específica:

  1. No menu esquerdo da instância de Gerenciamento de API, selecione APIs e, em seguida, o nome da API.
  2. Selecione a guia Configurações na barra superior.
  3. Role para baixo até a seção Logs de Diagnóstico e selecione a guia Azure Monitor .
  4. Revise as configurações e faça alterações, se necessário. Selecione Guardar.

Próximos passos

Neste tutorial, ficou a saber como:

  • Ver métricas da API
  • Configurar uma regra de alerta
  • Ver registos de atividades
  • Habilitar e exibir logs de recursos

Avance para o tutorial seguinte:

Rastrear chamadas