Djangoランタイムシステムチェック：django-watchmanでヘルスチェック用エンドポイントを作る方法

DjangoでWebサイトを開発していると、データベースやキャッシュ、ストレージなどの状態を確認できるURLエンドポイントがあると便利な場面に遭遇することがあります。そんなときはサードパーティ製パッケージを活用すれば、システムの稼働状況を簡単に監視でき、本番環境でも同様のチェックを行うことが可能です。

この記事では、システムチェック結果を返してくれるURLエンドポイントを作成する手順を解説します。

実装例

まず最初に、アプリとURLに関する基本的な設定をすべて済ませておきましょう。

次に、django-watchmanパッケージをインストールします。

pip install django-watchman

続いて、settings.pyに以下のコードを追加します。

INSTALLED_APPS = (
   ...
   'watchman',
)

これにより、Djangoプロジェクトにwatchmanがアプリとして登録されます。

さらに、urls.pyには次の行を追加してください。

urlpatterns += [path(r'watchman/',
include('watchman.urls'))]

この記述によって、システムチェック結果を確認するためのURLエンドポイントが定義されます。watchmanはデフォルトでデータベース接続やキャッシュなど主要コンポーネントの状態を自動的にチェックしてくれます。

以上で設定は完了です。それでは、実際の出力を確認してみましょう。

出力結果

ブラウザで https://127.0.0.1/watchman/dashboard/ にアクセスすると、各コンポーネントの稼働状態を一覧できるダッシュボード画面が表示されます。