Observabilité dans Gestion des API Azure

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

L’observabilité est la capacité à comprendre l’état interne d’un système à partir des données qu’il produit et la capacité à explorer ces données pour répondre à des questions sur ce qui s’est produit et pourquoi.

Gestion des API Azure aide les organisations à centraliser la gestion de toutes les API. Dans la mesure où il sert de point d’entrée unique pour le trafic de toutes les API, c’est l’emplacement idéal pour observer ces dernières.

Vue d’ensemble

Gestion des API Azure vous permet de choisir l’utilisation de la passerelle gérée ou de la passerelle auto-hébergée, qu’elle soit déployée automatiquement ou à l’aide d’une extension Azure Arc.

Le tableau suivant résume toutes les fonctionnalités d’observabilité prises en charge par Gestion des API pour faire fonctionner les API et les modèles de déploiement qu’elles prennent en charge. Les éditeurs d’API et d’autres utilisateurs disposant d’autorisations d’exploitation ou de gestion de l’instance Gestion des API peuvent utiliser ces fonctionnalités.

Remarque

Pour les consommateurs d’API qui utilisent le portail des développeurs, un rapport d’API intégré est disponible. Ce rapport fournit uniquement des informations sur leur propre utilisation des API au cours des 90 jours précédents. Actuellement, le rapport de l’API intégré n’est pas disponible dans le portail des développeurs pour les niveaux de service v2.

Outil Utile pour Retard des données4 Rétention échantillonnage Type de données Modèle(s) de déploiement pris en charge
Suivi des demandes (Inspecteur d’API) Tests et débogage Immédiat Les 100 dernières traces Activé par requête Traces des requêtes Géré, Auto-hébergé, Azure Arc, Espace de travail
Analytique intégrée Création de rapports et surveillance Minutes Durée de vie 100 % Rapports et journaux Géré
Métriques dans Azure Monitor Création de rapports et surveillance Minutes 90 jours (effectuez une mise à niveau pour prolonger) 100 % Mesures Géré, auto-hébergé2, Azure Arc
Journaux d’activité Azure Monitor Création de rapports, surveillance et débogage Minutes 31 jours/5 Go (effectuez une mise à niveau pour prolonger) 100 % (réglable) Journaux d’activité Managé1, auto-hébergé3, Azure Arc3
Azure Application Insights Création de rapports, surveillance et débogage Secondes 90 jours/5 Go (passez à la version supérieure pour prolonger) Personnalisé Journaux, métriques Managée1, Auto-hébergée1, Azure Arc1, Espace de travail1
Journalisation via Azure Event Hubs Scénarios personnalisés Secondes Géré par l’utilisateur Personnalisé Personnalisé Managé1, auto-hébergé1, Azure Arc1
OpenTelemetry Supervision Minutes Géré par l’utilisateur 100 % Mesures Auto-hébergé2

1 Facultatif, en fonction de la configuration de la fonctionnalité dans Gestion des API Azure.
2 Facultatif, en fonction de la configuration de la passerelle.
3 La passerelle auto-hébergée n’envoie actuellement pas de journaux de diagnostic à Azure Monitor. Toutefois, il est possible de configurer et de conserver les journaux localement à l'emplacement où la passerelle auto-hébergée est déployée. Pour plus d'informations, consultez Configurer les métriques et les journaux locaux pour une passerelle auto-hébergée.
4 À l’exception du suivi des demandes, toutes les connexions dans Gestion des API se produisent de manière asynchrone.

Meilleures pratiques

Les pratiques suivantes peuvent améliorer l’observabilité de votre API :

  • Surveillance granulaire : activez les métriques par méthode pour obtenir des informations détaillées sur les temps de réponse et les taux d’erreur.
  • Suivi de la latence en queue : configurez des alertes par méthode sur la latence en queue (par exemple, 90e, 95e ou 99e percentile), car la latence moyenne peut être trompeuse. Pour implémenter cette fonctionnalité, utilisez le langage de requête Kusto (KQL) afin de transférer les journaux vers un espace de travail Log Analytics.
  • Alertes proactives : établissez des alertes pour chaque méthode concernant les taux d’erreur et les faibles taux de réussite ; utilisez des taux plutôt que des nombres bruts afin de garantir la précision.
  • Suivi distribué : activez le suivi pour identifier les goulots d’étranglement des performances et résoudre les problèmes.
  • Balisage des ressources : appliquez des étiquettes aux API pour un suivi et une allocation précis des coûts.

Contenu connexe

  • Last updated on