Traduit de l'anglais à l'aide de l'IA
Veuillez noter que cet article a été traduit à l'aide de la technologie IA. Bien que nous travaillions à maintenir l'exactitude, certains détails peuvent ne pas refléter parfaitement le texte original. Si vous avez des doutes sur une information, veuillez vous référer à la version anglaise.
Un manque d'informations approfondies sur les erreurs d'API peut rendre difficile pour les équipes techniques de les diagnostiquer et de les corriger efficacement. Le dépannage des API est conçu pour améliorer la performance opérationnelle de votre équipe, en fournissant une visibilité complète sur les données transmises lors d'un appel API, afin que vous puissiez agir et résoudre ces erreurs plus rapidement.
Une fois configuré, vous pouvez :
- Voir les types suivants de détails supplémentaires sur les erreurs d'API dans le flux d'événements de la Session Replay :
- Les en-têtes HTTP de la requête et de la réponse
- Le corps (les données envoyées par la requête ou reçues dans la réponse)
- Les éléments du corps (éléments spécifiques du corps de la requête/réponse)
- Les paramètres de requête du point de terminaison de la requête (de l'URL des informations que vous demandez).
- Exploiter les éléments du corps de réponse non chiffrés dans les dashboards et Alerts d'Erreurs, le Contexte d'analyse et le module Erreur pour surveiller, identifier et quantifier les erreurs en fonction du contenu du corps de réponse.
Accéder aux détails de dépannage
Les détails de dépannage des erreurs d'API peuvent être consultés à partir du lecteur de la Session Replay.
Accédez facilement au lecteur à partir d'une erreur d'API dans :
- Error Analysis : naviguez vers le panneau latéral de l'erreur d'API ou consultez la page des détails complets
- Dashboards et Alerts : faites un clic droit sur un graphique (contenant une métrique d'erreur d'API)
Une fois sur la replay :
- Localisez l'erreur d'API dans le flux d'événements ou la chronologie.
- Cliquez sur le bouton "Dépanner".
Détails non chiffrés
Tous les détails non chiffrés seront affichés (en-têtes et éléments du corps de la requête et de la réponse, sur leurs onglets respectifs).
Détails chiffrés
Avec les détails de dépannage chiffrés, tout ce que vous pouvez voir ce sont les clés des éléments d'en-tête et de corps qui ont été définis dans la règle de collecte de l'erreur sélectionnée. Cependant, toutes les valeurs apparaissent masquées (floues) et doivent être déchiffrées pour être affichées. Suivez les étapes ci-dessous pour déchiffrer :
1. Cliquez sur le bouton "Déchiffrer".
Notez que vous pouvez également trouver le bouton "Déchiffrer" en survolant et en cliquant sur l'icône de clé dans les paramètres de requête, les en-têtes et les éléments du corps.
2. Entrez votre clé privée et sélectionnez "Déchiffrer".
3. Vous pouvez maintenant voir les détails d'erreur exposés.
Notez qu'une fois déchiffré, si vous voyez le message "Non collecté", cela signifie que l'élément n'est pas présent pour l'erreur d'API sélectionnée.
4. Cliquez sur "Masquer les détails chiffrés" pour réappliquer le chiffrement.
Analyser dans Impact et Error Analysis
Vous pouvez continuer votre analyse dans Impact et Error Analysis directement depuis l'écran de dépannage :
- Erreur d'API : quantifiez ou voyez l'erreur sélectionnée dans Error Analysis directement depuis le panneau de dépannage, ou depuis le flux d'événements de replay ou la chronologie.
-
Élément du corps de réponse : quantifiez un élément spécifique du corps de réponse pour l'analyse :
Survolez ou sélectionnez/mettre en évidence le JSON du corps dans l'onglet Réponse et sélectionnez le bouton ‘Quantifier’ pour être redirigé vers Impact.
Utiliser l'élément du corps de réponse non chiffré
Dans le contexte d'analyse
Lorsque la condition d'erreur est disponible dans le Contexte d'analyse, vous pouvez filtrer les données sur les sessions où les utilisateurs ont rencontré une erreur d'API avec un élément de corps spécifique :
1. Sélectionnez la condition "Erreurs".
2. Sélectionnez "Une erreur d'API" dans le menu déroulant des erreurs.
3. Remplissez tout paramètre dont vous avez besoin (page, code d'état, méthode, URL de la requête).
4. Cochez “avec élément de corps de réponse”.
5. Sélectionnez le chemin JSON de l'élément de corps dans la liste extraite de la configuration.
6. Sélectionnez l'un des opérateurs :
- Existe : si vous souhaitez filtrer uniquement sur la présence du chemin JSON
- Égal : si vous souhaitez filtrer sur la valeur exacte
- Contient : si vous souhaitez filtrer sur des valeurs contenant le texte que vous saisissez
7. Appliquez pour enregistrer le paramètre de l'élément de corps.
8. Appliquez la condition de contexte d'analyse.
Dans les Real Time Error Dashboards
Utiliser l'élément de corps comme filtre
Un élément de corps de réponse non chiffré peut être utilisé comme filtre sur n'importe quel type de widget (sauf pour "Image") dans les dashboards d'erreurs en temps réel :
1. Créez ou sélectionnez un dashboard d'erreurs en temps réel.
2. Ajoutez un nouveau widget ou modifiez un existant (assurez-vous qu'il inclut la métrique d'erreur d'API).
3. La section des filtres apparaît.
4. Sous "Filtres", cliquez sur "+ Ajouter un filtre".
5. Sélectionnez “Élément de corps d'erreur”.
6. Sélectionnez l'un des chemins JSON d'élément de corps de réponse non chiffré collectés dans la liste (provenant des règles créées).
7. Définissez une condition sur la valeur en utilisant l'un des multiples opérateurs, ou laissez-le sur “existe” si vous souhaitez créer la règle sur la présence du JSON.
Grouper par élément de corps dans le widget de tableau de données
Dans le widget de tableau de données pour le dashboard d'erreurs en temps réel, l'élément de corps de réponse non chiffré peut être utilisé pour grouper les erreurs d'API par valeurs distinctes d'un chemin JSON sélectionné :
1. Créez ou sélectionnez un dashboard d'erreurs en temps réel.
2. Ajoutez un widget.
3. Sélectionnez le type de widget "Tableau de données".
4. Procédez comme d'habitude pour les champs du widget.
5. Assurez-vous de sélectionner une métrique basée sur une erreur d'API.
6. Dans le champ “Grouper par”, sélectionnez l'un des chemins JSON d'élément de corps de réponse non chiffré collectés dans la liste (provenant des règles créées).
7. Créez le widget.
Vous aurez maintenant un tableau de valeurs distinctes pour un chemin JSON d'élément de corps spécifique trié par ordre décroissant pour obtenir les erreurs les plus impactantes (selon l'image ci-dessous).
Filtrer sur la valeur de l'élément de corps depuis le widget de tableau
Si vous souhaitez analyser les sessions qui ont rencontré une erreur d'API avec une valeur d'élément de corps spécifique, le moyen le plus simple de construire ce filtre est d'utiliser le raccourci “Appliquer comme segment” depuis le tableau widget listant les différentes valeurs d'un élément de corps.
Une fois cela fait, le Contexte d'analyse sera automatiquement rempli avec la valeur. Il devient alors facile de :
- Analyser ce contexte dans d'autres modules (par ex. dans l'Impact Quantification) car il sera persistant.
- L'enregistrer comme segment afin de pouvoir l'utiliser pour un widget dans un dashboard régulier, ou ailleurs.
FAQ
Pourquoi configurer le dépannage d'API et comment cela peut-il aider mon entreprise ?
Le dépannage d'API est un module de débogage avancé conçu pour améliorer la performance opérationnelle des équipes de support technique. Il facilite la collecte de toutes les informations nécessaires pour comprendre et résoudre les bugs d'API.
Bien que vous puissiez commencer par utiliser l'Error Analysis sans le dépannage d'API, il deviendra inestimable une fois que vous aurez besoin de détails plus approfondis sur des erreurs spécifiques.
Considérez une situation où l'Error Analysis recueille des erreurs HTTP 4XX. Ces erreurs signifient des problèmes côté client (c'est-à-dire liés au navigateur), tels que :
- Appels d'API mal formatés par le navigateur, empêchant le serveur d'API de les comprendre
- Paramètres manquants ou incorrects
- Problèmes d'autorisation
Sans visibilité sur les données transmises lors de l'appel d'API, il est difficile pour les équipes de diagnostiquer et de corriger ces bugs. Fournir les paramètres de requête et de réponse d'API aide à comprendre l'orchestration complète de l'appel d'API et à déboguer le problème.
Cette visibilité complète accélère considérablement le processus de validation des tickets pour les équipes de support, impactant des indicateurs clés :
- Temps de première réponse : Les équipes de support peuvent comprendre et accepter les tickets plus rapidement.
- Taux de résolution au premier contact : Les équipes de support peuvent plus régulièrement initier l'analyse et la résolution sans communication extensive.
- MTTR (Temps moyen de résolution) : Le temps gagné lors de la phase de triage initial contribue à une réduction du temps de résolution global.