はじめに
アプリのログを1ファイルに書き続けると、ディスクを圧迫します。Python標準の logging.handlers.RotatingFileHandler を使えば、サイズ上限と保持数を指定して自動で回転できます。
この記事では、実際にログを書き、生成されるファイル名・サイズ・保持数を確認します。
環境
- Windows 11(ビルド 10.0.26200)
- Python 3.11.5
やったこと
1. ハンドラーを設定する
import logging
import logging.handlers
from pathlib import Path
logdir = Path("C:/work/logs")
logdir.mkdir(parents=True, exist_ok=True)
logpath = logdir / "app.log"
logger = logging.getLogger("demo")
logger.setLevel(logging.INFO)
logger.handlers.clear()
handler = logging.handlers.RotatingFileHandler(
logpath,
maxBytes=500,
backupCount=3,
encoding="utf-8",
)
handler.setFormatter(logging.Formatter("%(asctime)s %(levelname)s %(message)s"))
logger.addHandler(handler)
2. ログを書く
for i in range(40):
logger.info("line %02d %s", i, "x" * 20)
handler.close()
3. 生成されたファイルを確認する
for f in sorted(logdir.glob("app.log*")):
print(f.name, f.stat().st_size)
結果:
app.log 472
app.log.1 472
app.log.2 472
app.log.3 472
app.log が現在のファイル、app.log.1 が1つ前、app.log.2 が2つ前、app.log.3 が3つ前です。backupCount=3 なので、現在+バックアップ3個の合計4ファイルが残ります。
4. 回転の条件を確認する
maxBytes=500 ですが、各ファイルは472バイトです。これは、1レコードを書いた後にサイズが500を超えた時点で回転するためです。レコードの途中で分割されることはありません。
1レコード ≈ 48バイト
472バイト ≈ 9〜10レコード
5. 古いログを消す
backupCount を超えた古いファイルは自動で削除されます。上の例では app.log.4 は作られません。
ハマった点
encoding を指定しないと文字化けする
Windowsの既定エンコーディングは環境によって異なります。日本語のログを書く場合は encoding="utf-8" を明示します。
複数プロセスで同じファイルに書かない
RotatingFileHandler はプロセス内のロックしか持ちません。複数プロセスが同じログファイルに書くと、回転のタイミングで競合します。プロセスごとにファイルを分けるか、QueueHandler で1プロセスに集約します。
回転直後のファイル名を決め打ちしない
app.log.1 が最新のバックアップとは限りません。回転の実装や同時書き込みの状況で変わります。必要な場合は、ファイル名ではなくタイムスタンプをログに含めます。
ディスク容量を監視する
backupCount を大きくしすぎると、古いログが残り続けます。合計サイズの上限(maxBytes × (backupCount + 1))を意識して設計します。
まとめ
-
RotatingFileHandlerはmaxBytesとbackupCountでサイズベースの回転ができる。 -
maxBytes=500、backupCount=3の実測では、472バイトのファイルが4個残った。 - 回転はレコード単位で行われ、ファイルは上限を少し超えることがある。
-
encoding="utf-8"を明示する。 - 複数プロセスで同じファイルに書かない。合計サイズの上限を設計する。