デバッグログ【debug log】

概要

デバッグログとは、コンピュータプログラムが実行時の動作状況を時系列で記録したファイル。不具合が発生した際に原因を調査し修正するデバッグ作業に用いられることからこのように呼ばれる。プログラムの起動から終了までの挙動を把握する手がかりとなる。

デバッグログは、プログラムの起動から終了までに生じた出来事を、発生した日時と共に順番に並べる形式で記録される。プログラムが意図せず異常終了した場合には、終了直前に何が起きていたのかを把握する手がかりとなる。

記録する項目はプログラム側であらかじめ定められており、処理が正常に終了したことの報告、不正常な状態に対する警告、エラーの通知などで構成される。各項目には識別用のコードやメッセージ、発生した処理の箇所、発生時点の内部状態を示すデータなどが記録される。

完成したソフトウェアでは、デバッグログを記録する機能自体は内部に組み込まれていても、初期設定では無効化されている場合が多い。記録を開始するには、設定画面や設定ファイルの編集によって「ロギングを有効にする」といった操作を行う必要がある。生成されたログファイルは、ストレージ上のあらかじめ決められた場所に、決められたファイル名で保存される。記録量が増えると処理速度に影響することがあるため、通常運用時は無効化しておき、不具合が起きたときだけ一時的に有効にして再現を試みる運用も行われている。

ログには重要度に応じて情報、警告、エラー、致命的エラーなどの段階が設定される場合があり、出力量を制御できる仕組みが一般的である。出力形式はプレーンテキストのほか、JSONやXMLなどの構造化形式が用いられることもある。エラー発生時にはスタックトレースが出力され、どの処理経路で問題に到達したかを確認できる場合もある。

出力先としてローカルファイルだけでなく、標準出力（通常は画面表示）やオペレーティングシステム（OS）が運用するシステムログ機構、ネットワークを通じた集中ログ管理基盤への送信などを選択できる場合もある。こうした記録先は、クラウド環境や分散システムなど、プログラムの実行環境が分散している場合に特に有用である。なお、記録内容には実行中の内部データが含まれる場合があるため、ログファイルの取り扱いには注意が必要である。