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

Depois de implantar uma API para GraphQL no Fabric, convém entender como a API está sendo usada pelos clientes e solucionar erros caso haja problemas com a API. Use o painel de monitoramento do GraphQL do Fabric para visualizar, monitorar e solucionar problemas da atividade de solicitação da API do GraphQL. Esse recurso está atualmente em versão prévia. Este artigo explica como habilitar o monitoramento e usar os componentes do painel com eficiência.

Pré-requisitos

• Monitoramento do workspace habilitado. Para obter mais informações, consulte Visão Geral do Monitoramento da Área de Trabalho e siga as etapas para habilitar o monitoramento da área de trabalho.
• Antes de começar a usar os recursos de monitoramento e registro em log, você deve ter uma API para GraphQL no Fabric. Para obter mais informações, consulte Criar uma API para GraphQL no Fabric e adicionar dados.

Habilitando o monitoramento da API do GraphQL

Nesta seção, explicamos as etapas necessárias para habilitar o monitoramento para sua API para GraphQL. Por padrão, esse recurso está desativado.

1. Para habilitar métricas e/ou experiência de registro em log para cada API do 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 opção Monitoramento (pré-visualização) no menu da esquerda. Se o monitoramento do workspace ainda não tiver sido habilitado, você verá uma observação para que você vá 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 somente Métricas (painel de API), somente Registro em log (solicitações de API) ou ambos. As métricas e os logs são salvos em tabelas separadas no Kusto e você pode habilitar cada recurso separadamente, dependendo de suas necessidades. Por padrão, ambas as opções estão desativadas:

   

Atividade de solicitação de API

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

A atividade de solicitação de API consiste em duas exibições primárias:

1. painel de API (para métricas): esta página exibe todos os contadores e grafos 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 da atividade de API para você com várias métricas e visuais. Para acessar, na página de atividade de solicitação de API, selecione a guia do painel de API. Agora você pode visualizar de forma rápida os seguintes parâmetros para um intervalo de tempo específico:

• Índice geral de Integridade da API do GraphQL que inclui:

  • Requisições de API por 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 erros e êxitos

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

Principais Recursos de Métricas:

• Seleção de Intervalo de Tempo: você pode selecionar diferentes intervalos de tempo para os dados exibidos nos gráficos de monitoramento. Observe que, devido a limites de de monitoramento do workspace, a retenção de dados só está disponível por 30 dias.

  

• Solicitações de API por segundo: Você pode visualizar o número de solicitações de API feitas a cada segundo no intervalo de tempo selecionado.

  

• taxa de êxito: você pode exibir a taxa de êxito que é o número de solicitações bem-sucedidas em relação ao número total de solicitações no intervalo de tempo selecionado.

  

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

  • Verde: 75 a 100% de solicitações são bem-sucedidas (Saudável)

  • Amarelo: 50% a 74% das solicitações são bem-sucedidas (Precisa de atenção)

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

    

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

• Latência gráfico de linhas: ao passar o mouse sobre grafos, você poderá 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 êxito e erros: ao passar o mouse sobre grafos, você poderá ver a data e o número de êxitos e erros para cada ponto de dados.

  

Quando você vê um comportamento anormal no painel que exige sua atenção, você pode investigar mais detalhadamente examinando 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 acessar detalhes de log, selecione a guia solicitações de API na página atividade de solicitação de API.

Registro em log (solicitações de API)

A página de solicitações de API fornece informações detalhadas sobre todas as solicitações de API que ocorreram em um período específico. Para acessar, selecione a guia Solicitações de API na página Atividade de solicitações de API.

Principais recursos de registro em log:

• Seleção de Intervalo de Tempo: você pode selecionar intervalos de tempo diferentes 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 a ID da Solicitação.
• Exiba o tipo da operação (Consulta ou Mutação).
• Exiba o protocolo de transporte usado pela solicitação (HTTP).
• Exiba a hora da solicitação.
• Classifique a lista de solicitações por tempo crescente/decrescente.
• Exibir a duração da solicitação.
• Classifique a lista de solicitações por duração crescente/decrescente.
• Exibir o tamanho da resposta.
• Exibir o status (êxito ou falha).
• Exiba os detalhes da solicitação, incluindo mensagens de resposta/aviso/erro específicas.
• Filtrar e pesquisar cadeias de caracteres ou frases específicas.
• Redimensione colunas e classifique as colunas (crescentes/decrescentes) da tabela de relatório.

Conteúdo relacionado

• API do Microsoft Fabric para GraphQL
• Comunicado de Monitoramento do Workspace
• 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