health-check-endpoints

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

目次

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

概要

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

使用する場面

• 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";

// ... (see reference guides for full implementation)

リファレンスガイド

詳細な実装は references/ ディレクトリにあります：

ガイド	内容
Express.js ヘルスチェック	Express.js のヘルスチェック
Spring Boot Actuator 風（Java）	Spring Boot Actuator 風（Java）
Python Flask ヘルスチェック	Python Flask のヘルスチェック

ベストプラクティス

✅ 推奨事項

• Liveness プローブと Readiness プローブを別々に実装します
• Liveness プローブは軽量に保ちます
• Readiness では重要な依存関係を確認します
• 適切な HTTP ステータスコードを返します
• 応答時間のメトリクスを含めます
• 妥当なタイムアウトを設定します
• ヘルスチェックの結果を短時間キャッシュします
• バージョンと環境の情報を含めます
• ヘルスチェックの失敗を監視します

❌ 非推奨事項

• Liveness プローブで依存関係を確認しないでください
• ヘルスチェックに失敗した場合に 200 を返さないでください
• 応答に時間をかけすぎないでください
• 重要な依存関係のチェックを省略しないでください
• 機密情報を公開しないでください
• ヘルスチェックの失敗を無視しないでください