Parcourir un exemple de scénario

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

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

# Étape Description
1 Surveiller le trafic récent des API Affichez les données de surveillance récentes des API pour tous les proxys d'API et cibles ayant eu du trafic au cours de la dernière heure. Explorez les proxys d'API ou les cibles avec un taux d'erreur élevé.
2 Identifier les tendances dans les données de surveillance de votre API Accédez à une vue historique des données de surveillance de votre API jusqu'aux trois derniers mois pour obtenir une perspective plus large.
3 Examiner les problèmes 5xx Affichez les codes d'erreur qui connaissent les volumes relatifs les plus élevés au fil du temps pour examiner plus en détail la source des problèmes 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 également 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 de l'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 configurez des 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 5xx En fonction de votre examen et de votre diagnostic, prenez les mesures appropriées pour résoudre les problèmes 5xx.

Étape 1 : Surveiller le trafic récent des API

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

  1. Sélectionnez Analyze > API Monitoring > Recent (Analyser > Surveillance des API > Récent) dans l'interface utilisateur Edge pour accéder au tableau de bord "Récent".

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

  3. Cliquez sur le proxy d'API ou la cible 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 en savoir plus sur cette étape, consultez la section Surveiller le trafic récent des API.

Étape 2 : Identifier les tendances dans les données de surveillance de votre API

Pour accéder à une vue historique des données de surveillance des API pour les proxys d'API et les cibles ayant eu du trafic jusqu'aux trois derniers mois :

  1. Dans le volet de droite du tableau de bord "Récent", sélectionnez Menu "Plus" > View in Timeline (Afficher dans la chronologie) pour accéder au tableau de bord "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 d'API ou de la cible au fil du temps. Notez que la tendance est constante au cours des sept derniers jours.

Pour en savoir plus sur cette étape, consultez la section Identifier les tendances dans les données de surveillance de votre 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 "Chronologie", sélectionnez Menu "Plus" > View in Investigate (Afficher dans "Examiner") pour accéder au tableau de bord "Examiner". Vous pouvez également cliquer sur Analyze > API Monitoring > Investigate (Analyser > Surveillance des API > Examiner) dans l'interface utilisateur Edge.

    Le tableau de bord "Examiner" 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 par rapport au temps pour afficher l'activité du code d'erreur au cours de la dernière heure. Notez les codes d'erreur qui connaissent les volumes relatifs les plus élevés en fonction de la couleur d'un bloc. Plus le bloc est foncé, plus le volume relatif est élevé.

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

  3. Cliquez sur le bloc le plus foncé (premier bloc) de 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 que le code d'état HTTP est 500. Le code d'état 500 est un code d'erreur d'exécution courant pour les violations de la règle Spike Arrest.

  5. Affichez la distribution par application de développeur, juste en dessous du panneau "Cause suspectée", pour identifier les applications de développeur avec les taux d'erreur les plus élevés.

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

Étape 4 : Configurer une alerte 5xx

Configurez une alerte en fonction du contexte sélectionné dans le volet de détails "Examiner" 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 "Examiner", sélectionnez Menu "Plus" > Create Alert (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 cinq minutes pour le proxy d'API perfBenchmark_invalid_v1, une notification sera envoyée à l'adresse e-mail spécifiée et une alerte visuelle s'affichera dans l'interface utilisateur. Exemple :

Pour en savoir plus sur cette étape, consultez la section Configurer des alertes et des notifications.

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

Vous pouvez également générer 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 Analyze > Custom Reports > Reports (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 (Surveillance des API générée : alerte 5xx).

    • 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 "Application de développeur" de la liste des dimensions.

  4. Cliquez sur Enregistrer.

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

Pour en savoir plus sur cette étape, consultez la section 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 configurez des 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 prod dans le menu déroulant "Environnement".
  5. Cliquez sur Suivant.
  6. Renseignez les champs de la boîte de dialogue de la collection.
  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 en savoir plus sur cette étape, consultez la section Gérer les collections.

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

Prenez les mesures appropriées pour résoudre les problèmes 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 requêtes est suspect et décidez de bloquer l'adresse IP du client identifiée dans le rapport personnalisé.
  • Ajoutez une règle de quota pour limiter le nombre de connexions que les applications de développeur peuvent établir avec votre proxy d'API sur une période donnée.
  • Monétisez votre API pour facturer aux développeurs l'utilisation au-delà d'un certain nombre d'appels.