Configurer les alertes et les notifications

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

L'un des principaux objectifs de l'API Monitoring consiste à vous tenir informé des événements ou des schémas inhabituels, tels que des pics de trafic ou de latence. Pour effectuer le suivi d'événements de ce type, vous pouvez configurer des alertes qui se déclenchent en cas de survenance d'un événement spécifié. Un événement effectif qui déclenche une alerte est appelé incident.

Vous pouvez définir des règles spécifiques pour une alerte. Par exemple, une alerte peut être déclenchée lorsque le nombre de requêtes API dépasse 3 600 sur une période d'une minute. Lorsqu'un incident correspondant à l'alerte se produit, vous pouvez en consulter les détails dans le volet Événements du tableau de bord des alertes de Cloud Console.

Pour définir une règle d'alerte, vous devez utiliser deux propriétés principales :

  • La métrique : quantité qui déclenche l'alerte, par exemple, le nombre de requêtes.
  • Le seuil : niveau que la métrique doit atteindre pour déclencher l'alerte.

Si vous souhaitez être averti lorsqu'une alerte particulière est déclenchée, vous pouvez configurer une notification. Lorsqu'un incident se produit, Apigee vous envoie une notification contenant un résumé de l'événement, y compris des liens vers Cloud Console et l'interface utilisateur d'Apigee, pour un examen plus approfondi.

Pour en savoir plus sur les alertes, consultez la section Présentation des alertes.

Étapes initiales de création d'une alerte

Pour créer une alerte, commencez par réaliser les étapes ci-dessous.

  1. Ouvrez le tableau de bord Créer une règle d'alerte dans Google Cloud Console.

    Remarque : Ouvrez le tableau de bord "Créer une règle d'alerte" dans un nouvel onglet pour suivre les étapes ci-dessous.

    Page "Créer une règle d'alerte"

  2. Cliquez sur AJOUTER UNE CONDITION. Une nouvelle fenêtre s'ouvre, dans laquelle vous pouvez ajouter la condition d'alerte.

    Configurez une alerte.

  3. Facultatif : ajoutez un intitulé pour la condition dans le champ Condition sans titre. Dans cet exemple, nous allons laisser ce champ vide : la condition se voit alors attribuer le titre par défaut.
  4. Copiez et collez la commande suivante dans le champ Find resource type and metric (Trouver le type de ressource et la métrique) :

    Apigee proxy (v2)

    Le volet Cible s'affiche désormais comme illustré ci-dessous.

    Sélectionnez une métrique.

    Le volet affiche le champ Sélectionner une métrique, dans lequel vous pouvez spécifier la métrique, par exemple le trafic total ou le centile de latence.

Une fois que vous avez réalisé les étapes initiales décrites ci-dessus, vous pouvez continuer en sélectionnant une métrique et en ajoutant des conditions pour l'alerte dans le volet Configuration.

Les deux sections suivantes présentent des exemples illustrant cette procédure :

Alerte de pic de trafic

Les sections suivantes montrent comment créer une alerte qui se déclenche lorsque le trafic total de l'API est supérieur à 3 600 pendant une minute.

Premières étapes

Pour configurer l'alerte, commencez par effectuer les étapes initiales décrites dans la section précédente. Lorsque vous avez terminé, ajoutez les paramètres décrits ci-dessous.

Paramètres de ciblage

Dans le volet "Cible" :

  1. Copiez l'un des exemples de code ci-dessous, selon que vous souhaitez ou non recevoir une alerte pour les requêtes ou les réponses, et collez-le dans le champ Sélectionner une métrique.

    Requêtes

    apigee.googleapis.com/proxyV2/request_count

    Réponses

    apigee.googleapis.com/proxyV2/response_count
  2. Cliquez sur le champ Sélectionner une métrique, puis sélectionnez Cumul de requêtes de proxy Apigee ou Cumul de réponses de proxy Apigee.

    Find resource type and metric (rechercher le type de ressource et la métrique)

    Les champs indiqués ci-dessous s'affichent.

    Sélectionnez des options de cible.

  3. Dans le champ Agrégateur, sélectionnez somme. Cela comptabilise le trafic total sur l'intervalle de temps spécifié par la Période.
  4. Définissez Période sur 1 minute.

    Ces paramètres déclenchent une alerte en fonction du nombre total de requêtes dans chaque intervalle d'une minute au cours de la période spécifiée.

Paramètres de configuration

Les paramètres de configuration spécifient les conditions qui déclenchent l'alerte. Le Seuil est la valeur minimale de la quantité spécifiée dans la section Cible (dans ce cas, le nombre de requêtes par seconde), définie pour désactiver l'alerte.

Par exemple, supposons que vous souhaitiez déclencher l'alerte si le trafic total est supérieur à 36 dans un intervalle d'une minute. Étant donné que le seuil est mesuré en requêtes par seconde, vous devez diviser 3 600 par 60 pour obtenir un seuil de 60.

Saisissez les informations suivantes dans le volet de configuration :

  • Définissez Threshold (Seuil) sur 60.
  • Définissez le paramètre For (Pendant) sur 1 minute.

Le volet "Configuration" s'affiche désormais comme illustré ci-dessous.

Paramètres de configuration

Enfin, cliquez sur AJOUTER pour ajouter la condition d'alerte. Vous revenez au tableau de bord "Créer une règle d'alerte", qui affiche désormais la nouvelle condition, comme illustré ci-dessous.

Nouvelle condition ajoutée.

Vous pouvez alors choisir l'une des options suivantes :

  • Cliquer sur AJOUTER une condition pour créer une autre condition associée à l'alerte, ou
  • Cliquez sur SUIVANT pour passer à l'étape 2, où vous aurez la possibilité de [créer une notification pour l'alerte](#creating-a-notification-for-an-alert), comme décrit dans la section suivante.

Si vous ne souhaitez pas créer de notification, cliquez deux fois sur SUIVANT sans rien saisir pour contourner les étapes 2 et 3.

Cliquez sur ENREGISTRER pour enregistrer l'alerte.

Afficher les détails de l'incident

Un événement d'API qui déclenche une alerte est appelé un incident. Vous pouvez consulter les détails des incidents récents dans le tableau de bord des alertes de Cloud Console.

Métriques et filtres

Cette section décrit les métriques et les filtres que vous pouvez utiliser pour créer des alertes.

Métriques

Une métrique correspond à la quantité qui déclenche une alerte, par exemple le nombre de requêtes. Le tableau ci-dessous présente les métriques disponibles.

Métrique Description
apigee.googleapis.com/proxyv2/request_count Nombre total de requêtes reçues par le proxy d'API Apigee.
apigee.googleapis.com/proxyv2/response_count Nombre total de réponses renvoyées par le proxy d'API Apigee.
apigee.googleapis.com/proxyv2/latencies_percentile Pourcentage de toutes les réponses de proxy d'API à une requête.

Filtres

Les filtres vous permettent de créer des alertes pour des sous-ensembles de données d'API. Un filtre spécifie une condition qui définit le sous-ensemble. Par exemple, vous pouvez créer une alerte basée sur les données d'un seul proxy.

Vous pouvez choisir l'un des filtres suivants :

Filtre Description Métriques pour lesquelles le filtre peut être appliqué
env Environnement pour les données. Tous
location Emplacement pour les données. Tous
proxy_name Proxy pour les données. Tous
runtime_version Version d'exécution pour les données. Tous
instance_id ID d'instance pour les données. Tous
method Méthode HTTP pour les données. Tous
response_code Code de réponse HTTP pour les données. apigee.googleapis.com/proxyv2/response_count
fault_code Code d'erreur pour les données. apigee.googleapis.com/proxyv2/response_count
fault_source Source d'erreur pour les données. apigee.googleapis.com/proxyv2/response_count
percentile Centile de latences de réponse de proxy Apigee. apigee.googleapis.com/proxyv2/latencies_percentile

Créer une notification pour une alerte

Si vous souhaitez être averti immédiatement en cas d'incident, vous pouvez créer une notification pour l'alerte. Lorsque l'alerte est déclenchée, Apigee vous envoie une notification. Vous pouvez choisir l'un des canaux suivants pour recevoir la notification :

  • Adresse e-mail
  • PagerDuty
  • Slack
  • Webhook

Pour créer une notification pour une alerte, procédez comme suit :

  1. Si vous venez de créer l'alerte (comme illustré dans l'exemple précédent) et que vous affichez actuellement le tableau de bord Créer une règle d'alerte, passez à l'étape suivante.

    Sinon, ouvrez le volet Règles du tableau de bord des alertes Cloud Console, puis cliquez sur les trois points sur la ligne correspondant à l'alerte que vous avez créée et sélectionnez Modifier.

    Options de notification

    Le tableau de bord Modifier la règle d'alerte s'ouvre :

    Options de notification
  2. Dans la section Que voulez-vous surveiller ?, cliquez sur SUIVANT.

    Options de notification
  3. Dans la section Qui doit être informé, sélectionnez Canaux de notification. Vous pourrez choisir parmi les canaux existants pour recevoir des notifications.

    Si vous souhaitez créer un canal de notification, sélectionnez GÉRER LES CANAUX DE NOTIFICATION. Cela ouvre le tableau de bord "Canaux de notification" dans Cloud Console, où vous pouvez ajouter des canaux. Pour plus d'informations, consultez la section Gérer les canaux de notification.

  4. Cliquez sur NEXT (Suivant). Les options s'affichent, comme illustré ci-dessous.

    Options de notification
  5. Dans le champ Nom de l'alerte, saisissez le nom de l'alerte.
  6. Dans le champ Documentation, saisissez l'URL d'une page Web incluant des informations sur la façon de résoudre le problème à l'origine de l'alerte. L'URL sera incluse dans l'e-mail de notification.
  7. Cliquez sur Enregistrer pour créer l'alerte.

Lorsqu'une alerte est déclenchée, vous recevez un e-mail de notification contenant un résumé de l'incident et indiquant quand elle s'est produite. La notification contient également deux liens pour vous aider à examiner l'incident :

  • AFFICHER L'INCIDENT : affichez l'incident dans Cloud Console.
  • AFFICHER DANS APIGEE : affichez un graphique de chronologie du trafic de l'API et des tables de données associées dans le tableau de bord "Examen" de l'API Monitoring.

Alerte de latence

La section suivante montre comment créer une alerte déclenchée lorsque le 90e centile de latence de l'API est supérieur à 600 ms pendant 10 minutes.

Premières étapes

Pour créer l'alerte, commencez par réaliser les étapes initiales décrite dans la première section. Une fois ceci fait, la section "Cible" s'affiche, comme illustré ci-dessous.

Sélectionnez une métrique.

Paramètres de ciblage

Ensuite, procédez comme suit dans le volet Cible :

  1. Copiez le code ci-dessous et collez-le dans le champ Sélectionner une métrique.
    apigee.googleapis.com/ProxyV2/latencies-percentile

    ou sélectionnez Centile de la réponse du proxy Apigee.

    Sélectionner une métrique de latence.

  2. Sous Filter (Filtre), cliquez dans le champ Add a filter (Ajouter un filtre) et sélectionnez percentile.

    Sélectionnez une métrique.

  3. Dans le champ Value (Valeur) qui s'affiche sous Select a metric (Sélectionner une métrique), sélectionnez 90.

    Sélectionnez une métrique.

  4. Cliquez sur Appliquer.

Paramètres de configuration

Dans le volet Configuration, procédez comme suit :

  1. Définissez le SEUIL sur 600.

    Sélectionner un seuil.

Avec ces paramètres, une alerte se déclenche lorsque le 90e centile de la latence de l'API est supérieur à 600 pendant 10 minutes.

L'interface utilisateur affiche le graphique de latence avec le seuil, comme illustré ci-dessous.

Sélectionnez une métrique.

Pour créer l'alerte, cliquez sur Ajouter en bas de l'interface utilisateur. Vous revenez ainsi au tableau de bord "Créer une règle d'alerte".

Pour apprendre à créer une notification pour l'alerte, consultez la section Créer une notification.