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 Dimensões disponíveis para a métrica.
- Intervalos de agregação: os Intervalos em que a métrica é amostrada. Por exemplo,
PT1Mindica que a métrica é amostrada a cada minuto,PT30Ma cada 30 minutos,PT1Ha 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 | Metric | Nome na API REST | Unidade | Agregação | Dimensões | Granularidade de tempo | Exportação de DS |
|---|---|---|---|---|---|---|---|
| Solicitações de gateway | Duração das solicitações de back-end Duração das solicitações de back-end em milissegundos |
BackendDuration |
MilliSeconds | Médio, Máximo, Mínimo | Location, Hostname, ApiId |
PT1M | Sim |
| Capacity | 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 |
| Gateway WebSocket | 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 |
Count | Total (Soma), Média | Location, Source, Destination, State |
PT1M | Sim |
| Capacity | Porcentagem de CPU do gateway Porcentagem de CPU do Gateway para serviços SKUv2 |
CpuPercent_Gateway |
Porcentagem | Média, Máximo | <none> | PT1M | Sim |
| Solicitações de gateway | Duração geral das solicitações de gateway Duração total de solicitações de gateway em milissegundos |
Duration |
MilliSeconds | Médio, Máximo, Mínimo | Location, Hostname, ApiId |
PT1M | Sim |
| Eventos do EventHub | Eventos descartados do EventHub Número de eventos ignorados devido ao limite de tamanho da fila atingido |
EventHubDroppedEvents |
Count | Total (Soma) | Location |
PT1M | Sim |
| Eventos do EventHub | Eventos rejeitados do EventHub Número de eventos do 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 do EventHub bem-sucedidos |
EventHubSuccessfulEvents |
Count | Total (Soma) | Location |
PT1M | Sim |
| Eventos do EventHub | Eventos do EventHub limitados Número de eventos do EventHub restringidos |
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 excedido |
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 ao 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 (obsoletas) Número de falhas nas solicitações de gateway – Use a métrica de solicitação multidimensional com a dimensão GatewayResponseCodeCategory |
FailedRequests |
Count | Total (Soma) | Location, Hostname |
PT1M | Sim |
| Capacity | Porcentagem de memória do gateway Porcentagem de memória do gateway para serviços SKUv2 |
MemoryPercent_Gateway |
Porcentagem | Média, Máximo | <none> | PT1M | Sim |
| Status da Rede | 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 |
Count | Total (Soma), Média | Location, ResourceType |
PT1M | Sim |
| Solicitações de gateway | 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 |
Count | Total (Soma) | Location, Hostname |
PT1M | Sim |
| Solicitações de gateway | Solicitações Métricas das solicitações de gateway com várias dimensões |
Requests |
Count | Total (Soma), Máximo, Mínimo | Location, Hostname, LastErrorReason, BackendResponseCode, GatewayResponseCode, BackendResponseCodeCategory, , GatewayResponseCodeCategory, , ApiId |
PT1M | Sim |
| Solicitações de gateway | 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 |
Count | Total (Soma) | Location, Hostname |
PT1M | Sim |
| Solicitações de gateway | 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 |
Count | Total (Soma) | Location, Hostname |
PT1M | Sim |
| Solicitações de gateway | 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 |
Count | Total (Soma) | Location, Hostname |
PT1M | Sim |
| Gateway WebSocket | Mensagens do WebSocket (versão prévia) Contagem de mensagens do WebSocket com base na origem e no destino selecionados |
WebSocketMessages |
Count | Total (Soma), Média | Location, Source, Destination |
PT1M | Yes |
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
- LastErrorReason
- Localidade
- ResourceType
- Origem
- Estado
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 | APIMDevPortalAuditDiagnosticLog 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 | Não | No | 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 | Não | No | 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
- APIMDevPortalAuditDiagnosticLog
- AzureActivity
- AzureMetrics
- AzureDiagnostics
- ApiManagementGatewayLogs
- ApiManagementWebSocketConnectionLogs
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
- Consulte Monitorar o Gerenciamento de API para obter uma descrição do monitoramento do Gerenciamento de API do Azure.
- Confira Monitorar recursos do Azure com o Azure Monitor para ver informações detalhadas sobre o monitoramento dos recursos do Azure.