Pythonのロギング（logging）入門：ログ出力の基本と5つのログレベル

ソフトウェアを開発して実行すると、正常な動作を妨げるエラーや例外が発生することがあります。ロギング（ログ記録）は、ソフトウェアの実行中に起こる出来事を追跡し、記録として残すための仕組みです。特に開発段階でのデバッグやテスト実行において、ロギングは非常に重要な役割を果たします。

もしロギングの仕組みがなくプログラムがクラッシュした場合、問題の原因を特定するのは非常に困難になります。小規模なプログラムであれば手作業でも原因を突き止められるかもしれませんが、実際の業務で扱うような複雑なプログラムでは、問題を手動で発見するのはほぼ不可能であり、仮にできたとしても多大な時間を要します。

Pythonには標準でloggingモジュールが用意されており、この問題を簡単に解決できます。ロギングは非常に強力なツールであり、プログラムの処理フローをより深く理解するのに役立つだけでなく、開発時には想定していなかった問題や状況を知らせてくれることもあります。

loggingモジュールとは

Pythonにはloggingモジュールが最初から組み込まれているため、プログラムにインポートするだけですぐに使えます。

import logging

loggingモジュールを使うと、ステータスメッセージをファイルやその他の出力ストリームに書き込めます。ログファイルには、コードのどの部分が実行されたか、どのような問題が発生したかといった情報も含めることができます。

loggingモジュールでは「logger（ロガー）」を使って、確認したいメッセージを記録します。デフォルトでは、イベントの重要度（深刻度）を表す5つのログレベルが用意されています。

5つのログレベル（重要度の低い順）

• DEBUG ─ 詳細な情報を出力するために使用します。主に問題の診断時に活用されます。

• INFO ─ 処理が期待どおりに正しく動作していることを確認するために使用します。

• WARNING ─ 名前のとおり警告用です。将来的に問題につながる可能性のある事象を通知します。

• ERROR ─ アプリケーションやソフトウェアが何らかの機能を実行できなかったことを示すエラーメッセージに使用します。

• CRITICAL ─ プログラムが動作を停止する可能性があるなど、重大な問題が発生したことを通知します。

loggingモジュールはデフォルトのロガーを提供しているため、細かい設定を行わなくてもすぐにロギングを始められます。

使用例

以下は、5つのログレベルすべてのメッセージを出力するシンプルな例です。

import logging

logging.debug('This is a debug message')
logging.info('This is an info message')
logging.warning('This is a warning message')
logging.error('This is an error message')
logging.critical('This is a critical message')

実行結果

WARNING:root:This is a warning message
ERROR:root:This is an error message
CRITICAL:root:This is a critical message

注意： 実行結果を見ると、info()とdebug()のメッセージが出力されていません。これは、デフォルトのロガーが「WARNING以上の重要度」のメッセージのみを表示するように設定されているためです。DEBUGやINFOレベルのメッセージも表示したい場合は、logging.basicConfig(level=logging.DEBUG)のように、ロガーのレベルを手動で設定する必要があります。