12 mesures de surveillance pour garantir le succès de votre stratégie API

L'équipe de la communauté open source chinoise a réalisé sa première diffusion en direct, racontant l'histoire de la communauté open source chinoise au nom du partage.

Auteur original : Andrew Stiefel de F5

Lien d'origine : 12 indicateurs de suivi pour assurer une stratégie API réussie

Source de réimpression : communauté open source NGINX

La seule communauté chinoise officielle de NGINX, le tout sur nginx.org.cn

Alors que les entreprises adoptent des pratiques de conception axées sur les API pour créer des applications modernes, il est devenu impératif de mesurer les performances opérationnelles et la valeur de ces API. Construire un cadre qui définit clairement les métriques de l'API et les relie aux indicateurs de performance clés (KPI) est l'une des étapes les plus importantes pour garantir une stratégie API réussie.

En règle générale, les KPI sont étroitement liés à des objectifs spécifiques. Ils ont des délais clairs et correspondent à ce que la stratégie API doit offrir. En revanche, les métriques API sont des points de données importants. Toutes les mesures ne sont pas des KPI, mais chaque KPI est basé sur des mesures.

Alors, comment faut-il s'y prendre ? Tout d’abord, vous devez clarifier l’objectif de votre stratégie API dès le début, puis choisir les métriques qui correspondent à cet objectif. N'oubliez pas que chaque équipe doit mesurer et suivre différentes mesures en fonction de ce qui est important pour elle et nécessaire à l'entreprise.

D'une manière générale, il existe trois grandes catégories de métriques API que les entreprises peuvent suivre, et différentes catégories de métriques reflètent différents problèmes :

Métriques opérationnelles – L'API offre-t-elle la stabilité, la fiabilité et les performances dont vous avez besoin ?
Métriques d'adoption – Les développeurs adoptent-ils votre API ?
Métriques du produit – Dans quelle mesure l'API soutient-elle vos objectifs commerciaux ?

Vous pouvez considérer ces trois grandes catégories d’indicateurs comme une pyramide. Les mesures opérationnelles en bas mesurent les performances tactiques des API individuelles et de leur infrastructure de support. Les principales mesures du produit mesurent la valeur commerciale créée par l'API. Les deux sont liés par des mesures d'adoption, qui suivent la croissance des programmes API parmi les utilisateurs finaux (développeurs). De manière générale, les indicateurs de produits et les indicateurs d'adoption concernent les résultats commerciaux que vous devez mesurer, tandis que les indicateurs opérationnels concernent les normes techniques que vous devez maintenir.

Cet article décompose 12 métriques spécifiques qui doivent être mesurées, décrit comment elles prennent en charge les équipes d'infrastructure et d'application, et explique comment ces métriques sont liées aux KPI.

Indicateurs de fonctionnement et de maintenance

Dans les premières étapes, les indicateurs opérationnels sont souvent les premiers à être mesurés. Il s'agit de mesures tactiques qui donnent un aperçu des performances de votre API. Les indicateurs opérationnels ne sont généralement pas des KPI. Mais ils peuvent vous aider à mesurer la qualité et les performances des logiciels créés par votre équipe et à fournir des indicateurs précoces de nouveaux problèmes, ou vous aider à explorer et à découvrir les problèmes susceptibles d'avoir un impact sur les KPI clés.

Vous pouvez suivre différentes mesures opérationnelles en fonction de l'équipe et de la responsabilité.

Équipe Infrastructures

L'équipe Platform Operations maintient, connecte et sécurise l'infrastructure et le portefeuille technologique utilisés par différentes équipes pour fournir des applications. Dans le cas des programmes API, cela inclut généralement les passerelles API et les portails des développeurs API.

Les indicateurs clés pour les équipes d'infrastructure telles que les opérations de plateforme comprennent :

Temps de disponibilité – Même s'il s'agit de l'une des mesures les plus élémentaires, la disponibilité est la référence en matière de mesure de la disponibilité des services. Il est souvent associé à un accord de niveau de service (SLA).
Utilisation du processeur et de la mémoire : le suivi de l'utilisation des ressources de votre API Gateway est essentiel pour déterminer quand vous devrez peut-être faire évoluer votre instance. Il peut également servir d’indicateur d’alerte précoce d’une panne imminente ou d’un pic d’utilisation dû à des erreurs.
Taux globaux de réussite et d'erreur : mesurer la fréquence à laquelle une API déclenche un code d'état d'erreur HTTP (et non 200) peut vous aider à comprendre à quel point votre API est sujette aux erreurs. Cette métrique composite fournit des informations qui vous aident à juger de la qualité globale des API que votre équipe met en production.

équipe d'application

L'équipe d'application est composée de développeurs d'API et de propriétaires de services, qui sont responsables de la création et de l'exploitation de chaque service ou application. Ces services ou applications peuvent être utilisés dans le cadre d'un produit plus vaste, intégrés à des produits partenaires ou utilisés pour fournir des API en tant que service aux développeurs.

Les équipes d'application doivent mesurer les métriques suivantes :

Requêtes par minute – Cette mesure de performances mesure le nombre de requêtes traitées par votre API par minute. Bien que cela évolue au fil du temps, vous souhaitez généralement limiter le nombre de requêtes par minute pour garantir la meilleure expérience aux utilisateurs de votre API.
Latence moyenne et maximale – Il est essentiel de suivre le temps moyen nécessaire à votre API pour recevoir une demande et renvoyer une réponse. Les API lentes peuvent avoir un impact négatif sur l'expérience utilisateur, ce qui peut nuire à votre entreprise.
Erreurs par minute – La vérité est souvent la même : il n’existe pas d’API parfaite. Les erreurs sont inévitables, tôt ou tard. Vous devez surveiller les erreurs et mettre en œuvre un plan d’action bien planifié pour les corriger le plus rapidement possible avant qu’elles ne dégénèrent soudainement.

Consultez les chapitres 3 à 5 du livre électronique O'Reilly Mastering API Architecture de NGINX pour une compréhension plus approfondie des opérations d'API ainsi que des KPI et des mesures essentiels à votre entreprise.

mesures d'adoption

Les entreprises axées sur les API doivent regarder au-delà des mesures d'ingénierie pour comprendre comment les développeurs interagissent avec vos API. Vous devez également mesurer et surveiller l'expérience des développeurs d'API pour vous assurer que les développeurs adoptent votre API et en tirent de la valeur.

Voici quelques exemples d’utilisation des indicateurs :

Consommateurs d'API uniques – Cette mesure mesure généralement le nombre de développeurs qui utilisent votre API via le nombre d'utilisateurs actifs mensuels. Idéalement, cette métrique augmentera à mesure que de plus en plus de développeurs intégreront votre API dans leurs applications.
Croissance de l'utilisation des API : cette mesure mesure également l'adoption des API et constitue souvent la mesure privilégiée pour mesurer l'adoption des API. Idéalement, le trafic de l'API augmentera de mois en mois à mesure que davantage d'applications et de développeurs utilisent l'API.
Temps de premier appel – Cette métrique mesure le temps nécessaire à un développeur pour créer un compte, générer des informations d'identification API et exécuter le premier appel API. Rendre les développeurs opérationnels le plus rapidement possible est une priorité élevée, cette mesure est donc la mesure la plus importante pour l'expérience globale des développeurs d'API.

Remarque : Nous vous recommandons d'avoir au moins un KPI mesurant l'adoption de l'API. Cela vous aide à estimer la croissance globale de votre programme API. Par exemple, vous pouvez configurer un KPI pour suivre la croissance du nombre de développeurs utilisant votre API pour créer des intégrations ou des applications continues.

Indicateurs produits

Les métriques des produits API jouent un rôle important pour aider à comprendre la valeur de votre API. Même si seul un petit sous-ensemble d’API peut apporter une contribution directe aux revenus, chaque API doit créer de la valeur pour l’entreprise.

Les principaux indicateurs de produit à mesurer comprennent :

Revenus directs et indirects – Ces mesures mesurent les différentes manières dont les API contribuent aux revenus. Certaines de ces API sont directement monétisables, d'autres prennent en charge l'intégration avec des produits de partenaires commerciaux ou des intégrations tierces essentielles pour les clients. Tout comme le suivi de l'adoption des API, le suivi des revenus indirects aide les développeurs à créer des applications génératrices de revenus pour les partenaires.
Nombre d'applications par API – Les API doivent être réutilisables. Cette métrique mesure le nombre d'applications intégrées à l'API pour comprendre quelles API créent le plus de valeur.
Nombre de partenaires – Les API permettent souvent d'établir des relations commerciales. Le suivi du nombre d'intégrations d'API d'un partenaire peut contribuer à favoriser l'adoption et démontrer la valeur aux autres unités commerciales.

Remarque : Ces indicateurs de produits sont étroitement liés à l'impact commercial. Vous pouvez choisir de convertir certains indicateurs de produits en KPI en fonction de vos objectifs commerciaux. Par exemple, si l'objectif commercial de votre stratégie API est d'atteindre davantage de clients via un fournisseur tiers, vous pouvez suivre le nombre de partenaires utilisant votre API et les revenus indirects générés par ces intégrations.

Veuillez vous référer aux chapitres 3 à 5 de « Maîtriser l'architecture des API » pour une compréhension plus approfondie du cycle de vie des produits API, y compris les KPI commerciaux et opérationnels.

Conclusion

La corrélation des métriques API avec les KPI commerciaux est l'un des principaux moyens par lesquels les entreprises peuvent prendre des décisions basées sur les données et garantir que leur stratégie API offre la valeur dont elles ont besoin. De plus, la visibilité des API aide les équipes chargées de l'infrastructure et des applications à mesurer les mesures opérationnelles les plus importantes pour chacune d'entre elles.

NGINX permet la visualisation de dizaines d'indicateurs API importants. Vous pouvez afficher des métriques en temps réel et historiques et les exporter facilement vers votre solution préférée de surveillance des performances des applications (ou APM) ou d'analyse de données.

La seule communauté chinoise officielle de NGINX, le tout sur nginx.org.cn

Plus d'informations techniques liées à NGINX, des questions et réponses interactives, une série de cours et des ressources événementielles : Site officiel de la communauté Open Source |