Painel de monitoramento do GraphQL e registro em log (versão prévia)

Obtenha visibilidade completa das APIs do GraphQL de produção com os recursos integrados de monitoramento e registro em log do Microsoft Fabric. Acompanhe as métricas de desempenho em tempo real, analise padrões de consulta, solucione erros e entenda como os clientes interagem com suas APIs, tudo de dentro do workspace do Fabric.

Principais recursos de monitoramento:

• Real-Time Dashboard: visualize o desempenho da API, os tempos de resposta e as taxas de erro com gráficos interativos
• Log de solicitação detalhado: capturar dados completos de solicitação/resposta, complexidade da consulta e detalhes de execução
• Análise de desempenho: identificar consultas lentas, otimizar gargalos e acompanhar tendências de uso ao longo do tempo
• Acompanhamento de erros: monitorar falhas, investigar causas raiz e melhorar a confiabilidade da API

Esse painel de monitoramento fácil de entender permite que você tome decisões controladas por dados sobre seus padrões de uso e desempenho de API. Se você estiver solucionando problemas, otimizando o desempenho do aplicativo ou garantindo uma experiência tranquila do usuário, as ferramentas de monitoramento fornecem insights inestimáveis. Você pode identificar e resolver problemas rapidamente, obtendo uma compreensão mais profunda de como suas APIs estão sendo utilizadas.

Quem usa monitoramento e registro de logs

O monitoramento e o registro em log do GraphQL são essenciais para:

• Administradores do workspace do Fabric que monitoram a integridade da API, o desempenho e o consumo de capacidade em tempo real
• Administradores de capacidade do Fabric acompanham padrões de uso e otimizam a alocação de capacidade para cargas de trabalho do GraphQL
• Equipes de governança de dados auditam o acesso a dados, detectam anomalias e garantem a conformidade com as políticas de dados
• Engenheiros de dados analisando padrões de consulta e otimizando o acesso ao Fabric Lakehouse e ao warehouse
• Equipes de plataforma que entendem a adoção da API do Fabric e tomam decisões baseadas em dados sobre investimentos em API

Use o monitoramento e o registro em log quando precisar de visibilidade do comportamento da API do GraphQL de produção, das métricas de desempenho e da análise de uso.

Pré-requisitos

• Você precisa habilitar o monitoramento do workspace e adicionar uma casa de eventos para monitoramento. Para obter mais informações sobre como habilitá-lo, consulte Visão geral do Monitoramento do Workspace. O monitoramento do workspace está desabilitado por padrão.

  Nota

  Se você acabou de habilitar o monitoramento do workspace, talvez seja necessário atualizar a página antes de prosseguir com a configuração de monitoramento do GraphQL.

• Você deve ter uma API implantada para GraphQL no Fabric. Para obter mais informações sobre como implantar, consulte Criar uma API para GraphQL no Fabric e adicionar dados.

Habilitando o monitoramento da API do GraphQL

Agora que você tem o monitoramento de workspace habilitado de acordo com os pré-requisitos, você precisa habilitar separadamente o monitoramento para sua API específica do GraphQL. O monitoramento do GraphQL é desativado por padrão e deve ser habilitado para cada API individualmente. Veja como habilitá-lo:

1. Para habilitar as métricas e/ou a experiência de registro em log de cada API para GraphQL em seu locatário, abra a API do GraphQL e selecione o ícone Configurações :

   

2. Na janela de configurações da API, selecione a página Monitoramento (versão prévia) no menu à esquerda. Se o monitoramento do workspace ainda não estiver habilitado, você verá uma nota orientando você a ir para as configurações do workspace para habilitá-lo.

3. Depois de habilitar o monitoramento para o workspace, você verá as opções para habilitar métricas (exibir atividade de API agregada em um painel), log (exibir logs com informações detalhadas para cada solicitação de API) ou ambos.

   

   Nota

   As métricas e os logs são salvos em tabelas separadas no mesmo banco de dados Kusto e você pode habilitar cada recurso separadamente, dependendo de suas necessidades.

4. Habilite as opções desejadas alternando os interruptores uma de cada vez para a posição Ligado .

Atividade de solicitação de API

Depois que o monitoramento estiver habilitado, selecione o botão atividade de solicitação de API na faixa de opções superior para acessar os detalhes de monitoramento.

Na página de atividade de solicitação de API , você pode selecionar uma das seguintes guias para exibir dados de monitoramento específicos:

1. Painel de API (para Métricas): esta página exibe todos os contadores e gráficos para o intervalo de tempo especificado.
2. Solicitações de API (para registro em log): esta página lista as solicitações de API dentro do intervalo de tempo especificado.

Nas seções a seguir, descrevemos a funcionalidade de cada opção.

Métricas (painel de controle da API)

O painel de API fornece uma visão geral abrangente do desempenho da API do GraphQL por meio de gráficos e métricas interativas. Para acessar o painel, selecione a guia painel de API na página de atividade de solicitação de API .

O painel exibe os principais indicadores de desempenho entre intervalos de tempo personalizáveis, com todos os dados retidos por 30 dias. Passe o mouse sobre qualquer gráfico para ver informações detalhadas sobre pontos de dados específicos.

Indicadores de saúde

• Status de Integridade da API: indicador visual mostrando a integridade geral da API com base na taxa de êxito

  • Verde: 75-100% solicitações bem-sucedidas (Saudável)

  • Amarelo: 50-74% solicitações bem-sucedidas (Necessita de Atenção)

  • Vermelho: Abaixo de 50% requisições bem-sucedidas (não saudável)

    

• Taxa de Sucesso: Porcentagem de solicitações bem-sucedidas versus total de solicitações no intervalo de tempo selecionado

  

Métricas de volume

• Solicitações de API por Segundo: exibição em tempo real do volume de solicitação ao longo do tempo

  

• Total de solicitações de API: contagem agregada de todas as solicitações no intervalo de tempo selecionado

  

• Gráfico de Barras de Status da Solicitação: Detalhamento visual mostrando solicitações bem-sucedidas versus erros ao longo do tempo

  

Métricas de desempenho

• Gráfico de Linhas de Latência: Tendências de tempo de resposta mostrando o desempenho ao longo do tempo

  

Opções de personalização

• Seleção de Intervalo de Tempo: escolha entre janelas de tempo diferentes (hora, dia, semana, mês) para analisar seus dados. A retenção de dados é limitada a 30 dias.

  

Da visão geral aos detalhes

A página do painel de API fornece uma excelente exibição de alto nível das tendências de desempenho e integridade da API. Quando você detecta problemas como taxas de êxito em declínio, latência aumentada ou padrões de solicitação incomuns, a página solicitações de APIna próxima seção fornece os logs detalhados necessários para investigação.

Embora o painel mostre o que está acontecendo com sua API, a página de log mostra exatamente quais solicitações estão causando problemas, com mensagens de erro, detalhes da resposta e tempos de execução para consultas individuais.

Registro em log (solicitações de API)

A página de solicitações de API captura detalhes abrangentes sobre cada operação do GraphQL, permitindo uma investigação profunda e solução de problemas. Acesse essa exibição detalhada selecionando a guia Solicitações de API na página de atividade de solicitação de API .

Esse registro em nível de solicitação complementa as métricas de visão geral do painel fornecendo os dados granulares necessários para diagnosticar problemas específicos, otimizar consultas lentas e entender os padrões de comportamento do cliente.

Solicitar informações

Cada solicitação registrada em log inclui:

• ID da solicitação: identificador exclusivo para acompanhar operações específicas
• Tipo de operação: classificação de consulta ou mutação
• Protocolo de transporte: método HTTP usado para a solicitação
• Carimbo de data e hora: hora exata em que a solicitação foi recebida
• Duração: Tempo total de execução desde a solicitação até a resposta
• Tamanho da resposta: tamanho da carga de dados retornado ao cliente
• Status: Indicador de êxito ou falha com informações detalhadas de erro

Ferramentas de exploração de dados

• Filtragem de intervalo de tempo: selecione entre exibições de hora, dia, semana ou mês (limite de retenção de 30 dias)

  

• Classificação Avançada: Classificar por carimbo de data/hora ou duração em ordem crescente/decrescente

• Pesquisa e Filtragem: localizar solicitações específicas usando a pesquisa de texto em todos os detalhes da solicitação

• Gerenciamento de Colunas: Redimensionar e reordenar colunas para personalizar o modo de exibição de tabela

• Inspeção Detalhada: Clique em qualquer solicitação para exibir dados completos de solicitação/resposta, incluindo mensagens de erro e avisos

Solução de problemas de fluxos de trabalho

Utilize a página de registro para:

• Identificar consultas com falha: filtrar por status para localizar erros e investigar causas raiz
• Analisar gargalos de desempenho: classificar por duração para localizar as operações de execução mais lentas
• Acompanhar padrões de uso: analisar os tipos de operação e os momentos para compreender o comportamento do cliente
• Depurar problemas específicos: pesquisar mensagens de erro específicas ou IDs de solicitação relatadas pelos usuários

Conteúdo relacionado

• API Fabric para GraphQL
• Visão geral do monitoramento do espaço de trabalho
• API para GraphQL no Fabric
• API do Fabric para editor GraphQL
• API do Fabric para exibição e exploração de esquemas do GraphQL