Les logs de l’API Experience et les alertes système sont deux outils majeurs à votre disposition pour assurer la santé et la surveillance du système.
Logs de l’API Experience
Ces logs vous donnent une vue d’ensemble approfondie des appels API côté serveur, y compris les événements, les pages vues, les clics et le choix des appels de variation. Ils vous permettent de vérifier que vos appels d’API sont corrects et d’identifier les problèmes d’implémentation. Vous pouvez également utiliser les logs pour déboguer un comportement inattendu et en trouver la cause première.
Pour accéder aux logs de l’API, allez dans Paramètres › Logs de l’API.
Détails du fichier de log de l’API
Dans la chronologie, les appels d’API sont regroupés en appels réussis, appels avec erreurs et appels avec avertissements. Survolez une barre pour obtenir plus de détails.
Sous la chronologie, un tableau répertorie les appels d’API récents qui se sont produits dans la plage de temps sélectionnée. Appuyez sur Charger plus pour afficher d’autres appels d’API.
Les champs suivants sont disponibles. Pour afficher d’autres champs, cliquez sur Colonnes en haut de la page Logs de l’API.
Colonne |
Détails |
---|---|
Point final |
Le type d’appel d’API, tel que choose ou pageview |
Détail |
Détails sur le type de demande, comme le type d’événement appelé |
ID de la demande |
Identifiant unique pour chaque appel d’API |
Statut |
Affiche le code d’état. Les codes 200 et 204 signifient que tout va bien. La description des autres codes se trouve à côté du code correspondant. |
ID utilisateur |
L’identifiant de l’utilisateur fourni dans la demande d’API |
ID de session |
L’identifiant de session fourni dans la demande d’API |
Horodatage |
Affiché avec une granularité de quelques secondes |
Durée de la demande |
La durée qu’il a fallu à la demande pour être exécutée sur les serveurs Dynamic Yield (exclut le délai de transmission) |
Vous pouvez approfondir n’importe quel appel d’API pour afficher plus de détails en cliquant n’importe où sur la ligne. Cette réponse n’est disponible que pour les logs dont la taille est inférieure à 32 ko. Si la réponse dépasse cette limite, elle n’apparaîtra pas du tout dans le fichier de log (cela ne signifie pas qu’il y a eu une erreur dans la réponse ni qu’elle n’a pas été livrée correctement).
Sélection d’un intervalle de temps
Vous spécifiez l’intervalle de temps en utilisant le sélecteur de date :
Vous pouvez également zoomer sur une plage de temps spécifique en cliquant et en faisant glisser une boîte sur la plage souhaitée.
Une bannière indiquant l’intervalle de temps que vous avez défini apparaît. Vous pouvez réinitialiser le zoom en cliquant sur X.
Filtrer le fichier de log
Cliquez sur les filtres à droite pour filtrer les appels d’API par date, durée, type, statut ou erreurs. Le nombre d’appels par filtre apparaît à côté de chaque option de filtre
Les sélections multiples sous le même type de filtre (par exemple Choose et Pageview sous Type) sont considérées comme des « OU », tandis que les sélections multiples sous différents types de filtres (par exemple Pageview sous Type et Error sous Status) sont considérées comme des « ET ».
Vous pouvez également filtrer en utilisant l’outil de recherche pour spécifier un userID ou un requestID.
Cas d’utilisation
Cas d’utilisation |
Résolution |
---|---|
Lors de l’implémentation initiale, je fais des appels à l’API pour vérifier que tous les attributs sont reçus avec les valeurs prévues (type de contexte, etc.) et qu’il n’y a pas d’avertissement. |
Ouvrez le fichier de log de l’API et surveillez les appels entrants, en utilisant le bouton d’actualisation pour afficher les derniers appels. |
Lors de l’implémentation, j’ai remarqué qu’il y avait des avertissements sur les appels d’API. |
Sélectionnez la ligne dans le fichier de log de l’API pour obtenir plus de détails. Vous pouvez voir tous les avertissements, y compris, par exemple, les UGS spécifiques manquantes. |
En production (ou dans tout autre environnement à fort volume), je soupçonne que certains appels d’API posent problème, mais je ne sais pas exactement lesquels. |
Vous pouvez zoomer sur une plage de temps spécifique qui présente un volume élevé d’erreurs ou d’avertissements. Vous pouvez également utiliser des filtres pour n’afficher que les appels d’API qui présentent les erreurs ou les avertissements que vous recherchez. |
Sur une plateforme à fort volume, je veux voir ce que fait un utilisateur. |
Saisissez son identifiant dans la barre de recherche pour appliquer un filtre sur le fichier de log. |
Quelqu’un veut me parler d’un problème en partageant un signet ou une référence à ce problème. |
Cela peut se faire en indiquant l’identifiant de l’utilisateur dans la barre de recherche. Si vous n’avez pas l’identifiant de l’utilisateur, saisissez l’ID de la requête et utilisez-le pour rechercher l’ID de l’utilisateur dans la liste filtrée des résultats. |
Je sais qu’il y a actuellement des erreurs/avertissements et je veux savoir « quand ça a cassé », afin de pouvoir (a) comprendre l’étendue du problème, (b) le corréler avec les modifications que j’ai apportées. |
Zoomez sur la plage de temps suspecte, puis utilisez des filtres pour réduire la liste des résultats à un type d’erreur ou d’avertissement spécifique. |
J’ai appliqué un correctif à une erreur ou un avertissement et je veux voir s’il n’y a plus de demandes concernant ce type de problème. |
Utilisez le contrôle de l’intervalle de temps et/ou les filtres pour voir si/quand un problème a arrêté de se produire et si le problème a été entièrement ou partiellement résolu. |
Alertes
Les alertes vous fournissent une visibilité sur le statut de l’implémentation de l’API, ce qui vous permet de communiquer facilement les problèmes d’implémentation en cours avec votre équipe informatique et d’accélérer la résolution des problèmes sous-jacents.
Comment cela fonctionne-t-il ?
- Les erreurs et les avertissements de l’API qui surviennent fréquemment sont affichés sous forme d’alerte sur le tableau de bord de l’administrateur.
- Cliquez sur Afficher le résumé du problème pour ouvrir une fenêtre contextuelle fournissant des informations sur le problème, notamment son type, sa cause et sa fréquence. Vous pouvez également cliquer sur Afficher les logs pour accéder directement à l’écran Logs de l’API.
- Vous pouvez alors afficher les logs d’erreurs ou les copier dans votre presse-papiers pour les partager avec l’équipe informatique.
- Le nombre d’alertes API est apparemment beaucoup plus élevé que le nombre de logs d’erreurs de l’API. Cela s’explique par le fait qu’une seule ligne du fichier de log d’erreurs de l’API peut présenter plusieurs problèmes et donc déclencher plusieurs alertes.
- Pour qu’une alerte apparaisse sur le tableau de bord de l’administrateur, elle doit se produire plus de 50 fois. Cela permet de s’assurer que seules les erreurs importantes et significatives déclenchent une alerte.
- Les logs d’erreurs sont sauvegardés pendant 7 jours. Si vous tentez de consulter des logs d’erreurs datant de plus de 7 jours, l’écran des logs de l’API n’affichera aucun résultat.
&nsbp;