[Python] ロギングの個人的ベストプラクティス

まぁベストかどうかはわかりませんが、現状の私にとっての最適解です。 <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEid9G04i6Yw-BNUi16o0RaiCkd5c-N6A0QO2MO6n6tlGlZ2zj5fKVqkS2Xcr7KPr-vp319pWmtet6B0pjx7eEMoKMvDGUohyphenhyphen9QiDHR8pp9pS8u3tyUKFersSJVNbCmigzoaYE2ndNcfpfk/s0/2048px-Python-logo-notext.svg.png" hidden><img alt="" border="0" data-original-height="200" data-original-width="200" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEid9G04i6Yw-BNUi16o0RaiCkd5c-N6A0QO2MO6n6tlGlZ2zj5fKVqkS2Xcr7KPr-vp319pWmtet6B0pjx7eEMoKMvDGUohyphenhyphen9QiDHR8pp9pS8u3tyUKFersSJVNbCmigzoaYE2ndNcfpfk/s0/2048px-Python-logo-notext.svg.png"/></a> Python 標準の logging モジュールを使用しますが、logging を直接使うのではなく、`getLogger` でロガーを取得して使用します。 これについては以下の記事にわかりやすく書いてありました。 - https://qiita.com/amedama/items/b856b2f30c2f38665701 このように抽象化しておけば、ロガーハンドラを指定・変更するだけで、ファイルに出力したり、syslog に出力したり、どっかに送信したりと後から簡単に出力先を変更できます。 ## ロギングの設定をファイルに切り出す ログに関する設定は `logging.yaml` というファイルに切り出すことにしました。 これについては以下の記事にわかりやすく書いてありました。 - https://qiita.com/shinsa82/items/a0778fbd127012c93577 例えばこんな感じです。 ``` from logging import config, getLogger import yaml if __name__ == '__main__': with open('./logging.yaml', encoding='utf-8') as f: logconfig = yaml.safe_load(f) config.dictConfig(logconfig) logger = getLogger(__name__) logger.critical('this is critical') logger.error('this is error') logger.warning('this is warning') logger.info('this is info') logger.debug('this is debug') try: hoge = 0/0 except Exception as e: logger.exception('this is exception') ``` ```yaml version: 1 root: level: DEBUG handlers: [console] handlers: console: class: logging.StreamHandler stream: ext://sys.stderr formatter: myformatter formatters: myformatter: format: "%(asctime) [%(levelname:.4)s] %(name)s: %(message)s" ``` こうしておけば、環境に応じて設定を丸ごと差し替えたりも簡単にできます。 フォーマッタで使える変数については以下を参照してください。 - https://docs.python.org/3/library/logging.html#logrecord-attributes ## 設定いろいろ ここらへんは環境や好みに応じて様々だと思うので、あくまでサンプルとして。 適宜追加していきます。 ### コンソール出力をカラフルにして見やすくする `rich` を使うのが簡単かつわかりやすかったです。 例えば以下のような感じです。 ``` root: level: DEBUG handlers: [rich] handlers: rich: class: rich.logging.RichHandler rich_tracebacks: True ``` 以下の記事も参考にしてください。 - https://kuttsun.blogspot.com/2021/12/python_5.html ### syslog に出力する logging モジュールに `SyslogHandler` があるので、基本的にこれを指定するだけで OK です。 詳細は別記事にまとめているので、以下を参考にしてください。 - https://kuttsun.blogspot.com/2021/12/python-syslog.html ### flask の出力設定 Flask が HTTP リクエストを受信するたびにログをレベル INFO で出力するので、ERROR 以上のログのみ出力するように設定変更する方法を以下の記事に書いています。 - https://kuttsun.blogspot.com/2021/12/python-flask.html ## 参考 URL - https://qiita.com/amedama/items/b856b2f30c2f38665701 - https://qiita.com/shinsa82/items/a0778fbd127012c93577 - https://docs.python.org/3/library/logging.html#logrecord-attributes