Parcourir un exemple de scénario

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Parcourez un exemple de scénario qui montre comment résoudre les problèmes 5xx avec vos API.

# Step Description
1 Surveiller le trafic récent des API Affichez les données récentes de surveillance des API pour tous les mandataires et les cibles d'API ayant généré du trafic au cours de la dernière heure. Affichez le détail des proxys ou des cibles d'API avec un taux d'erreur élevé.
2 Identifier les tendances dans vos données de surveillance d'API Accédez à un historique des données de surveillance de vos API au cours des trois derniers mois pour obtenir une perspective plus large.
3 Examiner les problèmes liés à 5xx Affichez les codes d'erreur qui rencontrent les volumes relatifs les plus élevés au fil du temps pour étudier plus en détail la source des problèmes de 5xx. (En règle générale, les codes d’état 5xx peuvent être classés à l’aide d’un ou plusieurs codes d’erreur.)
4 Configurer une alerte 5xx Configurez une alerte pour être averti lorsque le nombre de codes d’état 5xx dépasse un seuil particulier.
5 Générer un rapport personnalisé avec les détails du client (facultatif) Vous pouvez éventuellement générer un rapport personnalisé pour identifier les détails du client qui déclenche les erreurs 5xx.

Remarque: vous devez être un administrateur d'organisation pour générer un rapport personnalisé.
6 Regrouper les proxys d'API dans une collection Créez une collection pour regrouper les proxys d'API et définissez les valeurs de seuil d'alerte appropriées pour tous les membres du groupe afin de diagnostiquer les problèmes plus rapidement.
7 Résoudre les problèmes liés aux codes 5xx En fonction de votre enquête et de votre diagnostic, prenez les mesures appropriées pour résoudre les problèmes de 5xx.

Étape 1: Surveillez le trafic récent de l'API

Pour afficher les données de surveillance des API pour les mandataires et les cibles d'API ayant eu du trafic au cours de la dernière heure:

  1. Sélectionnez Analyser > Surveillance des API > Récent dans l'interface utilisateur Edge pour accéder au tableau de bord récent.

  2. Notez les proxys et les cibles d'API qui ont eu un taux d'erreur élevé au cours de la dernière heure.

  3. Cliquez sur le proxy ou la cible de l'API avec un taux d'erreur élevé pour afficher les détails dans le volet de droite. Notez le pourcentage élevé d'erreurs 5xx dans cet exemple.

Pour plus d'informations sur cette étape, consultez Contrôler le trafic récent de l'API.

Étape 2: Identifiez les tendances dans vos données de surveillance des API

Pour accéder à une vue historique des données de surveillance des API pour les mandataires et les cibles d'API ayant généré du trafic au cours des trois derniers mois:

  1. Dans le volet de droite du tableau de bord Récent, sélectionnez Menu Plus > Afficher dans la chronologie pour accéder au tableau de bord de la chronologie. Vous pouvez également cliquer sur Analyze > API Monitoring > Timeline (Analyser > Surveillance des API > Chronologie) dans l'interface utilisateur Edge.
  2. Affichez la tendance du proxy ou de la cible de l'API au fil du temps. Notez que la tendance est constante au cours des sept derniers jours.

Pour plus d'informations sur cette étape, consultez Identifier les tendances dans vos données de surveillance d'API.

Étape 3: Examiner les problèmes 5xx

Apigee fournit un ensemble de codes d'erreur qui vous aident à diagnostiquer les problèmes. En règle générale, les codes d’état 5xx peuvent être classés à l’aide d’un ou plusieurs codes d’erreur.

Pour examiner les problèmes 5xx:

  1. Dans le volet de droite du tableau de bord de la chronologie, sélectionnez Menu Plus > Afficher dans Enquêter pour accéder au tableau de bord Enquêter. Vous pouvez également cliquer sur Analyser > Surveillance des API > Enquêter dans l'interface utilisateur Edge.

    Le tableau de bord Investigate vous permet de comparer l'activité relationnelle entre les métriques, telles que le code d'erreur par rapport au temps.

  2. Affichez la matrice de code d'erreur en fonction du temps pour afficher l'activité du code d'erreur au cours de la dernière heure. Notez les codes d'erreur qui rencontrent les volumes relatifs les plus élevés en fonction de l'ombrage des couleurs d'un bloc. Plus le bloc est sombre, plus le volume relatif est élevé.

    Par exemple, les codes d'erreur policies.ratelimit.SpikeArrestViolation et policies.ratelimit.QuotaViolation indiquent un volume relatif plus élevé dans la matrice suivante : Codes d'erreur

  3. Cliquez sur le bloc le plus sombre (premier bloc) sur la ligne policies.ratelimit.SpikeArrestViolation pour afficher plus de détails dans le volet de droite.

  4. Notez que la source de l'erreur est le proxy d'API perfBenchmark_invalid_v1 et le code d'état HTTP est 500. Un code d'état 500 est un code d'erreur d'exécution courant pour les cas de non-respect de la stratégie Spike Arrest.

  5. Consultez l'application "Distribution par des développeurs", juste en dessous du panneau "Causes probables" pour identifier les applications de développement présentant les taux d'erreur les plus élevés.

Pour en savoir plus sur cette étape, consultez Identifier les problèmes.

Étape 4: Configurer l'alerte 5xx

Configurez une alerte en fonction du contexte sélectionné dans le volet Détails de l'enquête pour être averti lorsque le nombre de codes d'état 5xx dépasse un seuil spécifique.

  1. Dans le volet de droite du tableau de bord d'investigation, sélectionnez Menu Plus > Créer une alerte.

  2. Renseignez les champs de la boîte de dialogue d'alerte. Les champs de condition sont préremplis avec les données du contexte actuel. Exemple :

  3. Cliquez sur Enregistrer.

À l'avenir, lorsque le taux d'erreur 5xx dépassera 5% pendant une période de 5 minutes pour le proxy d'API perfBenchmark_invalid_v1, une notification est envoyée à l'adresse e-mail spécifiée et une alerte visuelle s'affichera dans l'interface utilisateur. Exemple :

Pour plus d'informations sur cette étape, consultez Configurer des alertes et des notifications.

Étape 5: Générer un rapport personnalisé avec les détails du client (facultatif)

Si vous le souhaitez, générez un rapport personnalisé pour identifier plus de détails sur le client qui déclenche les erreurs 5xx.

Sur la page Rapports, les rapports personnalisés créés en fonction d'une alerte sont nommés selon le format suivant: API Monitoring Generated: alert-name.

  1. Accédez au rapport personnalisé créé lors de la configuration de l'alerte de l'une des manières suivantes:

    • Sélectionnez Analyser > Rapports personnalisés > Rapports dans la barre de navigation de gauche pour afficher la page "Rapports". Cliquez sur le nom du rapport dans la liste: API Monitoring Generated: 5xx Alert

    • Cliquez dans la notification qui s'affiche lorsque l'alerte est créée. Exemple :

  2. Ajoutez les dimensions suivantes:

    • Application de développeur
    • ID client
    • Adresse IP du client

  3. Pour afficher un rapport basé sur une application de développeur spécifique avec un taux d'erreur élevé, ajoutez un filtre semblable à celui-ci:

    and (developer_app eq 'perfBenchmarkApp0')

    Remarque: Dans ce cas, supprimez Developer App de la liste des dimensions.

  4. Cliquez sur Enregistrer.

  5. Exécutez le rapport pour afficher les détails de l'application de développement et des clients qui déclenchent le code d'état 5xx.

Pour plus d'informations sur cette étape, voir Créer des rapports personnalisés.

Étape 6: Regrouper les proxys d'API dans une collection

Créez une collection pour regrouper les proxys d'API et définissez les valeurs de seuil d'alerte appropriées pour tous les membres du groupe afin de diagnostiquer les problèmes plus rapidement.

  1. Sélectionnez Analyze > API Monitoring > Collections (Analyser > Surveillance des API > Collections) dans l'interface utilisateur Edge pour afficher le tableau de bord Collections.
  2. Cliquez sur + Collection.
  3. Sélectionnez Proxy.
  4. Sélectionnez le prod dans la liste déroulante Environnement.
  5. Cliquez sur Suivant.
  6. Renseignez les champs de la boîte de dialogue de collecte.
  7. Cliquez sur Enregistrer.

Vous pouvez ensuite configurer une alerte, comme à l'étape 4, et définir la dimension sur la collection que vous avez définie ci-dessus.

Pour plus d'informations sur cette étape, consultez Gérer les collections.

Étape 7: Résolvez les problèmes 5xx

Prendre les mesures appropriées pour résoudre les problèmes de 5xx. Par exemple, en fonction de votre diagnostic, vous pouvez effectuer l'une des tâches suivantes:

  • Utilisez Apigee Sense pour déterminer si le pic de demandes est suspect et décidez de bloquer l'adresse IP du client identifiée dans le rapport personnalisé.
  • Ajoutez une règle de quotas pour limiter le nombre de connexions que les applications des développeurs peuvent établir avec votre proxy d'API sur une période donnée.
  • Monétisez votre API afin de facturer les développeurs pour une utilisation sur un certain nombre d'appels.