Painel de monitorização e registo do GraphQL (pré-visualização)

Observação

O recurso Painel de Monitorização e Registo de Logs da API Fabric para GraphQL está em versão de pré-visualização .

Depois de implantar uma API para GraphQL na malha, convém entender como a API está sendo usada pelos clientes e solucionar erros caso haja algum problema com a API. Use o painel de monitoramento do Fabric GraphQL para visualizar, monitorar e solucionar problemas de sua atividade de solicitação da API do GraphQL. Esta funcionalidade está atualmente em pré-visualização. Este artigo explica como habilitar o monitoramento e usar os componentes do painel de forma eficaz.

Pré-requisitos

• Ativado monitoramento de espaço de trabalho. Para obter mais informações, consulte Visão geral do monitoramento de espaço de trabalho e siga as etapas para habilitar o monitoramento de espaço de trabalho.
• Antes de começar a usar os recursos de monitoramento e registro, é necessário ter uma API para GraphQL no Fabric. Para obter mais informações, consulte Criar uma API para GraphQL no Fabric e adicionar dados.

Observação

• O recurso de monitoramento incorre encargos adicionais em relação à sua capacidade.
• O monitoramento do espaço de trabalho está desabilitado por padrão.
• A retenção de dados para monitoramento de atividades é limitada a 30 dias.

Ativando o monitoramento da API GraphQL

Nesta seção, orientamos você pelas etapas necessárias para habilitar o monitoramento de sua API para GraphQL. Por padrão, esse recurso está desativado.

1. Para habilitar a experiência de métricas e/ou registro para cada API GraphQL no seu tenant, abra a sua API GraphQL e selecione o ícone de Configurações:

   

2. Na janela Definições da API, selecione a opção Monitorização (pré-visualização) no menu à esquerda. Se o monitoramento de espaço de trabalho ainda não tiver sido habilitado, aparecerá uma nota a orientar a ir para as configurações do espaço de trabalho para habilitá-lo.

   

3. Depois de habilitar o monitoramento para o espaço de trabalho, você verá as opções para habilitar Somente métricas (painel da API), Somente de registro em log (solicitações de API) ou ambos. As métricas e logs são salvos em tabelas separadas no Kusto, e você pode habilitar cada recurso separadamente, dependendo da sua necessidade. Por padrão, ambas as opções estão desativadas:

   

Observação

As métricas e os dados de registro são enviados separadamente para o banco de dados Kusto associado ao espaço de trabalho e incorrem em custos adicionais. Para obter mais informações sobre os custos e consumos, consulte o Anúncio de Monitorização do Espaço de Trabalho .

Atividade de solicitação de API

Depois que o monitoramento estiver habilitado, a opção atividade de solicitação de API na faixa de opções superior da API do GraphQL ficará ativa. Selecione-o para acessar os detalhes do monitoramento.

O de atividade de solicitação de API consiste em duas exibições principais:

1. painel da 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): 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 da API)

O painel da API fornece uma visão geral da atividade da API para você com várias métricas e visuais. Para aceder, na página de atividade de pedidos de API, selecione o separador do painel de API. Agora você pode visualizar rapidamente os seguintes parâmetros para um intervalo de tempo específico:

• Índice geral de integridade da API GraphQL que inclui:

  • Pedido de API/segundo
  • Taxa de sucesso
  • Estado de saúde

• Número de solicitações de API

• Latência

• Número de solicitações no gráfico de barras ilustrando o número de acertos e erros

Ao passar o mouse sobre o gráfico, você pode ver as informações detalhadas de um ponto de dados específico em uma dica de ferramenta.

Principais Funcionalidades do Metrics:

• Time Range Selection: Você pode selecionar diferentes intervalos de tempo para os dados exibidos nos gráficos de monitoramento. Observe que, devido aos limites de monitoramento do espaço de trabalho, a retenção de dados só está disponível por 30 dias.

  

• Solicitação de API/seg: Pode ver o número de solicitações de API feitas a cada segundo no intervalo de tempo selecionado.

  

• Taxa de sucesso: Você pode visualizar a taxa de sucesso, que é o número de solicitações bem-sucedidas sobre o número total de solicitações no intervalo de tempo selecionado.

  

• Índice geral de integridade da API GraphQL com base na taxa de sucesso por API:

  • Verde: 75 -100% de pedidos são bem-sucedidos (Saudável)

  • Amarelo: 50 - 74% dos pedidos são bem-sucedidos (Precisa de atenção)

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

    

• Número total de solicitações de API: Você pode visualizar o número total de solicitações de API no intervalo de tempo selecionado.

• Gráfico de linhas da latência: Ao passar o rato sobre os gráficos, pode ver a latência e a data de cada ponto de dados.

  

• Número de solicitações gráfico de barras, diferenciando entre solicitações de sucesso e erros: Ao passar o mouse sobre os gráficos, você poderá ver a data e o número de acertos e erros para cada ponto de dados.

  

Quando você vê um comportamento anormal no painel que requer sua atenção, você pode investigar ainda mais examinando os logs para identificar possíveis problemas e descobrir quais solicitações falharam e têm maior latência e começar a examinar os detalhes do log para solucionar problemas. Para aceder aos detalhes de registo, selecione a aba solicitações de API na página de atividade de solicitação de API .

Registo (solicitações de API)

A página Solicitações de API fornece informações detalhadas sobre todas as solicitações de API que aconteceram em um período de tempo específico. Para aceder, selecione a guia solicitações de API na página de atividade de solicitação de API .

Principais recursos de registo:

• Seleção de Intervalo de Tempo: Você pode selecionar diferentes intervalos de tempo para os dados exibidos na lista de solicitações (Hora/Dia/Semana/Mês). Observe que há limite de retenção de 30 dias.

• Exiba uma lista de solicitações de API recentes e solicitações anteriores listadas com ID de solicitação.
• Exiba o tipo da operação (Consulta ou Mutação).
• Exiba o protocolo de transporte usado pela solicitação (HTTP).
• Veja a hora do pedido.
• Ordene a lista de pedidos por tempo ascendente/decrescente.
• Ver duração do pedido.
• Ordene a lista de pedidos por duração crescente/decrescente.
• Veja o tamanho da resposta.
• Visualize o status (Sucesso ou Fracasso).
• Veja os detalhes do pedido, incluindo mensagens de resposta/aviso/erro específicas.
• Filtre e pesquise cadeias de caracteres ou frases específicas.
• Redimensione as colunas e classifique as colunas (crescentes/decrescentes) da tabela de relatório.

Conteúdo relacionado

• API do Microsoft Fabric para GraphQL
• Anúncio de monitoramento do espaço de trabalho
• Visão geral do monitoramento do espaço de trabalho
• API para GraphQL no Fabric
• Fabric API para o Editor GraphQL
• Fabric API para a visualização e exploração do esquema GraphQL