2023-03-10

Pythonのロギング

ロギングとは

ロギングはソフトウェア開発において重要な要素であり、開発者がコード内で発生するイベントを追跡し記録することができます。Pythonにおいては、ロギングはプログラムの動作やさまざまな状況下での振る舞いを開発者が理解するのに役立つデータをキャプチャし、記録するプロセスです。

ロギングの本質は、エラー、警告、情報メッセージなどプログラム内で発生するイベントをキャプチャし、記録することにあります。このデータは、デバッグ、トラブルシューティング、監査などの目的で使用されるログファイルに保存されます。

Pythonにおけるロギングの必要性

Pythonにおけるロギングの重要性には多くの理由があります。そのうちの1つは、開発者がコード内の問題を迅速に特定し、診断できるようにすることです。イベントをキャプチャし、記録することによって、開発者はエラーが発生している場所、何が原因となっているか、そしてどの程度頻繁に発生しているかを把握することができます。この情報は、コードの改善や将来の問題の防止に役立てることができます。

また、ロギングはセキュリティ上も重要です。プログラム内で発生するイベントをキャプチャし、記録することによって、開発者は潜在的なセキュリティ脅威を特定し、対策を講じることができます。例えば、プログラムがログイン失敗の試行を記録している場合、開発者はそのデータを使用して不審な活動のパターンを特定し、不正なアクセスからシステムを保護するための措置を講じることができます。

ロギングレベル

Pythonのロギングでは、開発者がログファイルにキャプチャして記録するイベントを分類するために使用できる5つのロギングレベルがあります。各ロギングレベルには独自の目的があり、それらを正しく使用することは効果的なロギングの重要な部分です。

DEBUG
これはもっとも低いロギングレベルで、通常はプログラムの内部動作に関する詳細な情報をキャプチャするために使用されます。デバッグログは、問題を診断したりトラブルシューティングしたりする開発者にしか役立たず、本番環境では推奨されていません。
INFO
このロギングレベルは、プログラムの動作に関する一般的な情報をキャプチャするために使用されます。Infoログは、プログラムの全体的な動作を追跡したり、そのパフォーマンスに関する洞察を提供するのに役立ちます。
WARNING
このレベルは、解決する必要がある潜在的な問題や問題を示すイベントをキャプチャするために使用されます。Warningログは、直ちに重要でないが将来的に問題を引き起こす可能性がある問題を特定するのに役立ちます。
ERROR
このロギングレベルは、プログラムの問題やエラーを示すイベントをキャプチャするために使用されます。Errorログは、警告ログよりも重大であり、何かがうまくいかず修正する必要があることを示します。
CRITICAL
これはもっとも高いロギングレベルで、プログラムの致命的な障害を示すイベントをキャプチャするために使用されます。Criticalログは、プログラムがクラッシュしたり完全に動作を停止したりする状況に予約されています。

Pythonにおける基本的なロギング

Pythonにおける基本的なロギングは、ロガーオブジェクトを作成し、ロギングレベルを設定することで、開発者は問題が発生した場合に迅速に特定し、解決することができ、プログラムがスムーズにエラーなく実行されるように確認することができます。

以下は、Pythonで基本的なロギングを実装する方法を示すコード例です。

python

import logging

# ロガーオブジェクトを作成する
logger = logging.getLogger(__name__)

# ロギングレベルを設定する
logger.setLevel(logging.INFO)

# ファイルハンドラを作成する
handler = logging.FileHandler('example.log')

# ロギングフォーマットを設定する
formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
handler.setFormatter(formatter)

# ハンドラをロガーオブジェクトに追加する
logger.addHandler(handler)

# メッセージをロギングする
logger.info('これはinfoメッセージです')

この例では、logging.getLogger()関数を使用してロガーオブジェクトを作成し、setLevel()メソッドを使用してロギングレベルをINFOに設定します。logging.FileHandler()関数を使用してファイルハンドラを作成し、作成されるログファイルの名前を指定します。logging.Formatter()関数を使用して、日付、ロギングレベル、およびメッセージがログファイルに含まれるようにログフォーマットを設定します。

次に、addHandler()メソッドを使用してファイルハンドラをロガーオブジェクトに追加します。これにより、ロガーオブジェクトが作成されたファイルハンドラを使用してイベントをキャプチャして記録するように指示されます。

最後に、logger.info()メソッドを使用してメッセージをロギングします。これにより、infoメッセージがキャプチャされ、ログファイルに記録されます。

以下は、上記のコードからの出力例です。

2023-03-07 15:32:29,654 INFO これはinfoメッセージです

このように、ログメッセージには、ログフォーマットで指定したタイムスタンプ、ログレベル、メッセージが含まれています。これにより、Pythonアプリケーション内の問題を診断したりトラブルシューティングするために役立つ貴重な情報が提供されます。

Pythonにおける高度なロギング

Pythonにおける高度なロギングは、ハンドラを使用してログを出力し、ログメッセージのフォーマットを変更して追加情報を含め、ログファイルをローテーションしてファイルサイズとストレージを管理することを含みます。次に、Pythonで高度なロギングを実装する方法を示す例のコードを示します。

python

import logging
import logging.handlers

# Create a logger object
logger = logging.getLogger(__name__)

# Set the logging level
logger.setLevel(logging.INFO)

# Create a rotating file handler
handler = logging.handlers.RotatingFileHandler('example.log', maxBytes=10000, backupCount=5)

# Set the logging format
formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
handler.setFormatter(formatter)

# Add the handler to the logger object
logger.addHandler(handler)

# Log a message
logger.info('This is an info message')

この例では、logging.handlers.RotatingFileHandler()関数を使用して、作成されるログファイルの名前、新しいファイルを作成する前の最大ファイルサイズ（バイト単位）、保持する最大バックアップファイル数を指定して、ローテーションファイルハンドラを作成します。これにより、ログファイルのサイズとストレージを管理し、プログラム内で発生するイベントの記録を確保できます。

また、logging.Formatter()関数を使用してログメッセージをフォーマットし、ログファイルに日付、ログレベル、メッセージを含めます。これにより、問題を診断し、トラブルシューティングするために使用できる追加情報が提供されます。

最後に、logger.info()メソッドを使用してメッセージをログします。ロガーオブジェクトをローテーションファイルハンドラを使用するように構成したため、このメッセージはログファイルに追加され、必要に応じてファイルがローテーションされます。

以下は、上記のコードからの例の出力です。

2023-03-07 15:32:29,654 INFO これはinfoメッセージです

ログメッセージには、ロギングフォーマットで指定したタイムスタンプ、ロギングレベル、およびメッセージが含まれていることがわかります。ローテーションファイルハンドラーを使用することで、ログファイルがあまり大きくならず、Pythonアプリケーション内で発生するイベントの記録が確実にできます。

なぜprint()ではなくloggingを使うべきか

Pythonにおいて、print()とloggingはプログラムから出力やメッセージを表示する方法の二つです。しかし、二つには大きな違いがあります。

最大の違いは、print()はコンソールやターミナルに即座に出力される一方、loggingはプログラム実行中に発生するイベントやメッセージを記録し、後で分析するためのより堅牢で構造化された方法です。

以下は、print()とloggingの主な違いです。

即時出力 vs. 遅延出力
print()を使用して出力を表示する場合、出力はコンソールやターミナルに即座に表示されます。しかし、loggingでは通常、出力を遅延させてログファイルに記録します。
詳細レベル
print()では、表示するメッセージや値を自由に指定できます。loggingでは、デバッグ情報から重大なエラーまで、各メッセージの詳細レベルを指定できます。
構造化された出力
loggingはprint()よりも構造化された出力フォーマットを提供します。loggingでは、各ログメッセージのフォーマットを指定でき、メッセージ自体、ログレベル、タイムスタンプ、その他の文脈情報を含めることができます。
設定可能性
loggingは高度に設定可能であり、どのメッセージをキャプチャするか、どこに記録するか、どのようにフォーマットするかを指定できます。一方、print()では、メッセージの表示方法をほとんど制御できません。

以下は、loggingがprint()よりも優れている理由です。

堅牢性
loggingは、プログラム実行中に発生するイベントやメッセージを記録するより堅牢で構造化された方法を提供します。これにより、問題を分析して診断することが容易になり、潜在的なセキュリティ脅威を特定することもできます。
永続性
loggingはメッセージをファイルに記録するため、メッセージは永続的で後で確認することができます。これは、トラブルシューティングやデバッグ、監査やコンプライアンスなどに重要です。
スケーラビリティ
大規模または複雑なプログラムで作業する場合、print文はすぐに多くなり、管理が困難になることがあります。loggingを使用すると、キャプチャするメッセージや記録方法を指定できるため、メッセージの量を管理しやすくなります。

Pythonにおけるロギングのベストプラクティス

Pythonにおいてロギングを行う際、ログが効果的かつ有用であるために、開発者が心に留めておくべきいくつかのベストプラクティスがあります。以下は、Pythonにおけるロギングの主なベストプラクティスです。