タイトル: ログのローテート設定
SEOタイトル: djangoにおけるログのローテート設定【Python】
| この記事の要点 |
|
結論: handlers の class をローテート対応に変える
ログの基本設定はこちらを参照してください。基本設定で logging.FileHandler を使っている部分を、以下のように handlers の中身を変更すると、ログファイルが日ごとに切り替わり、古いものは自動で削除されます。
'handlers': {
'normal': {
'level': 'DEBUG',
'class': 'logging.handlers.TimedRotatingFileHandler',
'filename': os.path.join(LOG_DIR, 'django.log'),
'formatter': 'normal',
'when': 'D', # 単位 Dは日
'interval': 1, # 何日おきか指定
'backupCount': 30, # バックアップ世代数
},
},
Django の LOGGING 設定は Python 標準の logging.config.dictConfig 形式です。class 以外のキー(when など)は、そのままハンドラクラスのコンストラクタ引数として渡されます。
settings.py の全体例
import os
from pathlib import Path
BASE_DIR = Path(__file__).resolve().parent.parent
LOG_DIR = os.path.join(BASE_DIR, 'logs')
os.makedirs(LOG_DIR, exist_ok=True) # フォルダが無いと起動時にエラー
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'normal': {
'format': '%(asctime)s [%(levelname)s] %(name)s: %(message)s',
},
},
'handlers': {
'normal': {
'level': 'INFO',
'class': 'logging.handlers.TimedRotatingFileHandler',
'filename': os.path.join(LOG_DIR, 'django.log'),
'formatter': 'normal',
'when': 'midnight',
'backupCount': 30,
'encoding': 'utf-8',
},
},
'loggers': {
'django': {
'handlers': ['normal'],
'level': 'INFO',
},
'myapp': {
'handlers': ['normal'],
'level': 'DEBUG',
},
},
}
アプリのコードからは logger = logging.getLogger('myapp') のように、loggers に登録した名前でロガーを取得して使います。日本語を出力するなら encoding を指定しておくと文字化けを防げます。
TimedRotatingFileHandler の主なパラメータ
| パラメータ | 意味 | 例 |
|---|---|---|
| when | 切り替えの単位。S(秒)/ M(分)/ H(時)/ D(日)/ midnight(深夜 0 時)/ W0〜W6(曜日、W0 が月曜) | 'midnight' |
| interval | when の何単位ごとに切り替えるか(W0〜W6 では無視) | 1 |
| backupCount | 残す古いファイルの数。超えた分は削除。0 なら削除しない | 30 |
| utc | True なら UTC 基準で時刻を判定 | False |
| encoding | ファイルの文字コード | 'utf-8' |
切り替え後の古いファイルは django.log.2026-10-02 のように日付の接尾辞付きで保存されます。
'D' と 'midnight' の違い: 'D' はプロセス起動時(またはファイルの最終更新時刻)から 24 時間ごとに切り替わるため、切り替わる時刻が日付の境目とずれます。「1 ファイル = 1 日分」にしたいなら 'midnight' を使います。
サイズでローテートする場合
'size_rotate': {
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler',
'filename': os.path.join(LOG_DIR, 'django.log'),
'formatter': 'normal',
'maxBytes': 10 * 1024 * 1024, # 10MB を超えたら切り替え
'backupCount': 5, # django.log.1 〜 .5 を保持
'encoding': 'utf-8',
},
ディスク容量の上限を確実に抑えたい場合はサイズ基準、日付単位で調査したい場合は時間基準が向いています。
落とし穴
- 複数プロセスでの競合: gunicorn や uWSGI でワーカーを複数起動すると、各プロセスが別々にローテートを試み、ログが欠けたり別ファイルに書き続けたりする。本番では OS の logrotate に任せ、Django 側は
logging.handlers.WatchedFileHandler(ファイルが差し替えられたら開き直す)を使うのが定番 - runserver の自動リロード: 開発サーバーは監視用と実行用の 2 プロセスで動くため、Windows ではローテート時に「別のプロセスが使用中」の PermissionError が出ることがある。開発中は
FileHandlerにするか--noreloadを付ける - ローテートはログ出力のタイミングで行われる: 深夜にログが 1 行も出なければ、次に出力された時点で切り替わる
- ログフォルダの権限: 本番で Web サーバーの実行ユーザーに書き込み権限がないと起動に失敗する
確認方法
- 動作確認用に一時的に
'when': 'M'(1 分ごと)にしてサーバーを起動する - 1 分以上空けて何度かアクセスし、
logsフォルダに日時付きのファイルが増えることを確認する backupCountを小さくして、古いファイルが削除されることも確認する- 確認後、
whenを本来の値に戻す