API Gateway:Configurer les alertes pour les API

1. Associer des ressources

La fonctionnalité de surveillance et d'alerte d'API Gateway répond à divers besoins métier. API Gateway prend en charge les métriques de surveillance suivantes :

• HttpStatusCode

• Temps de réponse de l'API

• Nombre total de requêtes API

• Trafic entrant

• Trafic sortant

Utilisez l'une des méthodes suivantes pour créer une règle d'alerte et l'associer à une ou plusieurs API :

• Associez manuellement une ou plusieurs API. Cette méthode convient lorsque vous souhaitez appliquer la même règle d'alerte à des API spécifiques. La règle d'alerte n'est pas affectée si la configuration de l'API est modifiée.

• Associez un groupe d'API. Cela applique la même règle d'alerte à toutes les API du groupe afin de surveiller leur statut d'appel. Si vous ajoutez, supprimez ou modifiez des API dans le groupe, la règle d'alerte est automatiquement synchronisée.

• Associez toutes les ressources. Cela applique la règle à toutes les API d'API Gateway sous votre compte. Cette approche est recommandée pour les scénarios où vous gérez un nombre restreint d'API.

2. Configurer les niveaux et les méthodes d'alerte

CloudMonitor peut déclencher des alertes Critique, Avertissement ou Information, selon la plage de seuil. Chaque niveau peut envoyer des notifications via différents canaux. Pour plus de détails sur les notifications d'alerte, consultez Vue d'ensemble.

• Critique : Appel téléphonique + SMS + e-mail + robot de discussion DingTalk (fonctionnalité payante).

• Avertissement : SMS + e-mail + robot de discussion DingTalk.

• Information : E-mail + robot de discussion DingTalk.

3. Associer une règle d'alerte à une ou plusieurs API

Pour plus de détails sur la configuration des modèles d'alerte, des règles d'alerte, des contacts de notification et des notifications d'alerte, consultez Vue d'ensemble.

1. Connectez-vous à la console API Gateway et sélectionnez une région. Dans le volet de navigation de gauche, choisissez API Management > API List, puis repérez l'API à laquelle vous souhaitez ajouter une règle d'alerte.

2. Dans la liste API List, cliquez sur le nom de l'API pour ouvrir sa page de détails. Dans le volet de navigation de gauche, cliquez sur Monitoring. Ensuite, cliquez sur Alert dans le coin supérieur droit pour accéder à la console CloudMonitor.

3. Sur la page Alert Rules, cliquez sur Create Alert Rule. Sur la page Create Alert Rule, définissez Product sur API Gateway et Resource Range sur Instance. Cliquez sur Add Instance ci-dessous. Dans la boîte de dialogue Add Instance, sélectionnez les API que vous souhaitez ajouter.

4. Associer une règle d'alerte à un groupe d'API

1. Pour appliquer la même règle d'alerte à toutes les API d'un groupe d'API, accédez à la page de détails du groupe et cliquez sur Enable CloudMonitor dans le coin supérieur droit.

2. Lorsque vous configurez CloudMonitor pour un groupe d'API pour la première fois, une boîte de dialogue vous invite à créer un rôle lié au service AliyunServiceRoleForApiGatewayMonitoring.

3. Après avoir cliqué sur OK, un message indique que CloudMonitor est activé et fournit le nom du groupe d'applications correspondant dans CloudMonitor. Avec votre autorisation, API Gateway crée ce groupe d'applications pour refléter le groupe d'API actuel. Le nom suit le format APIGATEWAY_${region}_${groupId}, où region correspond à la région du groupe d'API et groupId à son ID.

4. Une fois CloudMonitor activé, cliquez sur Go to CloudMonitor to Configure sur la page de détails du groupe pour configurer directement les règles d'alerte pour le groupe d'applications actuel.

5. Associer une règle d'alerte à toutes les API

La procédure est identique à celle décrite dans Créer une règle d'alerte pour une ou plusieurs API, sauf que vous devez définir Resource Range sur « All Resources ». Une fois configuré, la même règle d'alerte s'applique à toutes les API dans toutes les régions d'API Gateway sous votre compte. Avec cette méthode, vous ne pouvez pas sélectionner des API spécifiques.

6. Règles d'alerte prises en charge par API Gateway

Vous pouvez configurer des alertes basées sur cinq métriques fournies par API Gateway : HttpStatusCode, temps de réponse de l'API, nombre total de requêtes API, trafic entrant et trafic sortant.

• Temps de réponse d'une API : il s'agit du temps de réponse d'un service backend.

• Nombre total de requêtes pour une API : il correspond au nombre total de requêtes reçues par API Gateway pour une API spécifique provenant des clients sur une période donnée.

• Trafic entrant : il représente le trafic des requêtes reçues par API Gateway en provenance des clients sur une période donnée.

• Trafic sortant : il désigne le trafic des requêtes envoyées aux services backend depuis API Gateway sur une période donnée.

• Code d'état HTTP : il s'agit des codes d'état renvoyés par API Gateway. Les codes d'état HTTP suivants sont pris en charge :

- Code d'état HTTP 2XX : La requête API a été reçue. Remarque : La réception d'une requête n'indique pas que l'opération souhaitée par la requête a réussi.

- Code d'état HTTP 4XX : Une erreur se produit côté client, telle qu'une erreur de paramètre.

- Code 5XX : Indique une erreur côté serveur. Les développeurs d'API doivent généralement surveiller ces erreurs de près.

7. Notes d'utilisation

• Vous pouvez configurer une règle d'alerte en fonction de l'environnement dans lequel votre API est publiée. Si une règle d'alerte configurée pour une API publiée dans un VPC ne prend pas effet, nous vous recommandons d'effectuer les opérations suivantes : Connectez-vous à la console API Gateway, repérez l'API, puis cliquez sur son nom pour accéder à la page de détails de l'API. Dans l'arborescence de navigation de gauche, cliquez sur Monitoring. Sur la page Monitoring Data, vérifiez si vous pouvez interroger les données de surveillance de l'API par environnement. Si vous ne pouvez pas interroger les données de surveillance par environnement, soumettez un ticket pour mettre à jour la version de votre instance API Gateway.