Tableau de bord de surveillance et journalisation GraphQL (aperçu)

Remarque

La fonctionnalité de supervision du tableau de bord et de la journalisation pour l’API Fabric pour GraphQL est disponible en préversion .

Après avoir déployé une API pour GraphQL dans Fabric, vous pouvez comprendre comment l’API est utilisée par les clients et résoudre les erreurs en cas de problème avec l’API. Utilisez le tableau de bord de supervision Fabric GraphQL pour visualiser, surveiller et dépanner votre activité de demande d’API GraphQL. Cette fonctionnalité est actuellement en préversion. Cet article explique comment activer la supervision et utiliser efficacement les composants du tableau de bord.

Conditions préalables

• Activation de la surveillance de l’espace de travail . Pour plus d’informations, consultez Vue d’ensemble de l’analyse de l’espace de travail et suivez les étapes pour activer l’analyse de l’espace de travail.
• Avant de commencer à utiliser les fonctionnalités de surveillance et de journalisation, vous devez disposer d’une API pour GraphQL dans Fabric. Pour plus d’informations, consultez Créer une API pour GraphQL dans Fabric et ajouter des données.

Remarque

• La fonctionnalité de supervision entraîne frais supplémentaires par rapport à votre capacité.
• La surveillance de l’espace de travail est désactivée par défaut.
• La rétention des données pour la surveillance des activités est limitée à 30 jours.

Activation de l’analyse des API GraphQL

Dans cette section, nous vous présentons les étapes nécessaires pour activer la surveillance de votre API pour GraphQL. Par défaut, cette fonctionnalité est désactivée.

1. Pour activer métriques et/ou journalisation expérience pour chaque API pour GraphQL dans votre locataire, ouvrez votre API GraphQL, puis sélectionnez l’icône Paramètres :

   

2. Dans la fenêtre des paramètres de l'API, sélectionnez l'option Monitoring (préversion) à partir du menu de gauche. Si surveillance de l’espace de travail n’a pas déjà été activée, vous verrez une note vous guidant pour accéder aux paramètres de l’espace de travail pour l’activer.

   

3. Après avoir activé la surveillance de l’espace de travail, vous verrez les options permettant d’activer Métriques uniquement (tableau de bord d’API), Journalisation uniquement (demandes d’API) ou les deux. Les métriques et les journaux sont enregistrés dans des tables distinctes dans Kusto, et vous pouvez activer chaque fonctionnalité séparément en fonction de vos besoins. Par défaut, les deux options sont désactivées :

   

Remarque

Les données de journalisation et de métriques sont envoyées séparément à la base de données Kusto associée à l’espace de travail et entraînent des coûts supplémentaires. Pour plus d’informations sur le coût et l’utilisation de la consommation, consultez la notification de surveillance de l’espace de travail.

Activité de demande d’API

Une fois la surveillance activée, l'option d'activité de demande d'API dans le ruban supérieur de l'API GraphQL devient active. Sélectionnez-le pour accéder aux détails de surveillance.

L’activité de requête d’API se compose de deux vues principales :

1. tableau de bord d’API (pour les métriques): cette page affiche tous les compteurs et graphiques pour l’intervalle de temps spécifié.
2. demandes d’API (pour la journalisation): cette page répertorie les demandes d’API dans l’intervalle de temps spécifié.

Dans les sections suivantes, nous décrivons les fonctionnalités de chaque option.

Métriques (tableau de bord d’API)

Le tableau de bord de l’API fournit une vue d’ensemble de l’activité de l’API pour vous avec différentes métriques et visuels. Pour y accéder, dans la page d’activité de demande d’API , sélectionnez l’onglet du tableau de bord d’API. Vous pouvez maintenant rapidement afficher les paramètres suivants pour un intervalle de temps spécifique :

• Index d’intégrité de l’API GraphQL global qui inclut :

  • Requête d'API par seconde
  • Taux de réussite
  • État de santé

• Nombre de demandes d’API

• Latence

• Nombre de requêtes dans le graphique à barres illustrant le nombre de réussites et d’erreurs

En pointant sur le graphique, vous pouvez voir les informations détaillées d’un point de données spécifique dans une info-bulle.

fonctionnalités clés des métriques :

• sélection d’intervalle de temps: vous pouvez sélectionner différents intervalles de temps pour les données affichées dans les graphiques d’analyse. Notez qu’en raison de limites de surveillance de l’espace de travail, la conservation des données n’est disponible que pendant 30 jours.

  

• Requêtes API/s: Vous pouvez afficher le nombre de requêtes API effectuées chaque seconde dans la plage horaire sélectionnée.

  

• Taux de réussite: vous pouvez afficher le taux de réussite qui correspond au nombre de requêtes réussies sur le nombre total de requêtes dans l’intervalle de temps sélectionné.

  

• Index d’intégrité de l’API GraphQL global basé sur le taux de réussite par API :

  • Vert : 75 -100% des demandes réussit (Sain)

  • Jaune : 50 - 74% des demandes sont réussies (Besoin d’attention)

  • Rouge : Bellow 50% demandes réussies (non saines)

    

• Nombre total de requêtes d’API: vous pouvez afficher le nombre total de requêtes d’API dans l’intervalle de temps sélectionné.

• Latence graphique en courbes : en passant la souris sur le graphique, vous pouvez voir la latence et la date de chaque point de données.

  

• Nombre de requêtes graphique à barres, différentiant entre les demandes de réussite et les erreurs : en pointant sur les graphiques, vous pouvez voir la date et le nombre de réussites et d’erreurs pour chaque point de données.

  

Lorsque vous voyez un comportement anormal sur le tableau de bord qui nécessite votre attention, vous pouvez examiner plus en détail les journaux d’activité pour identifier les problèmes potentiels et déterminer les demandes ayant échoué et avoir une latence plus élevée et commencer à examiner les détails du journal pour résoudre les problèmes. Pour accéder aux détails de journalisation, sélectionnez l’onglet demandes d’API à partir de la page activité de demande d’API.

Journalisation (demandes d’API)

La page demandes d’API fournit des informations détaillées sur toutes les demandes d’API qui se sont produites dans un délai spécifique. Pour y accéder, sélectionnez l’onglet demandes d’API de la page activité de demande d’API.

fonctionnalités clés de journalisation:

• Sélection de l’intervalle de temps : vous pouvez sélectionner différents intervalles de temps pour les données affichées dans la liste des demandes (heure/jour/semaine/mois). Notez qu’il existe limite de rétention de 30 jours.

• Affichez la liste des demandes d’API récentes et des demandes passées répertoriées avec l’ID de requête.
• Affichez le type de l’opération (requête ou mutation).
• Affichez le protocole de transport utilisé par la requête (HTTP).
• Affichez l’heure de la demande.
• Triez la liste des requêtes par ordre croissant/décroissant.
• Afficher la durée de la demande.
• Triez la liste des requêtes par ordre de durée croissant/décroissant.
• Afficher la taille de la réponse.
• Affichez l’état (réussite ou échec).
• Affichez les détails de la demande, y compris les messages d’erreur/réponse/avertissement spécifiques.
• Filtrez et recherchez des chaînes ou des phrases spécifiques.
• Redimensionnez les colonnes et triez-les (croissant/décroissant) dans le tableau de rapport.

Contenu connexe

• API Microsoft Fabric pour GraphQL
• Annonce de surveillance de l'espace de travail
• Vue d’ensemble de la surveillance de l’espace de travail
• API pour GraphQL dans Fabric
• API Fabric pour l’éditeur GraphQL
• API Fabric pour la vue de schéma GraphQL et l’Explorateur