API監視とは?可用性・応答時間・レスポンスの確認方法

API監視で何を測るか、認証付きの HTTP リクエストをどう検証するか、メトリクスやログ、トレースで障害をどう調べるかを解説します。

ベストプラクティス
ユーザーの操作経路とネットワーク、アプリケーション性能のイラスト

在庫 API が 200 OK を返しても、レスポンスの stock が null なら、数値を前提とする購入処理は先へ進めません。在庫が 0 なら話は別です。呼び出し側は在庫切れと判断し、購入ボタンを無効にできます。

API監視では、エンドポイントが呼び出し元の期待どおりに応答するかを確かめます。 定期テストはトラフィックの少ない時間帯でも同じリクエストを送れます。実際の利用状況は本番リクエストのメトリクス、ログ、トレースで追います。テスト用の商品で確認が通っていても、特定の倉庫を参照する本番リクエストだけがタイムアウトすることはあります。

成功とみなす条件を決める

認証が必要な GET /v1/inventory/SKU-42 で、テスト用商品の在庫数を取得する例を考えます。HTTP 200 に加え、stock が 0 以上の整数であることを確認します。応答時間のしきい値は、呼び出し元が実際に待てる時間に合わせます。

テスト結果 判断できること
HTTP 200、{"stock":0}、目標時間内 在庫なしという有効な応答を受け取った
HTTP 200、{"stock":null} 応答は届いたが、呼び出し元が期待する仕様を満たしていない
認証付きリクエストに HTTP 401 テスト用の認証情報と認証経路を確認する
制限時間内に応答なし テストはタイムアウト。通信経路とサーバー側の記録を確認する

購入処理が在庫 API を 2 秒で打ち切るなら、3 秒後に正しい応答が届いても間に合いません。応答が遅いケース、タイムアウト、ステータスや内容の不一致を分けて記録すると、障害の切り分けに役立ちます。本番では、エンドポイントや操作ごとにリクエスト数、エラー率、P95 や P99 のような遅い側の応答時間を見ます。定期テストの応答時間は、その実行地点と入力に限った値です。 Google SRE の 4 つのゴールデンシグナル(英語)

呼び出し元に近いネットワークから確認する

HTTP テストは、実行ノードからエンドポイントの挙動を見るブラックボックス監視です。取引先が使う公開 API なら、取引先が通る経路に近い場所から確認します。社内向けの在庫サービスなら、名前解決と通信ができるネットワークにノードを置きます。ゲートウェイを通る外部テストと、サービスへ直接つなぐ内部テストは、結果を分けておくと障害箇所の見当をつけやすくなります。 合成監視と実行地点の選び方

決済や SMS の外部 API を調べる場合は、事業者が定期実行を認めているテスト先やアカウントを使います。サンドボックスの結果はサンドボックスの状態を表します。本番で異常が起きたときは、アプリ側の依存先への呼び出しも見れば、認証エラー、レート制限、通信タイムアウト、依存先が返したエラーを区別できます。実行ノードが一つだけなら、その地点で観測した結果として扱います。

認証付きの読み取りから始める

テスト専用の認証情報を用意し、必要最小限の権限に絞ります。Guance の HTTP テストでは、API の要件に合わせてヘッダー、HTTP 認証、クライアント証明書を設定できます。JSON を解析して stock のようなフィールドを判定するなら、Pipeline のスクリプトモードを使います。機密情報を含み得るレスポンスは、プライバシー設定で本文を保存しないようにできます。通知には認証情報や生のレスポンスを載せないようにします。

認証情報を付けずに 401 Unauthorized を確認するテストや、許可されていないメソッドで 405 Method Not Allowed を確認するテストにも用途があります。どちらも拒否時の挙動を調べるテストなので、認証に成功したときの確認とは分けます。短命のトークンが必要なら、認められた方法で更新します。認証用の HTTP レスポンスから値を取得して次のリクエストに渡せる場合は、Guance の マルチステップ API テストでその流れを組めます。

書き込み自体を確かめる必要があるなら、分離した環境とテスト専用データを使います。テスト側がタイムアウトしても、サーバー側ではレコードの作成や後続処理が完了していることがあります。タイムアウト後にもテストデータを特定して片付けられるようにし、再試行は API が冪等性や重複排除を保証する範囲に限ります。 HTTP メソッドとステータスの仕様(英語)

テストの失敗を本番リクエストと突き合わせる

Guance の設定画面で行う接続テストは、選択したノードとは独立して実行されます。スケジュールを設定したら、実際に選んだノードからの結果を見てから、異常検知と復旧の条件を決めます。通知にはエンドポイント、実行ノード、時刻、失敗した条件があると調べやすくなります。複数回の失敗を待てば一時的な揺れは拾いにくくなりますが、検知にも時間がかかります。

デプロイ直後に stock: null が返り始めたら、同じ時間帯の在庫 API のエラー率と応答時間を確認します。Guance の APM では、計装済みのサービスから収集したトレースと、関連付けられたログを確認できます。テストに識別子を付け、サービス側でも記録していれば、同じリクエストを探せます。それができない場合は、エンドポイント、時刻、環境で絞ります。ゲートウェイなどで通信が途切れ、計装済みのサービスまで届かなければ、そのサービスのトレースには現れません。

定期テストの成功率は、集計対象のうち判定条件を満たした回数の割合です。一方、利用者向けの SLO では、本番の対象リクエストのうち成功した割合を使うことがあります。テスト用商品では問題が出ず、一部の利用者だけが影響を受けるケースを見落とさないように、二つは別々に追います。 死活監視と可用性

最適なプランを相談する

お問い合わせ

コミュニティに参加

WeChatでスキャンして
コミュニティに参加

Guanceを試す

オンラインですぐに始めて、使った分だけお支払いください。

利用を開始

Guanceのプランを選択

コードリポジトリ