グレースフルシャットダウン

目次

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

概要

すべてのリクエストが完了し、接続が閉じられ、プロセスが終了する前にリソースがリリースされることを保証するための適切なシャットダウン手順を実装します。

使用する場面

• Kubernetes/Docker デプロイメント
• ローリングアップデートとデプロイメント
• サーバーの再起動
• ロードバランサーのドレイン期間
• ゼロダウンタイムデプロイメント
• プロセスマネージャー (PM2, systemd)
• 長時間実行されるバックグラウンドジョブ
• データベース接続のクリーンアップ

クイックスタート

最小限の動作例:

import express from "express";
import http from "http";

class GracefulShutdownServer {
  private app: express.Application;
  private server: http.Server;
  private isShuttingDown = false;
  private activeConnections = new Set<any>();
  private shutdownTimeout = 30000; // 30 seconds

  constructor() {
    this.app = express();
    this.server = http.createServer(this.app);
    this.setupMiddleware();
    this.setupRoutes();
    this.setupShutdownHandlers();
  }

  private setupMiddleware(): void {
    // Track active connections
    this.app.use((req, res, next) => {
      if (this.isShuttingDown) {
        res.set("Connection", "close");
        return res.status(503).json({
          error: "Server is shutting down",
// ... (詳細な実装はリファレンスガイドを参照してください)

リファレンスガイド

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

ガイド	内容
Express.js グレースフルシャットダウン	Express.js グレースフルシャットダウン
Kubernetes 対応シャットダウン	Kubernetes 対応シャットダウン
ワーカープロセスシャットダウン	ワーカープロセスシャットダウン
データベース接続プールシャットダウン	データベース接続プールシャットダウン
PM2 グレースフルシャットダウン	PM2 グレースフルシャットダウン
Python/Flask グレースフルシャットダウン	Python/Flask グレースフルシャットダウン

ベストプラクティス

✅ すべき事

• SIGTERM および SIGINT シグナルを処理する
• 新しいリクエストの受け入れを即座に停止する
• 送信中のリクエストの完了を待つ
• 適切なシャットダウンタイムアウトを設定する
• データベース接続を適切に閉じる
• ログとメトリクスをフラッシュする
• シャットダウン中はヘルスチェックを失敗させる
• シャットダウン手順をテストする
• シャットダウンの進行状況をログに記録する
• コンテナでグレースフルシャットダウンを使用する

❌ してはいけない事

• シャットダウンシグナルを無視する
• クリーンアップなしでプロセスを強制終了する
• 不当に長いタイムアウトを設定する
• リソースのクリーンアップをスキップする
• 接続を閉じることを忘れる
• シャットダウンを無期限にブロックする