Vous consultez la documentation sur Apigee Edge.
Consultez la documentation sur Apigee X.
Suivez un exemple de scénario illustrant 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 de l'API pour tous les proxys d'API et les cibles ayant généré du trafic au cours de la dernière heure. Affichez le détail des proxys ou cibles d'API avec un taux d'erreur élevé. |
| 2 | Identifier les tendances des données de surveillance des API | Accédez à une vue historique de vos données de surveillance des API au cours des trois derniers mois pour obtenir une vision plus large. |
| 3 | Examiner les problèmes 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 5xx. (Les codes d'état 5xx peuvent être classés à l'aide d'un ou de plusieurs codes d'erreur.) |
| 4 | Configurer une alerte 5xx | Configurez une alerte pour être prévenu 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'entreprise pour générer un rapport personnalisé. |
| 6 | Regrouper des 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 enquête et de votre diagnostic, prenez les mesures appropriées pour résoudre les problèmes 5xx. |
Étape 1: Surveillez le trafic récent des API
Pour afficher les données de surveillance de l'API pour les proxys et les cibles d'API ayant enregistré du trafic au cours de la dernière heure:
- Sélectionnez Analyser > Surveillance des API > Récents dans l'interface utilisateur Edge pour accéder au tableau de bord Récent.
Notez les cibles et proxys d'API qui ont enregistré un taux de pourcentage d'erreur élevé au cours de la dernière heure.
Cliquez sur le proxy d'API ou la cible présentant 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 Surveiller le trafic récent des API.
Étape 2: Identifiez les tendances des données de surveillance de votre API
Pour accéder à une vue historique des données de surveillance de l'API pour les proxys et les cibles d'API ayant enregistré du trafic au cours des trois derniers mois:
- Dans le volet de droite du tableau de bord Récent, sélectionnez
> 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.
- Affichez la tendance du proxy ou de la cible de l'API au fil du temps. Notez que la tendance est la même au cours des sept derniers jours.
Pour plus d'informations sur cette étape, consultez Identifier les tendances dans les données de surveillance de votre API.
Étape 3: Analysez 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 de plusieurs codes d'erreur.
Pour examiner les problèmes 5xx:
- Dans le volet de droite du tableau de bord de la timeline, sélectionnez > Afficher dans Investigate pour accéder au tableau de bord Investigate.
Vous pouvez également cliquer sur Analyze > API Monitoring > Investigate (Analyser > Surveillance des API > Analyser) 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 et le temps. 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'ombre des couleurs d'un bloc. Plus le bloc est sombre, plus le volume relatif est élevé.
Par exemple, les codes d'erreur
policies.ratelimit.SpikeArrestViolationetpolicies.ratelimit.QuotaViolationaffichent un volume relatif plus élevé dans la matrice suivante :
Cliquez sur le bloc le plus sombre (premier bloc) sur la ligne
policies.ratelimit.SpikeArrestViolationpour afficher plus de détails dans le volet de droite.
Notez que la source d'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 cas de non-respect des règles Spike Arrest.
Affichez l'application de distribution par développeur, juste en dessous du panneau des causes possibles, pour identifier les applications qui présentent les taux d'erreur les plus élevés.
Pour en savoir plus sur cette étape, consultez Identifier les problèmes.
Étape 4: Configurez l'alerte 5xx
Configurez une alerte basée sur le 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.
Dans le volet de droite du tableau de bord Investigate, sélectionnez
> Create Alert (Créer une alerte).
Remplissez les champs de la boîte de dialogue d'alerte. Les champs de condition sont préremplis avec des données du contexte actuel. Exemple :
Cliquez sur Enregistrer.
À l'avenir, lorsque le taux d'erreur 5xx dépassera 5% pendant 5 minutes pour le proxy d'API perfBenchmark_invalid_v1, une notification sera envoyée à l'e-mail spécifié et une alerte visuelle s'affichera dans l'interface utilisateur. Exemple :
Pour en savoir plus 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)
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.
Vous pouvez accéder 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 :
Ajoutez les dimensions suivantes:
- Application de développeur
- ID client
- Adresse IP du client
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 pour développeur de la liste.
Cliquez sur Enregistrer.
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 en savoir plus sur cette étape, consultez Créer des rapports personnalisés.
Étape 6: Regroupez 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.
- Sélectionnez Analyser > Surveillance des API > Collections dans l'interface utilisateur Edge pour afficher le tableau de bord des collections.
- Cliquez sur + Collection.
- Sélectionnez Proxy.
- Sélectionnez prod dans la liste déroulante de l'environnement.
- Cliquez sur Suivant.
- Remplissez les champs de la boîte de dialogue de collecte.
- Cliquez sur Enregistrer.
Ensuite, vous pouvez configurer une alerte, comme dans 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 Gérer les collections.
Étape 7: Résolvez les problèmes 5xx
Prenez les mesures appropriées pour résoudre les problèmes 5xx. Par exemple, selon 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écider 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éveloppement peuvent établir avec votre proxy d'API sur une période donnée.
- Monétisez votre API pour facturer aux développeurs l'utilisation d'un certain nombre d'appels.