Compartilhar via

Referência de dados de monitoramento do Gerenciamento de API

APLICA-SE A: todas as camadas do Gerenciamento de API

Este artigo contém todas as informações de referência de monitoramento para este serviço.

Consulte Monitorar o Gerenciamento de API para obter detalhes sobre os dados que você pode coletar para o Gerenciamento de API do Azure e como usá-los.

Métricas

Esta seção lista todas as métricas da plataforma coletadas automaticamente para este serviço. Essas métricas também fazem parte da lista global de todas as métricas da plataforma com suporte no Azure Monitor.

Para obter informações sobre retenção de métricas, consulte Visão geral das métricas do Azure Monitor.

Métricas com suporte para Microsoft.ApiManagement/service

A tabela a seguir lista as métricas disponíveis para o tipo de recurso Microsoft.ApiManagement/service.

  • Nem todas as colunas podem estar presentes em todas as tabelas.
  • Algumas colunas podem estar além da área de visualização da página. Selecione Expandir tabela para exibir todas as colunas disponíveis.

Títulos de tabela

  • Categoria: o grupo ou classificação de métricas.
  • Métrica: o nome de exibição da métrica como aparece no portal do Azure.
  • Nome na API REST: o nome da métrica, conforme mencionado na API REST.
  • Unidade: unidade de medida
  • Agregação: o tipo de agregação padrão. Valores válidos: Médio (Méd.), Mínimo (Mín.), Máximo (Máx.), Total (Soma), Contagem.
  • Dimensões: as - disponíveis para a métrica.
  • Intervalos de agregação: os - em que a métrica é amostrada. Por exemplo, PT1M indica que a métrica é amostrada a cada minuto, PT30M a cada 30 minutos, PT1H a cada hora e assim por diante.
  • Exportação de DS: se a métrica é exportável para os Logs do Azure Monitor via configurações de diagnóstico. Para obter mais informações sobre exportação de métricas, consulte as Criar configurações de diagnóstico no Azure Monitor.

Categoria: Capacidade

Métrica Nome na API REST Unidade Agregação Dimensões Granularidade de tempo Exportação de DS
Capacidade

Métrica de utilização para o serviço ApiManagement. Observação: para skus diferentes de Premium, a agregação 'Max' mostrará o valor como 0.		 Capacity Porcentagem Média, Máximo Location PT1M Sim
Porcentagem de CPU do gateway

Porcentagem de CPU do Gateway para serviços SKUv2		 CpuPercent_Gateway Porcentagem Média, Máximo <nenhum> PT1M Sim
Porcentagem de memória do gateway

Porcentagem de memória do gateway para serviços SKUv2		 MemoryPercent_Gateway Porcentagem Média, Máximo <nenhum> PT1M Sim

Categoria: Eventos do EventHub

Métrica Nome na API REST Unidade Agregação Dimensões Granularidade de tempo Exportação de DS
Eventos descartados do EventHub

Número de eventos ignorados devido ao limite de tamanho da fila atingido		 EventHubDroppedEvents Contagem Total (Soma) Location PT1M Sim
Eventos rejeitados do EventHub

Número de eventos do EventHub rejeitados (configuração incorreta ou não autorizada)		 EventHubRejectedEvents Contagem Total (Soma) Location PT1M Sim
Eventos bem-sucedidos do EventHub

Número de eventos do EventHub bem-sucedidos		 EventHubSuccessfulEvents Contagem Total (Soma) Location PT1M Sim
Eventos do EventHub limitados

Número de eventos do EventHub restringidos		 EventHubThrottledEvents Contagem Total (Soma) Location PT1M Sim
Eventos do EventHub com tempo limite expirado

Número de eventos do EventHub com tempo limite excedido		 EventHubTimedoutEvents Contagem Total (Soma) Location PT1M Sim
Tamanho dos eventos do EventHub

Tamanho total dos eventos do EventHub em bytes		 EventHubTotalBytesSent Bytes Total (Soma) Location PT1M Sim
Total de eventos do EventHub

Número de eventos enviados ao EventHub		 EventHubTotalEvents Contagem Total (Soma) Location PT1M Sim
Eventos do EventHub com falha

Número de eventos do EventHub com falha		 EventHubTotalFailedEvents Contagem Total (Soma) Location PT1M Sim

Categoria: Solicitações de gateway

Métrica Nome na API REST Unidade Agregação Dimensões Granularidade de tempo Exportação de DS
Duração das solicitações de back-end

Duração das solicitações de back-end em milissegundos		 BackendDuration Milissegundos Médio, Máximo, Mínimo Location, , HostnameApiId PT1M Sim
Duração geral das solicitações de gateway

Duração total de solicitações de gateway em milissegundos		 Duration Milissegundos Médio, Máximo, Mínimo Location, , HostnameApiId PT1M Sim
Solicitações de gateway com falha (obsoletas)

Número de falhas nas solicitações de gateway – Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory		 FailedRequests Contagem Total (Soma) Location, Hostname PT1M Sim
Outras solicitações de gateway (obsoletas)

Número de outras solicitações de gateway – Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory		 OtherRequests Contagem Total (Soma) Location, Hostname PT1M Sim
Solicitações

Métricas das solicitações de gateway com várias dimensões		 Requests Contagem Total (Soma), Máximo, Mínimo Location, Hostname, LastErrorReason, BackendResponseCode, GatewayResponseCode, BackendResponseCodeCategory, , GatewayResponseCodeCategory, , ApiId PT1M Sim
Solicitações de gateway bem-sucedidas (obsoletas)

Número de solicitações de gateway com êxito – Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory		 SuccessfulRequests Contagem Total (Soma) Location, Hostname PT1M Sim
Total de solicitações de gateway (obsoleto)

Número de solicitações de gateway – Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory		 TotalRequests Contagem Total (Soma) Location, Hostname PT1M Sim
Solicitações de gateway não autorizadas (obsoletas)

Número de solicitações de gateway não autorizadas – Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory		 UnauthorizedRequests Contagem Total (Soma) Location, Hostname PT1M Sim

Categoria: Gateway WebSocket

Métrica Nome na API REST Unidade Agregação Dimensões Granularidade de tempo Exportação de DS
Tentativas de conexão do WebSocket (versão prévia)

Contagem de tentativas de conexão do WebSocket com base na origem e no destino selecionados		 ConnectionAttempts Contagem Total (Soma), Média Location, Source, , DestinationState PT1M Sim
Mensagens do WebSocket (versão prévia)

Contagem de mensagens do WebSocket com base na origem e no destino selecionados		 WebSocketMessages Contagem Total (Soma), Média Location, , SourceDestination PT1M Sim

Categoria: Status da rede

Métrica Nome na API REST Unidade Agregação Dimensões Granularidade de tempo Exportação de DS
Status de conectividade de rede dos recursos (versão prévia)

Status de conectividade de rede dos tipos de recursos dependentes do serviço de Gerenciamento de API		 NetworkConnectivity Contagem Total (Soma), Média Location, ResourceType PT1M Sim

Dimensões de métrica

Para obter mais informações sobre o que são dimensões de métrica, confira Métricas multidimensionais.

Este serviço tem as dimensões a seguir associadas a essas métricas.

  • ApiId
  • BackendResponseCode
  • BackendResponseCodeCategory
  • Destino
  • Código de resposta do gateway
  • GatewayResponseCodeCategory
  • Nome do host
  • MotivoDoÚltimoErro
  • Localidade
  • TipoDeRecurso
  • Origem
  • Estado

Métricas com suporte para Microsoft.ApiManagement/gateways

A tabela a seguir lista as métricas disponíveis para o tipo de recurso Microsoft.ApiManagement/gateways.

Títulos de tabela

Métrica: o nome de exibição da métrica como aparece no portal do Azure.
Nome na API REST - Nome da métrica mencionado na API REST.
Unidade: unidade de medida
Agregação: o tipo de agregação padrão. Valores válidos: Médio, Mínimo, Máximo, Total, Contagem.
Dimensões: as - disponíveis para a métrica.
Grânulos de Tempo - Intervalos nos quais a métrica é amostrada. Por exemplo, PT1M indica que a métrica é amostrada a cada minuto, PT30M a cada 30 minutos, PT1H a cada hora e assim por diante.
DS Export – Se a métrica é exportável para os logs do Azure Monitor por meio das Configurações de Diagnóstico.

Para obter informações sobre como exportar métricas, consulte - Exportação de métricas usando regras de coleta de dados e Criar configurações de diagnóstico no Azure Monitor.

Para obter informações sobre retenção de métricas, consulte Visão geral das métricas do Azure Monitor.

Categoria: Utilização

Métrica Nome na API REST Unidade Agregação Dimensões Granularidade de tempo Exportação de DS
Utilização da CPU (%)

Uso total do processador em todos os núcleos do gateway de API.		 CpuPercent_Gateway Porcentagem Média, Máximo <nenhum> PT1M Sim
Utilização de memória (%)

Percentual de memória física em uso por processos ativos no gateway de API.		 MemoryPercent_Gateway Porcentagem Média, Máximo <nenhum> PT1M Sim

Logs de recursos

Esta seção lista os tipos de logs de recursos que você pode coletar para o este serviço. A seção extrai da lista de todos os tipos de categoria de logs de recursos com suporte no Azure Monitor.

Logs de recursos com suporte para Microsoft.ApiManagement/service

Categoria Nome de exibição da categoria Tabela de log Com suporte a plano de log básico Com suporte a transformações de tempo-ingestão Consultas de exemplo Custos para exportar
DeveloperPortalAuditLogs Logs relacionados ao uso do Portal do Desenvolvedor Log de Diagnóstico de Auditoria do Portal de Desenvolvimento do APIM

Logs de diagnóstico para API do Portal do Desenvolvedor de Gerenciamento de API.

 Sim Não Sim
GatewayLlmLogs Logs relacionados ao gateway de IA generativa ApiManagementGatewayLlmLog

Logs do Gateway relacionados a modelos de linguagem para a Linguagem do Gerenciamento de API.

 Sim Não Sim
GatewayLogs Logs relacionados ao Gateway ApiManagement ApiManagementGatewayLogs

Logs do gateway do Azure ApiManagement.

 Sim Sim Consultas Não
WebSocketConnectionLogs Logs relacionados a conexões WebSocket ApiManagementWebSocketConnectionLogs

Os logs de conexão do Websocket fornecem logs em eventos de conexão do websocket para o Gateway de Gerenciamento de API. O registro em log começa quando a solicitação chega ao Gateway de Gerenciamento de API para handshake e até que a solicitação seja encerrada. Cada log de solicitação pode ser identificado exclusivamente com CorrelationId.

 Sim Não Sim

Logs de recursos com suporte para Microsoft.ApiManagement/service/workspaces

Categoria Nome de exibição da categoria Tabela de log Com suporte a plano de log básico Com suporte a transformações de tempo-ingestão Consultas de exemplo Custos para exportar
GatewayLogs Logs de gateway para workspaces de Gerenciamento de API AzureDiagnostics

Logs de vários recursos do Azure.

 Não Não Sim

Tabelas de Logs do Azure Monitor

Esta seção lista todas as tabelas dos Logs do Azure Monitor relevantes para este serviço e disponíveis para consulta pela análise de logs usando o Kusto. As tabelas contêm dados de log de recursos e possivelmente mais, dependendo do que é coletado e roteado para elas.

Gerenciamento de API Microsoft.ApiManagement/service

Log de atividades

A tabela vinculada lista as operações que podem ser registradas no log de atividades desse serviço. Essas operações são um subconjunto de todas as operações do provedor de recursos possíveis no log de atividades.

Para obter mais informações sobre o esquema de entradas do log de atividades, confira Esquema do log de atividades.

Conteúdo relacionado