【ITニュース解説】#DAY 10:Adding an API JSON Query Monitor in Uptime Kuma

システムエンジニアを目指す上で、ITシステムが安定して動いているかを確認することは非常に重要だ。しかし、単にシステムが「稼働している」というだけでは、実は不十分な場合が多い。たとえば、Webサイトが表示されていても、そこに表示される情報が古かったり、誤っていたりしたら、そのサービスは正しく機能しているとは言えない。これは、システムが動いていても、期待されるデータを提供していない「サイレント障害」と呼ばれる問題だ。

ニュース記事では、この「単なる稼働監視では不十分」という課題に対し、Uptime Kumaという監視ツールを使って、APIのデータ内容まで検証する新しい監視方法が紹介されている。Uptime Kumaは、Webサイトやサービスが正常に稼働しているかを手軽に確認できるツールの一つだ。

APIとは、アプリケーション・プログラミング・インターフェースの略で、異なるソフトウェア同士が情報をやり取りするための窓口や、データを提供する仕組みのことである。スマートフォンアプリで天気予報を表示する際、アプリは気象情報を提供する会社のAPIに問い合わせ、必要なデータを受け取っている。このAPIがきちんと応答するだけでなく、その応答に含まれる「データの中身」が本当に正しいかどうかも、システム全体の信頼性には大きく関わる。

記事で提案されているのは、APIの応答内容、特にJSON形式のデータの中身まで確認する「API JSON Query Monitor」というUptime Kumaの機能だ。JSONとはJavaScript Object Notationの略で、Webアプリケーションなどでよく使われる、人間にも機械にも理解しやすいデータの記述形式である。

具体的な手順を見てみよう。まず、監視の対象として、テスト用に公開されているJSONPlaceholderというAPIエンドポイント「https://jsonplaceholder.typicode.com/todos/1」が選ばれている。このURLにアクセスすると、以下のようなJSONデータが返ってくる。

Copy
1{
2  "userId": 1,
3  "id": 1,
4  "title": "delectus aut autem",
5  "completed": false
6}

このデータは、特定のタスクに関する情報を含んでおり、「title」という項目には「delectus aut autem」という文字列が格納されている。

次に、Uptime Kumaで新しいモニターを追加する際、「HTTP(s) – JSON Query」という種類を選ぶ。これは、HTTP(s)という通信プロトコルを使ってAPIにアクセスし、返ってきたJSONデータを解析するタイプのモニターだという意味だ。

設定項目はいくつかある。 一つ目は「Method」で、「GET」が指定されている。これは、APIから情報を「取得する」というリクエストの種類を示している。 二つ目は「URL」で、監視対象のAPIエンドポイント「https://jsonplaceholder.typicode.com/todos/1」が入力される。 そして重要なのが「JSON Path」と「Expected Value」だ。

「JSON Path」は「$.title」と設定されている。これは、APIから返ってきたJSONデータの中から、どの部分の情報を確認したいかを指定するためのものだ。$はJSONデータ全体の開始を意味し、.titleはそこから「title」という名前の項目が持つ値を取り出すという指示になる。

「Expected Value」には「"delectus aut autem"」が設定されている。これは、JSON Pathで指定した「title」という項目の値が、この文字列と「一致すること」を期待するという意味だ。Uptime KumaはAPIにリクエストを送り、返ってきたJSONデータの中から「title」の値を取り出し、それが「delectus aut autem」と全く同じであることを確認する。もし一致すればモニターは「UP（正常）」と判断され、一致しなければ「DOWN（異常）」と判断される。

この設定をすることで、単にAPIが応答したかどうかだけでなく、応答内容が「期待通りの正しいデータ」を含んでいるかどうかまでを検証できるようになった。これは、システムが動いているように見えても間違った情報を返したり、本来必要なデータを提供していなかったりする「サイレント障害」のリスクを大幅に減らすことに繋がる。

このような監視方法を導入することで、監視システムはAPIの「稼働状況（Availability）」だけでなく、「機能的な正しさ（Reliability）」も確認できるようになる。これにより、システムの信頼性が大きく向上し、ユーザーが問題に直面する前に、開発者がその異常に気づき、対応できるようになる。

この経験から学べることはいくつかある。まず、「稼働していること（Availability）」と「信頼できること（Reliability）」は同じではないということだ。システムが動いていても、データが正しくなければ信頼できない。コンテンツのチェックは、この信頼性のギャップを埋めるのに役立つ。次に、JSONクエリの監視は非常に効果的な方法だということ。APIが返すレスポンスデータの一部を簡単にテストするだけでも、見過ごされがちな機能的な問題を迅速に特定できる。そして、問題がユーザーに影響を及ぼす前に、能動的に問題を検出し、対処することの重要性がある。APIレベルでのデータ検証は、これを可能にする強力な手段となる。最後に、JSONパスや期待値の設定は非常に正確に行う必要があるということ。もし設定が間違っていると、実際には問題がないのに異常と判断したり（誤検知）、逆に問題があるのに正常と判断したり（見逃し）する可能性があるからだ。

システムエンジニアを目指す上では、このように「ただ動いているか」だけでなく、「正しく動いているか」をどうやって確認し、維持していくかという視点を持つことが非常に重要になるだろう。今回の記事で紹介された監視方法は、その第一歩として、非常に実践的で有効な手段である。