health-check-endpoints

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

サービスの可用性と準備状態を監視するためのヘルスチェックを実装します。

プローブの種類

プローブ	目的	失敗時のアクション
Liveness	プロセスは稼働していますか？	コンテナを再起動する
Readiness	トラフィックを処理できますか？	ロードバランサーから削除する
Startup	アプリは起動しましたか？	他のプローブを遅らせる
Deep	すべての依存先は正常ですか？	アラートを発生させる

実装（Express）

class HealthChecker {
  async checkDatabase() {
    const start = Date.now();
    try {
      await db.query('SELECT 1');
      return { status: 'healthy', latency: Date.now() - start };
    } catch (err) {
      return { status: 'unhealthy', error: String(err?.message || err) };
    }
  }

  async checkRedis() {
    try {
      await redis.ping();
      return { status: 'healthy' };
    } catch (err) {
      return { status: 'unhealthy', error: err.message };
    }
  }

  async getReadiness() {
    const checks = await Promise.all([
      this.checkDatabase(),
      this.checkRedis()
    ]);
    const healthy = checks.every(c => c.status === 'healthy');
    return { healthy, checks };
  }
}

// Liveness - lightweight
app.get('/health/live', (req, res) => {
  res.json({ status: 'ok', timestamp: new Date().toISOString() });
});

// Readiness - check dependencies
app.get('/health/ready', async (req, res) => {
  const health = await healthChecker.getReadiness();
  res.status(health.healthy ? 200 : 503).json(health);
});

Kubernetes の設定

livenessProbe:
  httpGet:
    path: /health/live
    port: 3000
  initialDelaySeconds: 15
  periodSeconds: 10
  failureThreshold: 3

readinessProbe:
  httpGet:
    path: /health/ready
    port: 3000
  initialDelaySeconds: 5
  periodSeconds: 10

ベストプラクティス

• Liveness チェックは最小限に抑えます（外部依存先を含めません）
• Readiness では重要なシステムのみをチェックします
• 正常な場合は 200、不正常な場合は 503 を返します
• 連鎖的な障害を防ぐため、妥当なタイムアウトを設定します
• 応答時間のメトリクスを含めます

その他の実装

references/implementations.md を参照してください。

• Python Flask による完全なヘルスチェッカー
• Java Spring Boot Actuator
• Kubernetes の完全なデプロイ設定

やってはいけないこと

• Liveness を外部サービスに依存させる
• 依存先が停止しているのに 200 を返す
• Readiness で依存先のチェックを省略する