Utilisez les détails de résolution d'erreurs d'API pour vous aider à identifier quand une erreur s'est produite et comment régler le problème.
Une fois configurées, vous pourrez :
- voir les types de détails d'erreur d'API complémentaires suivants dans le flux d'évènements de 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 de corps (éléments spécifiques des corps de requêtes/réponses)
- les paramètres de requête du point de terminaison de la requête (de l'URL de l'information que vous avez demandée).
- exploiter les éléments de corps de réponse non cryptés dans les workspaces d'erreurs et les alertes, le Contexte d'analyse et le module Error pour monitorer, identifier et quantifier les erreurs en fonction des contenus de corps de réponses.
Accéder aux détails de résolution
Vous pouvez accéder aux détails de résolution d'erreur d'API depuis le lecteur de Session Replay.
Empruntez les shortcuts vers le lecteur depuis une fiche d'erreur d'API dans :
- Error Analysis : Naviguez jusqu'au panneau latéral de l'erreur d'API ou visualisez la page de détails complète
- Workspace et Alertes : cliquez droit sur un graphique (qui illustre une métrique d'erreur d'API)
Une fois sur le replay :
- Localisez l'erreur d'API depuis le flux d'évènements ou la timeline.
- Cliquez sur le bouton "Résoudre".
Détails non cryptés
Tous les détails non cryptés apparaîtront déjà : en-têtes et éléments de corps de la requête et de la réponse (dans leurs onglets respectifs).
Détails cryptés
Pour afficher les données cryptées (en-têtes, éléments de corps, corps entier et paramètres de requêtes) :
1. Cliquez sur le bouton "Décrypter".
2. Saisissez votre clé privée dans l'onglet de votre choix et sélectionnez "Décrypter".
3. Vous verrez alors les détails d'erreur apparaître.
4. Cliquez sur "Masquer les détails cryptés" pour réappliquer le cryptage.
Utiliser des éléments de corps de réponses non cryptés
Dans le Contexte d'analyse
Là où 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.
3. Renseignez les paramètres dont vous avez besoin (page, code d'état, méthode, URL de requête).
4. Cochez la case "Élément de corps de réponse".
5. Sélectionnez le chemin JSON de l'élément de corps dans la liste tirée de la configuration.
6. Sélectionnez l'un des opérateurs :
- "existe" : si vous voulez seulement filtrer en fonction de la présence du chemin JSON
- "est égal à" : si vous voulez filtrer selon une valeur exacte
- "contient" : si vous voulez filtrer selon si des valeurs contiennent le texte saisi ou non
7. Appliquez pour enregistrer le paramètre d'élément de corps.
8. Appliquez la condition du Contexte d'analyse.
Dans les workspaces d'erreur en temps réel
Utiliser les éléments de corps comme filtres
Les éléments de corps de réponses peuvent être utilisés comme filtres sur n'importe quel type de widget (à l'exception des widgets d'image) dans les workspaces d'erreur en temps réel :
1. Créez ou sélectionnez un workspace d'erreurs en temps réel.
2. Ajoutez un nouveau widget ou modifier un widget existant (assurez-vous qu'il inclut bien la métrique d'erreurs 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 cryptés dans la liste (provenant des règles créées).
7. Définissez une condition sur la chaîne de valeur à l'aide des divers opérateurs à votre disposition ou conservez la condition "existe" pour créer une règle de filtrage basée simplement sur la présence, ou non, d'un chemin JSON.
Grouper par élément de corps dans un widget de tableau de données
Dans les widgets de tableau de données de workspaces d'erreurs en temps réel, les éléments de corps de réponse non cryptés peuvent être utilisés pour grouper les erreurs d'API par valeurs distinctes de chemin JSON sélectionné :
1. Créez ou sélectionnez un workspace d'erreur en temps réel.
2. Ajoutez un widget.
3. Choisissez un widget de type "Tableau de données".
4. Suivez le processus habituel et remplissez les champs du widget.
5. Assurez-vous de sélectionner une métrique basée sur les erreurs d'API.
6. Dans le champ "Grouper par", sélectionnez l'un des chemins JSON d'élément de corps de réponses non cryptés de la liste (provenant des règles créées).
7. Créez le widget.
Vous aurez alors un tableau des valeurs distinctes pour un chemin JSON d'élément de corps spécifique, triées par ordre décroissant pour obtenir les erreurs les plus impactantes en premier (comme dans l'image ci-dessous).
Filtrer par valeur d'élément de corps depuis le widget de tableau
Si vous voulez 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 shortcut "Appliquer comme segment" depuis le widget de tableau listant les différentes valeurs d'un élément de corps.
Une fois cela fait, le Contexte d'analyse sera automatiquement rempli avec les valeurs. Il sera alors facile :
- d'analyser ce contexte dans d'autres modules (par exemple dans Impact Quantification) puisqu'il sera transféré automatiquement.
- d'enregistrer sous forme de segment, afin que vous puissiez l'utiliser dans un widget de workspace classique, ou ailleurs.