読者です 読者をやめる 読者になる 読者になる

RunscopeでAPIの応答を監視する

プログラム

Runscopeとは

Runscopeは2013年にローンチしされたAPI監視サービスです。

www.runscope.com

メリットとしては、"本番環境で提供しているAPIのステータス監視及び応答内容監視ができる" があります。

単純な死活監視ではなく、APIが返答するJSONXML, HTTPステータスなどの応答内容の監視まで行うことで仮に提供中のAPIから更に外部のAPIと連携しているなどしていた場合、外部のAPIの異常を検知できずにサービスが稼働を続けるということを防ぐことができます。

30日間, 25万リクエストまでであれば無償で試すことができます。

設定

ログイン直後の上部メニューの "Radar Tests" → "Create Test" を指定し、テストグループを作成した後、作成されたテストで "Edit Test" をクリックします。

そうすると下記の様なUIが表示されるため、設定自体はものすごくシンプルでリクエスト対象のURLを指定します。

API呼び出し時に認証がかかる場合は、BASIC認証及び、OAuthのキーも設定することができます。

"Assertions"のタブで期待する応答を指定します。チェックできる項目は以下の内容です。

  • JSON Body
  • XML Body
  • Response Header
  • Text Body
  • Status Code
  • Response Time (ms)
  • Response Size (bytes)

それぞれの内容について期待値を指定しそれを満たしているか否かというチェックが行えます。

例えば、あるAPIを呼び出された時に....

といった所謂APIで監視したくなる要素についてチェックができる様になっています。

この様に各テストを追加していくと各URLのエントリポイントの状態がダッシュボード上で一覧することができます。

テストは毎分〜1日1回の間で実行間隔を設定できる様になっており、また実行結果はSlackに通知させることも可能です。


Runscopeを利用すると死活監視とAPIの応答内容監視も行うことができてサービス内(あるいは会社内等)で複数API外部から利用されたた際にどの様な状態を返しているか という点を主体において監視する際に役立ちそうな印象でした。

また、API内部で更に第三者が運営する別のAPIを呼び出す等の連携が行われている場合、その部分の監視も併せて行えていることになるため、副次的なメリットも大きいかと思いました。