Pythonのloggingモジュールでログファイルをローテートする方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonのloggingモジュールでログファイルをローテートする方法について現役エンジニアが解説しています。ログのローテート(回転)とは、新しい空のログファイルで追記を再開することです。ファイルが大きくなり、解析が難しくなります。loggingモジュールでローテート方法を解説します。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonのloggingモジュールでログファイルをローテートする方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonのloggingモジュールでログファイルをローテートする方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

ログをローテートすべき理由

ソフトウェアの実行履歴を確認したり、問題発生時に原因を分析したりするのに、ログファイルは不可欠です。

一方でログを単一のファイルに追記し続けると、ログファイルが極端に大きくなり、解析しづらくなります。あまりにファイルが大きくなると、コンピュータのメモリ不足でファイルを開けない場合すらあります。

このような事態を防ぐため、それまでログを追記していたファイルを別の名前に移動し、新しい空のログファイルで追記を再開することを、「ログのローテート(回転)」と言います。

ローテートの契機には、ログのサイズが一定値を越えた場合や、定期的(一日に一度など)な処理がありえます。

loggingモジュールとは

loggingはPythonでログを出力したり、ログファイルを処理したりするのに便利なモジュールです。レベル(DEBUG, INFO, WARNなど)ごとのログ出力制御や、前述のローテート処理もサポートしています。

[PR] Pythonで挫折しない学習方法を動画で公開中

ログファイルとローテートする方法

ソースコード

import logging
import logging.handlers
import time

logger = logging.getLogger()
logging.basicConfig(level=logging.INFO)
logger.addHandler(logging.handlers.RotatingFileHandler(filename='sample.log', maxBytes=100, backupCount=3))

i = 0
while True:
    logger.info('log %d' % i)
    i += 1
    time.sleep(1)

 

実行結果

プログラムを実行すると、sample.logログファイルが生成されます。

ファイルサイズが100バイトを超過すると、sample.logはsample.log.1に名前変更され、新ファイルのsample.logにログが追記されていきます。さらに時間が経過すると、sample.log.1, sample.log.2, sample.log.3 の3世代のバックアップが作成されます。

解説

  1. getLoggerメソッドでログ取得用オブジェクトを取得しました
  2. addHandlerメソッドでログローテート用のハンドラを指定しました
  3. ハンドラ生成時に、ログファイル名、ファイル上限サイズ、バックアップ世代数などを指定できます。

まとめ

この記事ではログファイルをローテートする理由を解説しました。またloggingモジュールを用いたローテート方法を紹介しました。

監修してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能(AI)や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。