ヘルスチェックエンドポイント

目次

• 概要
• 使用場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

サービスの健全性、依存関係、トラフィック受け入れ準備状況を監視するためのヘルスチェックエンドポイントを実装します。

使用場面

• Kubernetes のliveness と readiness プローブ
• ロードバランサーのヘルスチェック
• サービスディスカバリーと登録
• 監視およびアラートシステム
• サーキットブレーカーの判定
• 自動スケーリングトリガー
• デプロイメント検証

クイックスタート

最小限の動作例:

import express from "express";
import { Pool } from "pg";
import Redis from "ioredis";

interface HealthStatus {
  status: "healthy" | "degraded" | "unhealthy";
  timestamp: string;
  uptime: number;
  checks: Record<string, CheckResult>;
  version?: string;
  environment?: string;
}

interface CheckResult {
  status: "pass" | "fail" | "warn";
  time: number;
  output?: string;
  error?: string;
}

class HealthCheckService {
  private startTime = Date.now();
  private version = process.env.APP_VERSION || "1.0.0";
  private environment = process.env.NODE_ENV || "development";

// ... (詳細な実装はリファレンスガイドを参照)

リファレンスガイド

references/ ディレクトリの詳細な実装:

ベストプラクティス

✅ 推奨事項

• liveness プローブと readiness プローブを分離して実装する
• liveness プローブは軽量に保つ
• readiness 時に重要な依存関係をチェックする
• 適切な HTTP ステータスコードを返す
• レスポンスタイムメトリクスを含める
• 妥当なタイムアウトを設定する
• ヘルスチェック結果を短期間キャッシュする
• バージョンと環境情報を含める
• ヘルスチェック失敗を監視する

❌ 非推奨事項

• liveness プローブで依存関係をチェックする
• ヘルスチェック失敗時に 200 を返す
• レスポンスに時間がかかりすぎる
• 重要な依存関係チェックをスキップする
• 機密情報を公開する
• ヘルスチェック失敗を無視する