ホットフィックスとは何か、パッチとの違いと安全な出し方
1分で読めます
ホットフィックスとは、本番環境で起きた深刻な問題を直す修正で、次の定期リリースを待つコストが、急いで動くリスクを上回るために、通常のリリース周期の外で出すものだ。意図的に小さく作り、通常のチェックを短縮した形で通し、ユーザーには入手できるようになり次第知らせる。この言葉はもともと、ユーザーに応答している最中のサーバーのような「熱い」システムに適用する変更を指していたが、今では修正の入れ方よりも緊急性を表す言葉になっている。
| 用語 | 内容 | 出荷の時期 | 典型的な範囲 |
|---|---|---|---|
| ホットフィックス | ユーザーが今まさに遭遇している問題の緊急の修正 | 準備ができ次第、予定の外で | 一つの不具合 |
| バグ修正 | 不具合の修正全般 | たいてい次の定期リリースと一緒に | 一つ以上の不具合 |
| パッチ | 既存のソフトウェアへの更新。SemVerでは最後の数字を上げるリリース | 計画的な場合も緊急の場合もある | 後方互換のある修正 |
| サービスパックやロールアップ | テスト済みの、過去の修正をまとめた累積バンドル | 予定に沿って | 多数の修正、ときに小さな機能 |
| ライブパッチ | 再起動せずに動作中のコードに当てる修正 | 再起動のコストが高すぎるとき | いくつかの関数 |
ソフトウェアにおけるホットフィックスとは何か
ホットフィックスは、すでに使われているソフトウェアの問題を直すために素早く行う変更で、次のバージョンを待たずに単独でリリースされる。この言葉には二つの意味が同時にある。問題が深刻であることと、それに対処するために通常の手順を短縮したことだ。
Wikipediaのホットフィックスの記事は、その意味の変化をたどっている。この言葉はもともと、熱い状態のシステム、つまりクライアントに実際に応答している本番サーバーにパッチを当てることを指していたが、やがて、緊急に作られた更新、または通常の更新周期の外でリリースされた更新を指すようになった。Microsoftは長年この言葉を使ってきたが、その後は別の用語に移っている。それでも現在の更新の種類の一覧は、サービスパックを、ホットフィックス、セキュリティ更新、重要な更新、更新をテストしてまとめた累積的なものだと説明している。元の「熱い」という意味は、ライブパッチに残っている。Linuxカーネルのlivepatchのドキュメントは、これをシステムの再起動なしで重要な関数を修正するものと説明している。
ホットフィックスとパッチの違いは何か
パッチは既存のソフトウェアを変更するあらゆる更新で、ホットフィックスは緊急性とタイミングで定義されるパッチだ。ホットフィックスはすべてパッチだが、パッチの大半は計画されたもので、通常のリリースと一緒に出る。
混乱の大半は、バージョニングとの重なりから生じる。セマンティックバージョニングでは、後方互換のあるバグ修正を行うとPATCHの数字が上がるので、バージョン2.4.0へのホットフィックスは通常2.4.1として出る。計画された保守リリースも2.4.1になりうる。バージョン番号が記録するのはどんな種類の変更かであり、ホットフィックスという言葉が記録するのは、なぜ待てなかったかだ。バグ修正は、通常のスケジュールで出す同じ種類の変更で、コードが同一のこともある。違いは、それを出すためにリリースの周期を崩したかどうかだ。
どんなバグならホットフィックスに値するか
次のリリースまで本番に放置するコストが、急いだ変更を出すリスクより高いときだ。その判断は、騒いでいる人ではなく、落ち着いているときにチームが合意した基準に照らして、決まった担当者が行う。
ホットフィックスが正当化されやすい問題は次のとおりだ。
- データの消失や破損。あとで修復が必要になる誤ったデータの書き込みも含む。
- 悪用されている、または簡単に悪用できるセキュリティ上の脆弱性。
- サインイン、支払い、作業の保存など、中核の操作が多くのユーザーで壊れている。
- 最新リリースによる退行で、前日まで問題のなかった顧客が使えなくなっている。
- ソフトウェアが満たせなくなった、法的または契約上の義務。
次のリリースまで待てることが多いのは、見た目の問題、現実的な回避策があるバグ、影響するユーザーが少なく悪化もしていないものだ。リストを書き出すことが重要なのは、緊急の修正がどれも、本番を守るチェックのいくつかを迂回するからで、何でもホットフィックスにするチームは、静かにリリースの手順を放棄している。
ホットフィックスはどう安全に出荷するか
実際に動いているバージョンを直し、変更は最小限にし、デプロイするそのビルドで修正をテストし、戻す手段を残し、次のリリースでバグが復活しないように修正をメインラインにマージする。
- 確認と範囲の特定。 問題を再現し、上の基準を満たすことを確認して、修正の担当者を一人決める。
- 本番にあるものからブランチを切る。 Vincent Driessenのブランチモデルの記事にあるgit-flowでは、ホットフィックスのブランチは
masterの本番タグから始まり、すぐにバージョンを上げて、完成したブランチをmasterとdevelopの両方にマージして戻す。Driessen自身が2020年にその記事へ付けた注記は、継続的にデリバリーするWebアプリにはもっと単純な流れを勧めていて、その場合のホットフィックスは、メインブランチへの小さなプルリクエストで、すぐにデプロイされる。 - 直せる最小の変更にする。 リファクタリングも余計な機能も入れない。修正でないものは、来週出せばよい。
- 証明する。 修正がなければ失敗してバグを再現するテストを追加し、デプロイするコミットで全体のテストスイートを実行する。
- バージョンを付けてタグを打つ。 パッチの数字を上げ、gitタグとリリースで説明している方法でコミットにタグを付ける。
- 戻す手段を持ってデプロイする。 できるなら段階的に展開し、エラー率を見守り、必要になる前にロールバックのコマンドを把握しておく。
- マージして戻す。 修正をリリースブランチで行ったなら、その日のうちにメインラインにマージする。
ホットフィックスにもチェンジログ項目とリリースノートは必要か
必要だ。バグに遭遇したユーザーは、それが直ったことと、あるなら自分がすべきことを知る必要があるし、あとでバージョンの履歴を読む人は、2.4.0の二日後になぜ2.4.1があるのかを知る必要がある。
ノートは短くする。何が壊れていたか、誰が影響を受けたか、彼らにとって何が変わるか、どのバージョンに修正が入っているかを書く。ホットフィックスがインシデントへの対応なら、緊急リリースノートの指針が当てはまり、通常の修正なら、バグ修正のリリースノートの形式で足りる。チェンジログ項目のないマージをパイプラインがブロックする場合に、ゲートを切らずに緊急の例外を扱う方法は、CIでの強制の記事で説明している。Changeloopはマージされたプルリクエストごとに項目の下書きを作るので、ホットフィックスのPRにも他のマージと同じように下書きができ、何かが公開される前にレビュアーが承認する。
ホットフィックスが日常になるのをどう防ぐか
数えて、一件ごとに調べる。ホットフィックスは、通常のチェックが捕まえるはずだったものが本番に届いたという証拠で、その件数は、状況がよくなっているのか悪くなっているのかを教えてくれる。
DORAのソフトウェアデリバリーの指標には、変更失敗率(change fail rate)が含まれる。これは、リリース後にすぐ対応が必要になったデプロイの割合で、ロールバックやホットフィックスにつながる可能性が高い。この率が上がるときは、リリースが大きすぎるか、テストが製品の領域ごと取りこぼしていることが多い。ホットフィックスのたびに、なぜそのバグが漏れたかを問い、それを止められたはずのテスト、チェック、レビューの手順を追加する。そうしたチェックが通常のリリースのどこに位置するかは、リリース管理プロセスの記事で扱っている。
FAQ
ホットフィックスはパッチと同じか? ホットフィックスは既存のソフトウェアを変更するので、すべてパッチだ。ホットフィックスという言葉には、そのパッチが緊急で、通常のリリース予定の外で出されたという意味が加わる。
ホットフィックスにはどのバージョン番号を付けるか? 通常は、セマンティックバージョニングの次のパッチバージョンで、2.4.0へのホットフィックスなら2.4.1になる。ホットフィックスには後方互換のある修正だけを入れるべきで、それはまさにパッチの増分が約束していることだ。
ホットフィックスが必要かどうかは誰が決めるか? オンコールのエンジニアやリリース責任者のような決まった一つの役割が、事前にチームが書き出した基準を使って決める。インシデント中に合議で決めると遅くなり、一番大声の人で決めるとホットフィックスが日常になる。
ホットフィックスはコードレビューを省いてよいか? 省いてはいけない。レビューは短くしても、残す。十行の変更を別の人が読むのは数分で済み、一つのインシデントを二つに増やす誤字を見つけてくれる。
この記事の技術的な記述は第三者による確認を受けていません。誤りがあればお知らせください。修正します。