Tutoriel : Surveiller les API publiées

  • Article

S’APPLIQUE À : Tous les niveaux de Gestion des API

Avec Azure Monitor, vous pouvez visualiser, interroger, router, archiver et exploiter les métriques ou les journaux provenant de votre service Gestion des API Azure.

Dans ce tutoriel, vous allez apprendre à :

  • Afficher les métriques de votre API
  • Configurer une règle d’alerte
  • Afficher les journaux d’activité
  • Activer et afficher les journaux de ressources

Notes

Gestion des API prend en charge une gamme d’outils supplémentaires pour observer les API, notamment l’analytique intégrée et l’intégration à Application Insights. En savoir plus

Prérequis

Afficher les métriques de vos API

Le service Gestion des API émet des métriques chaque minute, pour une visibilité en quasi temps réel de l’intégrité de vos API. Vous trouverez ci-après les deux métriques les plus fréquemment utilisées. Pour obtenir la liste de toutes les métriques disponibles, consultez Métriques prises en charge.

  • Capacité : vous aide à prendre des décisions concernant la mise à niveau/le passage à une version antérieure de vos services Gestion des API. La métrique est émise chaque minute et reflète l’estimation de la capacité de la passerelle au moment de la création du rapport. Le calcul de cette métrique, dont la valeur est comprise entre 0 et 100, repose sur les ressources de la passerelle, telles que l’utilisation du processeur et de la mémoire.
  • Demandes : vous aide à analyser le trafic d’API transitant par vos services Gestion des API. Cette métrique est émise à une fréquence d’une minute. Elle indique le nombre de demandes de passerelle avec les dimensions. Vous pouvez filtrer les demandes par codes de réponse, emplacement, nom d’hôte et erreurs.

Important

Les métriques suivantes sont dépréciées à compter du mois de mai 2019, et seront supprimées en août 2023 : Nombre total de demandes de la passerelle, Demandes de la passerelle ayant abouti, Demandes de la passerelle non autorisées, Demandes de la passerelle ayant échoué, Autres demandes de la passerelle. Effectuez une migration vers la métrique Demandes, qui fournit des fonctionnalités équivalentes.

Capture d’écran des métriques dans la vue d’ensemble de la Gestion des API

Pour accéder aux métriques :

  1. Dans le portail Azure, accédez à votre instance APIM. Dans la page Vue d’ensemble, sous l’onglet Monitorer, passez en revue les principales métriques de vos API.

  2. Pour investiguer les métriques en détail, sélectionnez Métriques dans le menu de gauche.

    Capture d’écran de l’élément Métriques dans le menu Monitoring du portail.

  3. Dans la liste déroulante, sélectionnez les métriques qui vous intéressent. Par exemple, Demandes.

  4. Le graphique affiche le nombre total d’appels d’API. Ajustez l’intervalle de temps pour vous concentrer sur les périodes qui vous intéressent.

  5. Vous pouvez filtrer le graphique en utilisant les dimensions de la métrique Demandes. Par exemple, sélectionnez Ajouter un filtre, sélectionnez Catégorie de code de réponse de back-end et entrez 500 comme valeur. Le graphique montre le nombre de demandes qui ont échoué dans le back-end d’API.

Configurer une règle d’alerte

Vous pouvez recevoir des alertes en fonction des métriques et des journaux d’activité. Dans Azure Monitor, configurez une règle d’alerte pour effectuer une action quand elle se déclenche. Les actions courantes sont les suivantes :

  • Envoyer un e-mail de notification
  • Appeler un webhook
  • Appeler une application logique Azure

Pour configurer un exemple de règle d’alerte basée sur une métrique de demande :

  1. Dans le portail Azure, accédez à votre instance APIM.

  2. Sélectionnez Alertes dans le menu de gauche.

    Capture d’écran de l’option Alertes dans le menu Monitoring du portail.

  3. Sélectionnez + Créer>Règle d’alerte.

  4. Dans la fenêtre Sélectionner un signal sous l’onglet Condition :

    1. Dans Type de signal, sélectionnez Métriques.
    2. Dans Nom du signal, sélectionnez Demandes.
    3. Dans Logique d’alerte, spécifiez une Valeur de seuil qui est le nombre d’occurrences au-delà duquel l’alerte doit être déclenchée.
    4. Dans Diviser par dimensions, dans Nom de la dimension, sélectionnez Catégorie de codes de réponse de passerelle.
    5. Dans Valeurs de dimension, sélectionnez 4xx pour les erreurs de client telles que les demandes non autorisées ou non valides. Si la valeur de dimension n’apparaît pas, sélectionnez Ajouter une valeur personnalisée et entrez 4xx.
    6. Dans Quand évaluer, acceptez les paramètres par défaut ou sélectionnez d’autres paramètres pour configurer la fréquence d’exécution de la règle. Sélectionnez Suivant.

    Capture d’écran de la configuration de la logique d’alerte dans le portail.

  5. Sous l’onglet Actions, sélectionnez ou créez un ou plusieurs groupes d’actions pour informer les utilisateurs de l’alerte et effectuer une action. Par exemple, créez un groupe d’actions pour envoyer un e-mail de notification à admin@contoso.com. Pour le détail des étapes, consultez Créer et gérer des groupes d’actions dans le portail Azure.

    Capture d’écran de la configuration des notifications pour le nouveau groupe d’actions dans le portail.

  6. Sous l’onglet Détails de Créer une règle d’alerte, entrez un nom et une description de la règle d’alerte, puis sélectionnez le niveau de gravité.

  7. Configurez les paramètres restants (facultatif). Sous l’onglet Vérifier + créer, sélectionnez Créer.

  8. À présent, testez la règle d’alerte en appelant l’API de conférence sans clé API. Par exemple :

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    Une alerte est déclenchée en fonction de la période d’évaluation, et un e-mail est envoyé à admin@contoso.com.

    Les alertes s’affichent également dans la page Alertes pour l’instance de Gestion des API.

    Capture d’écran des alertes dans le portail.

Journaux d’activité

Les journaux d’activité fournissent des insights sur les opérations effectuées sur les services Gestion des API. Avec les journaux d’activité, vous pouvez déterminer « qui, quand et quoi » pour toutes les opérations d’écriture (PUT, POST, DELETE) sur vos services de Gestion des API.

Notes

Les journaux d’activité n’incluent pas les opérations de lecture (GET) ou les opérations effectuées dans le portail Azure ou utilisant les API de gestion d’origine.

Vous pouvez accéder aux journaux d’activité dans votre service de Gestion des API, ou accéder aux journaux d’activité de toutes vos ressources Azure dans Azure Monitor.

Capture d’écran du journal d’activité dans le portail.

Pour afficher le journal d’activité :

  1. Dans le portail Azure, accédez à votre instance APIM.

  2. Sélectionnez Journal d’activité.

    Capture d’écran de l’élément Journal d’activité dans le menu Monitoring du portail.

  3. Sélectionnez l’étendue de filtrage souhaitée, puis Appliquer.

Journaux d’activité de ressources

Les journaux de ressources (les journaux Azure Monitor) offrent des informations détaillées sur les opérations et les erreurs de Gestion des API qui sont importantes pour l’audit et la résolution des problèmes. Lorsqu’ils sont activés via un paramètre de diagnostic, les journaux collectent des informations sur les demandes d’API reçues et traitées par la passerelle Gestion des API.

Notes

Le niveau Consommation ne prend pas en charge la collection de journaux de ressources.

Pour configurer les journaux de ressources :

  1. Dans le portail Azure, accédez à votre instance APIM.

  2. Sélectionnez Paramètres de diagnostic.

    Capture d’écran de l’élément Paramètres de diagnostic dans le menu Monitoring du portail.

  3. Sélectionnez + Ajouter le paramètre de diagnostic.

  4. Sélectionnez les journaux ou métriques que vous souhaitez collecter.

    Vous avez plusieurs options pour savoir où envoyer les journaux et les métriques. Par exemple, archiver les journaux de ressource avec les métriques dans un compte de stockage, les envoyer en streaming à un hub d’événements ou les envoyer à un espace de travail Log Analytics.

    Conseil

    Si vous sélectionnez un espace de travail Log Analytics, vous pouvez choisir de stocker les données dans la table ApiManagementGatewayLogs propre à la ressource ou dans la table AzureDiagnostics générale. Nous vous recommandons d’utiliser la table propre à la ressource pour les destinations de journal qui la prennent en charge. En savoir plus

  5. Après avoir configuré les détails de la ou des destinations du journal, sélectionnez Enregistrer.

Remarque

L’ajout d’un objet de paramètre de diagnostic peut entraîner un échec si la propriété MinApiVersion de votre service Gestion des API est définie sur une version d’API supérieure à 2022-09-01-preview.

Pour plus d’informations, consultez Créer des paramètres de diagnostic pour envoyer des journaux et des métriques de plateforme à différentes destinations.

Afficher les données de diagnostic dans Azure Monitor

Si vous activez la collecte des journaux ou des métriques dans un espace de travail Log Analytics, les données peuvent prendre quelques minutes pour s’afficher dans Azure Monitor.

Pour visualiser les données :

  1. Dans le portail Azure, accédez à votre instance APIM.

  2. Sélectionnez Journaux dans le menu de gauche.

    Capture d’écran de l’élément Journaux dans le menu Monitoring du portail.

  3. Exécutez des requêtes pour afficher les données. Plusieurs exemples de requêtes sont fournis, ou exécutez les vôtres. Par exemple, la requête suivante récupère les données des dernières 24 heures dans la table ApiManagementGatewayLogs :

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Capture d’écran de l’interrogation de la table ApiManagementGatewayLogs dans le portail.

Pour plus d’informations sur l’utilisation des journaux de ressources pour Gestion des API, consultez :

Modifier les paramètres de journalisation d’API

Par défaut, quand vous créez un paramètre de diagnostic pour activer la collecte des journaux de ressource, la journalisation est activée pour toutes les API, avec les paramètres par défaut. Vous pouvez ajuster les paramètres de journalisation pour toutes les API ou les remplacer pour des API individuelles. Par exemple, ajustez le taux d’échantillonnage ou la verbosité des données, ou désactivez la journalisation pour certaines API.

Pour plus d’informations sur les paramètres de journalisation, consultez Informations de référence sur les paramètres de la journalisation de diagnostic.

Pour configurer les paramètres de journalisation pour toutes les API :

  1. Dans le menu de gauche de votre instance Gestion des API, sélectionnez API>Toutes les API.
  2. Sélectionnez l’onglet Paramètres dans la barre supérieure.
  3. Faites défiler jusqu’à la section Journaux de diagnostic et sélectionnez l’onglet Azure Monitor.
  4. Passez en revue les paramètres et changez-les si nécessaire. Sélectionnez Enregistrer.

Pour configurer les paramètres de journalisation pour une API donnée :

  1. Dans le menu de gauche de votre instance Gestion des API, sélectionnez API, puis le nom de l’API.
  2. Sélectionnez l’onglet Paramètres dans la barre supérieure.
  3. Faites défiler jusqu’à la section Journaux de diagnostic et sélectionnez l’onglet Azure Monitor.
  4. Passez en revue les paramètres et changez-les si nécessaire. Sélectionnez Enregistrer.

Étapes suivantes

Dans ce didacticiel, vous avez appris à :

  • Afficher les métriques de votre API
  • Configurer une règle d’alerte
  • Afficher les journaux d’activité
  • Activer et afficher les journaux de ressources

Passez au tutoriel suivant :

Suivre des appels