Partilhar via

Referência de dados de monitoramento do Gerenciamento de API

  • Artigo

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

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

Consulte Monitorar 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 de plataforma coletadas automaticamente para este serviço. Essas métricas também fazem parte da lista global de todas as métricas de plataforma com suporte no Azure Monitor.

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

Métricas suportadas 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 visualizar todas as colunas disponíveis.

Cabeçalhos de tabela

  • Categoria - O grupo ou classificação de métricas.
  • Métrica - O nome para exibição da métrica conforme aparece no portal do Azure.
  • Nome na API REST - O nome da métrica conforme referido na API REST.
  • Unidade - Unidade de medida.
  • Agregação - O tipo de agregação padrão. Valores válidos: Média (Média), Mínima (Mín), Máxima (Máx), Total (Soma), Contagem.
  • Dimensões - Dimensões disponíveis para a métrica.
  • Intervalos de grãos de - tempo 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.
  • DS Export- Se a métrica é exportável para os Logs do Azure Monitor por meio de configurações de diagnóstico. Para obter informações sobre como exportar métricas, consulte Criar configurações de diagnóstico no Azure Monitor.
Categoria Métrica Nome na API REST Unit Agregação Dimensões Grãos de tempo DS Exportação
Solicitações de gateway Duração das solicitações de back-end

Duração das solicitações de back-end em milissegundos		 BackendDuration Milissegundos Média, Máximo, Mínimo Location, Hostname, ApiId PT1M Sim
Capacidade Capacidade

Métrica de utilização para o serviço ApiManagement. Nota: Para skus diferentes de Premium, a agregação 'Max' mostrará o valor como 0.		 Capacity Percentagem Média, Máxima Location PT1M Sim
Gateway WebSocket Tentativas de conexão WebSocket (visualização)

Contagem de tentativas de conexão WebSocket com base na origem e no destino selecionados		 ConnectionAttempts Count Total (soma), média Location, Source, Destination, State PT1M Sim
Capacidade Porcentagem de CPU do gateway

Porcentagem de CPU do gateway para serviços SKUv2		 CpuPercent_Gateway Percentagem Média, Máxima <nenhum> PT1M Sim
Solicitações de gateway Duração total dos pedidos de gateway

Duração total das solicitações de gateway em milissegundos		 Duration Milissegundos Média, Máximo, Mínimo Location, Hostname, ApiId PT1M Sim
Eventos do EventHub Eventos do EventHub descartados

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

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

Número de eventos bem-sucedidos do EventHub		 EventHubSuccessfulEvents Count Total (soma) Location PT1M Sim
Eventos do EventHub Eventos do EventHub acelerados

Número de eventos do EventHub limitados		 EventHubThrottledEvents Count Total (soma) Location PT1M Sim
Eventos do EventHub Eventos do EventHub com tempo limite expirado

Número de eventos do EventHub com tempo limite esgotado		 EventHubTimedoutEvents Count Total (soma) Location PT1M Sim
Eventos do EventHub Tamanho dos eventos do EventHub

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

Número de eventos enviados para o EventHub		 EventHubTotalEvents Count Total (soma) Location PT1M Sim
Eventos do EventHub Eventos do EventHub com falha

Número de eventos do EventHub com falha		 EventHubTotalFailedEvents Count Total (soma) Location PT1M Sim
Solicitações de gateway Solicitações de gateway com falha (preteridas)

Número de falhas em solicitações de gateway - Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory em vez disso		 FailedRequests Count Total (soma) Location, Hostname PT1M Sim
Capacidade Porcentagem de memória do gateway

Porcentagem de memória do gateway para serviços SKUv2		 MemoryPercent_Gateway Percentagem Média, Máxima <nenhum> PT1M Sim
Estado da rede Status de conectividade de rede de recursos (visualização)

Status de conectividade de rede de tipos de recursos dependentes do serviço de Gerenciamento de API		 NetworkConnectivity Count Total (soma), média Location, ResourceType PT1M Sim
Solicitações de gateway Outras solicitações de gateway (preteridas)

Número de outras solicitações de gateway - Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory em vez disso		 OtherRequests Count Total (soma) Location, Hostname PT1M Sim
Solicitações de gateway Pedidos

Métricas de solicitação de gateway com várias dimensões		 Requests Count Total (soma), máximo, mínimo Location, Hostname, , LastErrorReason, GatewayResponseCodeBackendResponseCode, BackendResponseCodeCategory, GatewayResponseCodeCategory,ApiId PT1M Sim
Solicitações de gateway Solicitações de gateway bem-sucedidas (preteridas)

Número de solicitações de gateway bem-sucedidas - Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory		 SuccessfulRequests Count Total (soma) Location, Hostname PT1M Sim
Solicitações de gateway Total de solicitações de gateway (preterido)

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

Número de solicitações de gateway não autorizadas - Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory em vez disso		 UnauthorizedRequests Count Total (soma) Location, Hostname PT1M Sim
Gateway WebSocket Mensagens WebSocket (Pré-visualização)

Contagem de mensagens WebSocket com base na origem e no destino selecionados		 WebSocketMessages Count Total (soma), média Location, Source, Destination PT1M Sim

Dimensões métricas

Para obter informações sobre o que são dimensões métricas, consulte Métricas multidimensionais.

Este serviço tem as seguintes dimensões associadas às suas métricas.

  • ApiId
  • BackendResponseCode
  • BackendResponseCodeCategory
  • Destino
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • Hostname (Nome do anfitrião)
  • LastErrorReason
  • Location
  • ResourceType
  • Origem
  • Estado

Registos do recurso

Esta seção lista os tipos de logs de recursos que você pode coletar para 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 suportados para Microsoft.ApiManagement/service

Categoria Nome de exibição da categoria Tabela de registo Suporta plano de log básico Suporta a transformação do tempo de ingestão Consultas de exemplo Custos de exportação
DeveloperPortalAuditLogs Logs relacionados ao uso do Portal do Desenvolvedor APIMDevPortalAuditDiagnosticLog

Logs de diagnóstico para API Management Developer Portal API.

 Sim No Sim
GatewayLlmLogs Logs relacionados ao gateway de IA generativo No No Sim
GatewayLogs Logs relacionados ao ApiManagement Gateway ApiManagementGatewayLogs

Logs de gateway do Azure ApiManagement.

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

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

 Sim No Sim

Logs de recursos suportados para Microsoft.ApiManagement/service/workspaces

Categoria Nome de exibição da categoria Tabela de registo Suporta plano de log básico Suporta a transformação do tempo de ingestão Consultas de exemplo Custos de exportação
GatewayLogs Logs de gateway para espaços de trabalho de Gerenciamento de API No No Sim

Tabelas de Logs do Azure Monitor

Esta seção lista as tabelas de Logs do Azure Monitor relevantes para este serviço, que estão disponíveis para consulta pelo Log Analytics usando consultas 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

Registo 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 possíveis do provedor de recursos no log de atividades.

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

Conteúdos relacionados