コンポーネントチェック付き詳細ヘルスチェック
データベース、キャッシュ、外部サービスのコンポーネントごとのステータス、応答時間、診断メッセージを含む包括的なヘルスチェックレスポンスを設計します。
Detailed Format
詳細な説明
コンポーネント付き詳細ヘルスチェック
詳細なヘルスチェックレスポンスには、全体のステータスに加えて、サービスが依存する各コンポーネントの個別チェックが含まれます。
レスポンス形式
{
"status": "UP",
"timestamp": "2024-01-15T10:30:00.000Z",
"uptime": "72h 14m 33s",
"version": "1.0.0",
"httpStatusCode": 200,
"checks": {
"database": {
"status": "UP",
"duration": "12ms",
"message": "PostgreSQL connection pool active"
},
"redis": {
"status": "UP",
"duration": "3ms",
"message": "Redis connection established"
}
}
}
主要フィールド
| フィールド | 目的 |
|---|---|
status |
全体の状態:UP、DOWN、またはDEGRADED |
timestamp |
チェック実行日時 |
uptime |
サービスの稼働時間 |
version |
デバッグ用アプリケーションバージョン |
checks |
コンポーネントごとの状態詳細 |
duration |
各チェックの応答時間 |
ステータスの導出
全体ステータスはコンポーネントチェックから導出されます:
- UP: すべてのコンポーネントが健全
- DEGRADED: 一部のコンポーネントが異常だがサービスは部分的に機能
- DOWN: 重要なコンポーネントが失敗し、サービスが動作不能
監視統合
詳細なレスポンスにより、監視ダッシュボードはコンポーネントごとの状態を表示し、特定の依存関係にアラートを設定し、応答時間のトレンドを追跡できます。
ユースケース
マイクロサービスアーキテクチャでコンポーネントごとの状態の可視性が必要な内部監視ダッシュボードやオブザーバビリティプラットフォーム(Grafana、Datadog、New Relic)。