API 戦略の成功を保証する 12 のモニタリング指標

オープンソースの中国コミュニティチームは、共有の名のもとに、オープンソースの中国コミュニティの背後にあるストーリーを伝える初のライブブロードキャストを行いました。」

原作者：F5のアンドリュー・スティーフェル

元のリンク: API 戦略の成功を保証する 12 の監視指標

転載元：NGINXオープンソースコミュニティ

NGINX の唯一の公式中国語コミュニティ (すべてnginx.org.cn )

企業が最新のアプリケーションを構築するためにAPI ファーストの設計手法を採用するにつれて、これらの API の運用パフォーマンスと価値を測定することが不可欠になっています。 API メトリクスを明確に定義し、それを主要業績評価指標 (KPI) に結び付けるフレームワークを構築することは、API 戦略を確実に成功させるための最も重要な手順の 1 つです。

通常、KPI は特定の目標と密接に結びついています。これらには明確な時間枠があり、API 戦略が提供する必要があるものと一致しています。対照的に、API メトリクスは重要なデータポイントです。すべての指標が KPI であるわけではありませんが、すべての KPI は指標に基づいています。

では、どのように対処すればよいのでしょうか？まず、最初から API 戦略の目標を明確にし、その目標に合った指標を選択する必要があります。各チームは、自分たちにとって何が重要で、ビジネスにとって何が必要なのかに基づいて、さまざまな指標を測定し、追跡する必要があることに注意してください。

大まかに言えば、企業が追跡できる API メトリクスには 3 つの大きなカテゴリがあり、さまざまなカテゴリのメトリクスはさまざまな問題を反映しています。

運用メトリクス– API は必要な安定性、信頼性、パフォーマンスを提供しますか?
導入指標– 開発者はあなたの API を採用していますか?
製品メトリクス– API はビジネス目標をどのようにサポートしていますか?

これら 3 つの大まかなカテゴリのインジケーターをピラミッドとして考えることができます。下部の運用メトリクスは、個々の API とそのサポートインフラストラクチャの戦術的パフォーマンスを測定します。上位の製品指標は、API によって生み出されるビジネス価値を測定します。この 2 つは、エンドユーザー (開発者) 間での API プログラムの成長を追跡する導入メトリクスを通じて結びついています。一般に、製品指標と導入指標は測定する必要があるビジネス結果に関連し、運用指標は維持する必要がある技術標準に関連します。

この記事では、測定する必要がある 12 の特定のメトリクスを分類し、それらのメトリクスがインフラストラクチャチームとアプリケーションチームをどのようにサポートするかについて説明し、これらのメトリクスが KPI にどのように関連するかを説明します。

運用保守指標

初期段階では、多くの場合、運用メトリックが最初に測定されるメトリックになります。これらは、API のパフォーマンスに関する洞察を提供する戦術的な指標です。運用指標は通常、KPI ではありません。ただし、チームが構築するソフトウェアの品質とパフォーマンスを測定したり、新しい問題の早期指標を提供したり、主要な KPI に影響を与える可能性のある問題を掘り下げて発見したりするのに役立ちます。

チームと責任に基づいて、さまざまな運用指標を追跡できます。

インフラストラクチャチーム

プラットフォーム運用チームは、さまざまなチームがアプリケーションを提供するために使用するインフラストラクチャとテクノロジーポートフォリオを維持、接続、保護します。 API プログラムの場合、これには通常、API ゲートウェイと API 開発者ポータルが含まれます。

プラットフォーム運用などのインフラストラクチャチームの主要な指標には次のものが含まれます。

稼働時間– 最も基本的な指標の 1 つであっても、稼働時間はサービスの可用性を測定するためのゴールドスタンダードです。多くの場合、これはサービスレベルアグリーメント(SLA)に関連付けられます。
CPU とメモリの使用量- API ゲートウェイのリソース使用量を追跡することは、インスタンスをいつスケールアップする必要があるかを判断するために重要です。また、差し迫った障害やエラーによる使用量の急増を早期に警告する指標としても機能します。
全体的な合格率とエラー率- API が HTTP エラーステータスコード ( ではない 200) をトリガーする頻度を測定すると、API がどの程度エラーを起こしやすいかを理解するのに役立ちます。この複合メトリクスは、チームが運用環境に導入する API の全体的な品質を判断するのに役立つ情報を提供します。

アプリケーションチーム

アプリケーションチームは、API 開発者とサービス所有者で構成され、各サービスまたはアプリケーションの構築と運用を担当します。これらのサービスまたはアプリケーションは、より大きな製品の一部として使用したり、パートナー製品と統合したり、開発者にサービスとして API を提供するために使用したりできます。

アプリケーションチームは次の指標を測定する必要があります。

1 分あたりのリクエスト– このパフォーマンスメトリクスは、API が 1 分あたりに処理するリクエストの数を測定します。時間の経過とともに変化しますが、API ユーザーに最高のエクスペリエンスを提供するために、通常は 1 分あたりのリクエスト数を制限する必要があります。
平均レイテンシーと最大レイテンシー– API がリクエストを受信してレスポンスを返すまでにかかる平均時間を追跡することが重要です。 API が遅いとユーザーエクスペリエンスに悪影響を及ぼし、ビジネスに悪影響を与える可能性があります。
1 分あたりのエラー数- 真実は多くの場合同じで、完璧な API は存在しません。遅かれ早かれ間違いは避けられません。エラーを監視し、突然エスカレートする前に、できるだけ早くエラーを修正するための綿密に計画された一連のアクションを実装する必要があります。

ビジネスにとって重要な API 操作と KPI およびメトリクスをより深く理解するには、O'Reilly 電子ブックMastering API Architecture (NGINX 著)の第 3 章から第 5 章を参照してください。

導入指標

API ファーストの企業は、エンジニアリング指標を超えて、開発者が API とどのようにやり取りしているかを理解する必要があります。また、開発者が API を採用し、そこから価値を得ていることを確認するために、API 開発者のエクスペリエンスを測定および監視する必要もあります。

インジケーターの使用例をいくつか示します。

固有の API コンシューマー– この指標は通常、月間アクティブユーザー数を通じて API を使用している開発者の数を測定します。理想的には、より多くの開発者が API をアプリケーションに統合するにつれて、この指標は増加します。
API 使用量の増加- この指標は API の採用状況も測定し、多くの場合、API の採用状況を測定する場合に推奨される指標です。理想的には、API を使用するアプリケーションや開発者が増えるにつれて、API トラフィックは月ごとに増加します。
最初の呼び出しまでの時間– このメトリクスは、開発者がアカウントを作成し、API 資格情報を生成し、最初の API 呼び出しを実行するのにかかる時間を測定します。開発者ができるだけ早く立ち上げて実行できるようにすることが最優先事項であるため、この指標は API 開発者全体のエクスペリエンスにとって最も重要な指標となります。

注: API の導入を測定する KPI を少なくとも 1 つ用意することをお勧めします。これは、API プログラムの全体的な成長を見積もるのに役立ちます。たとえば、KPI を設定して、API を使用して継続的インテグレーションやアプリを作成する開発者の数の増加を追跡できます。

製品インジケーター

API 製品メトリクスは、API の価値を理解する上で重要な役割を果たします。直接収益に貢献できるのは API のごく一部ですが、各 API はビジネスに価値を生み出す必要があります。

測定すべき主要な製品指標には次のものがあります。

直接収益と間接収益– これらの指標は、API が収益にどのように貢献するかを測定します。これらの API の中には、直接収益化できるものや、ビジネスパートナー製品との統合、または顧客にとって重要なサードパーティの統合をサポートするものもあります。 API 導入の追跡と同様に、間接収益の追跡は、開発者がパートナー向けに収益を生み出すアプリケーションを構築するのに役立ちます。
API ごとのアプリケーションの数– API は再利用可能である必要があります。このメトリクスは、どの API が最も多くの価値を生み出しているかを理解するために、API と統合されているアプリケーションの数を測定します。
パートナーの数– API により多くの場合、ビジネス関係の構築が可能になります。パートナーの API 統合の数を追跡すると、導入を促進し、他のビジネスユニットに価値を実証するのに役立ちます。

注:これらの製品指標はビジネスへの影響と密接に関連しています。ビジネス目標に基づいて、一部の製品指標を KPI に変換することを選択できます。たとえば、API 戦略のビジネス目標がサードパーティプロバイダーを通じてより多くの顧客にリーチすることである場合、API を使用するパートナーの数と、これらの統合を通じて生成された間接収益を追跡できます。

ビジネスおよび運用 KPI を含む API 製品のライフサイクルをより深く理解するには、「Mastering API Architecture」の第 3 章から第 5 章を参照してください。

結論

API メトリクスとビジネス KPI を関連付けることは、企業がデータに基づいた意思決定を行い、API 戦略が必要な価値を確実に提供できるようにするための主要な方法の 1 つです。さらに、API の可視性を有効にすることで、インフラストラクチャチームとアプリケーションチームがそれぞれにとって最も重要な運用指標を測定できるようになります。

NGINX を使用すると、数十の重要な API インジケーターを視覚化できます。リアルタイムおよび履歴のメトリクスを表示し、好みのアプリケーションパフォーマンス監視 (APM) またはデータ分析ソリューションに簡単にエクスポートできます。

NGINX の唯一の公式中国語コミュニティ (すべて nginx.org.cn )

NGINX 関連のその他の技術情報、インタラクティブな Q&A、一連のコース、およびイベントリソース: オープンソースコミュニティ公式 Web サイト | WeChat 公式アカウント