Lorsqu'une opération d'API de votre application SAE est lente ou échoue, la surveillance des API vous fournit les données nécessaires pour diagnostiquer le problème. Pour chaque opération, analysez les appels SQL et NoSQL, inspectez les exceptions Java, tracez les dépendances amont et aval, et interrogez des traces individuelles.
Prérequis
Avant de commencer, assurez-vous que :
Une application SAE est déployée et en cours d'exécution.
Un agent de surveillance des applications est associé à votre application.
Frameworks pris en charge
Les agents de surveillance détectent et instrumentent automatiquement les opérations d'API exposées par les frameworks web et RPC (Remote Procedure Call) suivants :
| Framework | Version minimale |
|---|---|
| Tomcat | 7+ |
| Jetty | 8+ |
| Resin | 3,0+ |
| Undertow | 1,3+ |
| WebLogic | 11,0+ |
| SpringBoot | 1.3.0+ |
| HSF | 2.0+ |
| Dubbo | 2,5+ |
Afficher les appels d'API
Connectez-vous à la console SAE. Dans le volet de navigation de gauche, choisissez Applications > Applications. Sélectionnez une région dans la barre de navigation supérieure et un namespace dans la liste déroulante Namespace, puis cliquez sur le nom de l'application.
Dans le volet de navigation de gauche, choisissez Application Monitoring > API Calls.
Le volet gauche de la page API Calls répertorie toutes les opérations d'API détectées automatiquement par les agents de surveillance. Triez la liste pour prioriser votre investigation :
| Option de tri | Utilisation recommandée |
|---|---|
| Response time (RT) | Identifier les opérations les plus lentes. |
| Number of requests | Repérer les opérations générant le trafic le plus élevé. |
| Number of errors | Localiser les opérations présentant le plus grand nombre d'échecs. |
| Number of exceptions | Trouver les opérations levant le plus d'exceptions Java. |
Les métriques disponibles varient selon le langage de programmation. Vérifiez les métriques correspondant au langage de votre application.
Catégories de métriques
Sélectionnez une opération d'API dans le volet gauche pour afficher ses métriques détaillées via les onglets suivants.
Vue d'ensemble
L'onglet Overview affiche la topologie des appels pour l'opération d'API sélectionnée ainsi que des graphiques chronologiques pour :
Le nombre de requêtes
Le nombre d'erreurs
Le temps de réponse (RT)
Les codes de statut HTTP
Analyse SQL et analyse NoSQL
Les onglets SQL Analysis et NoSql Analysis répertorient les instructions SQL et NoSQL exécutées dans le code de l'opération d'API sélectionnée. Utilisez ces onglets pour identifier les instructions à l'origine des réponses lentes.
Pour toute instruction, cliquez sur Trace Query dans la colonne Actions afin d'afficher la trace complète contenant l'exécution SQL ou NoSQL.
Analyse des exceptions
L'onglet Exception Analysis affiche les exceptions Java levées par le code de l'opération d'API sélectionnée.
Pour toute exception, cliquez sur Interface Snapshot dans la colonne Actions pour afficher la trace complète contenant la pile d'exceptions. Pour plus d'informations, consultez View traces.
Services amont et services aval
Les onglets Upstream Services et Downstream Services affichent les métriques de performance (temps de réponse, nombre de requêtes et nombre d'erreurs) pour les services qui appellent votre application et ceux que votre application appelle.
Les onglets Upstream Traces et Downstream Traces vous permettent d'explorer les détails au niveau des traces :
Cliquez sur Expand/Collapse All pour afficher ou masquer simultanément toutes les opérations d'API.
Saisissez un mot-clé dans la zone de recherche et cliquez sur l'icône de recherche pour filtrer par nom d'application ou par nom d'opération d'API.
Cliquez sur le panneau de réduction ou sur la flèche située à la fin d'une ligne pour afficher ou masquer les métriques de performance d'une opération d'API spécifique.
Analyse des erreurs
L'onglet Error Analysis affiche les erreurs et les codes de statut HTTP de l'application. Cliquez sur une valeur dans la colonne TraceId pour ouvrir les détails de la trace dans une nouvelle page. Pour plus d'informations, consultez View traces.
Interface Snapshot
L'onglet Interface Snapshot affiche les paramètres de l'opération d'API sélectionnée, accompagnés de deux graphiques et d'un tableau de détails des traces :
Graphique Total Traces : Affiche le nombre total d'appels et le nombre d'appels lents. Un appel est considéré comme lent lorsque son RT dépasse 500 millisecondes. Vous pouvez ajuster ce seuil dans les paramètres de l'application. Les appels locaux générés dans des scénarios asynchrones sont exclus du comptage des appels lents.
Graphique RT : Affiche l'évolution du temps de réponse au fil du temps. Le graphique reflète les statistiques d'appel et est influencé par le taux d'échantillonnage configuré.
Tableau des détails des traces : Répertorie les traces individuelles. Cliquez sur une valeur dans la colonne TraceId pour afficher tous les détails de la trace. Pour plus d'informations, consultez Trace query. Cliquez sur View Logs dans la colonne Actions pour afficher les journaux d'un appel spécifique.
Pour utiliser les ID de trace lors de la corrélation des journaux pendant le dépannage, associez les ID de trace aux journaux métier de votre application. Pour plus d'informations, consultez Associate trace IDs with logs for a Java application .