ちょっと、そこ！ API サプライヤーとして、私は API のパフォーマンスを測定することがいかに重要であるかを知っています。このブログでは、それを実現するための実践的な方法をいくつか紹介します。
まず最初に、API パフォーマンスの測定がなぜそれほど重要なのかについて話しましょう。 API (アプリケーション プログラミング インターフェイス) は、さまざまなソフトウェア システムを接続する橋のようなものです。これにより、さまざまなアプリケーションが通信してデータを共有できるようになります。 API のパフォーマンスが低下すると、応答時間の遅延、データ エラー、さらにはシステム クラッシュなど、あらゆる種類の問題が発生する可能性があります。したがって、API のパフォーマンスに注意を払うことで、アプリケーションがスムーズに実行され、ユーザーが優れたエクスペリエンスを得ることができるようになります。
応答時間
API パフォーマンスを測定するための最も基本的かつ重要な指標の 1 つは応答時間です。これは、API がリクエストを受信した後、クライアントにレスポンスを返すまでにかかる時間です。応答時間が長い場合は、サーバーの過負荷、非効率なコード、ネットワークの問題など、さまざまな問題の兆候である可能性があります。
応答時間を測定するには、cURL や Postman などのツールを使用できます。これらのツールを使用すると、API にリクエストを送信し、応答を取得するまでにかかる時間を記録できます。たとえば、cURL では次のコマンドを使用できます。
curl -w "@curl-format.txt" -o /dev/null -s "https://your-api-url.com"どこカール形式.txtには、次のような出力形式が含まれます。
time_namelookup: %{time_namelookup}\n time_connect: %{time_connect}\n time_appconnect: %{time_appconnect}\n time_pretransfer: %{time_pretransfer}\n time_redirect: %{time_redirect}\n time_starttransfer: %{time_starttransfer}\n ----------\n time_total: %{time_total}\nこれにより、要求と応答のサイクルのさまざまな段階に関する詳細情報 (所要時間の合計など) が得られます。
スループット
もう 1 つの重要な指標はスループットです。これは、API が特定の時間枠内に処理できるリクエストの数を指します。スループットが高いということは、API が大量のリクエストを効率的に処理できることを意味します。これは、トラフィック量が多いアプリケーションにとって非常に重要です。
スループットを測定するには、Apache JMeter や Gatling などの負荷テスト ツールを使用できます。これらのツールを使用すると、API への大量の同時リクエストをシミュレートし、1 秒あたりに処理できるリクエストの数を測定できます。たとえば、Apache JMeter では、複数のスレッド (同時ユーザーをシミュレート) を含むテスト計画を作成し、API にリクエストを送信できます。 JMeter は、送信されたリクエストの数、成功したリクエストの数、およびスループットに関する統計を提供します。
エラー率
エラー率は、エラーが発生したリクエストの割合です。エラー率が高い場合は、コードのバグ、入力検証の誤り、基盤となるインフラストラクチャの問題など、API に問題があることを示している可能性があります。
エラー率を測定するには、API から返される HTTP ステータス コードを監視します。たとえば、4xx ステータス コードは通常、クライアント側のエラー (不正なリクエストなど) を示し、5xx ステータス コードはサーバー側のエラーを示します。ログ記録および監視ツールを使用して、これらのステータス コードを収集および分析できます。 Sentry や New Relic などのツールは、エラーを追跡し、何が問題だったのかに関する詳細情報を取得するのに役立ちます。
レイテンシ
レイテンシは応答時間と似ていますが、特にリクエストの送信時間と応答の最初のバイトの受信時間との間の遅延を指します。これは、わずかな遅延でも重大な影響を与える可能性があるリアルタイム アプリケーションでは特に重要な指標です。
遅延を測定するには、Wireshark などのネットワーク監視ツールを使用できます。 Wireshark を使用すると、パケットがクライアントとサーバーの間を移動するのにかかる時間を含む、ネットワーク トラフィックをキャプチャして分析できます。 Pingdom や GTmetrix などのツールを使用して、世界中のさまざまな場所から API のレイテンシを測定することもできます。
リソースの使用率
API をホストしているサーバーのリソース使用率を監視することも、パフォーマンスを測定するために重要です。 CPU、メモリ、ディスク I/O などのリソースは、API のパフォーマンスに直接影響を与える可能性があります。
Nagios や Zabbix などのシステム監視ツールを使用して、サーバーのリソース使用率を監視できます。これらのツールは、CPU 使用率、メモリ使用率、ディスク容量、ネットワーク トラフィックに関するリアルタイムの情報を提供します。特定のリソースが常に高レベルにあることに気付いた場合は、インフラストラクチャを拡張するか、コードを最適化する必要があることを示している可能性があります。
API の可用性
API の可用性とは、API がアクセス可能で適切に機能している時間の割合を指します。アプリケーションが常に API に依存できるようにするには、高い可用性率が不可欠です。
API の可用性を測定するには、UptimeRobot や StatusCake などの稼働時間監視ツールを使用できます。これらのツールは定期的に API にリクエストを送信し、API が有効なステータス コードで応答するかどうかを確認します。また、API がダウンしたり、応答時間が大幅に増加した場合にアラートを送信することもできます。
現実世界の例
あなたが次のような製品を提供する API サプライヤーであるとします。トップグレード L - オルニチン 2 - オキソグルタル酸、5144 - 42 - 3、C10H18N2O7、CAS:58 - 63 - 9、最高級イノシンパウダー、ヒポキサンチン、 そして良質のアルベンダゾール、CAS: 54965 - 21 - 8、C12H15N3O2S。顧客は API を利用して、価格、在庫状況、仕様などの製品に関する情報にアクセスします。
API の応答時間が長い場合、顧客は不満を抱き、代替サプライヤーを探す可能性があります。応答時間、スループット、エラー率などを定期的に測定することで、顧客に影響を及ぼす前にパフォーマンスの問題を特定して修正できます。
結論
API パフォーマンスの測定は継続的なプロセスであり、さまざまなツールやメトリクスの使用が必要です。応答時間、スループット、エラー率、レイテンシ、リソース使用率、API の可用性を常に監視することで、API が最高のパフォーマンスを発揮していることを確認できます。
当社の API に興味がある場合、または API のパフォーマンスについてご質問がある場合は、お気軽にお問い合わせください。お客様のニーズを満たし、製品の最高のパフォーマンスを保証する方法について、いつでも喜んでご相談させていただきます。
参考文献
- 「高性能ブラウザ ネットワーキング」Ilya Grigorik著
- 「データの設計 - 集中的なアプリケーション」Martin Kleppmann 著
- cURL、Postman、Apache JMeter、Sentry、New Relic、Nagios、Zabbix、UptimeRobot などのオンライン ドキュメント。