Pythonのlogging・loggerの使い方・ログ出力設定の方法まとめ

# [ Pythonのlogging の手順 ]

# 1. loggingモジュールをインポートする
import logging

# 2. ログレベルを設定する
# => LogLevel には、DEBUG, INFO, WARNING, ERROR, CRITICAL の5つがあります。

# 今回は、WARNING レベルを設定
# => DEBUG, INFO, レベルのログ情報は、出力されない！
logging.basicConfig(level=logging.WARNING)

# 3. logging.getLogger('logger名') で、loggerインスタンスを作成する
# 引数に文字列を入れることでログの出力名を設定できます
logger = logging.getLogger('log_test.py')

# 4. ログフォーマットを設定する
# 実行時間(年-月-日 時-分-秒,ミリ秒): ファイル名: 行番号 : ログレベル名 : メッセージ文字列
formatter = logging.Formatter('%(asctime)s: %(filename)s: %(lineno)d: %(levelname)s: %(message)s')

# 5. ログ出力先を設定する。

## 5-1. ファイルに、ログを出力する場合

## FileHandlerのインスタンスを作成する => FormatをSetする => loggerにHandlerを追加する
file_handler = logging.FileHandler('./logs/test.log', encoding='utf-8')
file_handler.setFormatter(formatter)
logger.addHandler(file_handler)

## 5-2. 標準出力に出力する場合

## StreamHandlerのインスタンスを作成する => FormatをSetする => loggerにHandlerを追加する
# sh = logging.StreamHandler()
# sh.setFormatter(formatter)
# logger.addHandler(sh)

# 6. ログを出力する。
print('---------------------------------------------------')
logger.debug('debug message')
logger.info('info message')
logger.warning('warning message')
logger.error('error message')
logger.critical('critical message')
print('---------------------------------------------------')

2023-04-23 22:19:12,318: log_test.py: 38: WARNING: warning message
2023-04-23 22:19:12,319: log_test.py: 39: ERROR: error message
2023-04-23 22:19:12,319: log_test.py: 40: CRITICAL: critical message

python log_test.py
---------------------------------------------------
WARNING:log_test.py:warning message
ERROR:log_test.py:error message
CRITICAL:log_test.py:critical message
---------------------------------------------------

python log_test.py
---------------------------------------------------
2023-04-23 22:18:39,032: log_test.py: 38: WARNING: warning message
WARNING:log_test.py:warning message
2023-04-23 22:18:39,032: log_test.py: 39: ERROR: error message
ERROR:log_test.py:error message
2023-04-23 22:18:39,032: log_test.py: 40: CRITICAL: critical message
CRITICAL:log_test.py:critical message
---------------------------------------------------

import logging

# 1. TimedRotatingFileHandler モジュールをインポートする
from logging.handlers import TimedRotatingFileHandler

logging.basicConfig(level=logging.WARNING)

logger = logging.getLogger('log_test.py')

# ログフォーマットを設定する
# 実行時間(年-月-日 時-分-秒,ミリ秒): ファイル名: 行番号 : ログレベル名 : メッセージ文字列
formatter = logging.Formatter(
  '%(asctime)s: %(filename)s: %(lineno)d: %(levelname)s: %(message)s'
)

# 2. TimedRotatingFileHandler => ファイルに対するログ出力をローテーションできる
# ログファイルのローテート設定(Ver.日時)

# 2-1. 1日ごとにログファイルがローテーションされ、バックアップファイルは20ファイル(20日分)まで保存されます。
day_rotaite_handler = TimedRotatingFileHandler(
  filename='./logs/day.log', 
  when='D', 
  interval=1, 
  backupCount=20, 
  encoding='utf-8'
)

# 2-2. 作成されるログファイル名には、ローテーション時に年月日が付加されます
day_rotaite_handler.suffix = "%Y%m%d"
day_rotaite_handler.setFormatter(formatter)
logger.addHandler(day_rotaite_handler)

# 標準出力に出力する
sh = logging.StreamHandler()
sh.setFormatter(formatter)
logger.addHandler(sh)

print('---------------------------------------------------')
logger.debug('debug message')
logger.info('info message')
logger.warning('warning message')
logger.error('error message')
logger.critical('critical message')
print('---------------------------------------------------')