Pythonでは、ログ出力については標準機能として「logging」が準備されています。
実際のシステムでログ出力をおこなう場合、ログファイルが一種類であることは少なく、用途によってログファイルを分ける事が通常であると思います。
今回は、loggingを使って用途別に複数のログファイルにログ出力する方法を紹介します。
環境情報
- Python 3.4.1
ログ管理クラス
ログファイルは以下の３種類を出力することを想定して、ログ出力クラスを作成していきます。
- アプリケーションログ
- ＳＱＬログ
- エラーログ
この３つのログファイルを出力するログ管理クラスを作成します。
#!/usr/local/bin/python3.4
# coding: utf-8
import logging
from logging import getLogger, FileHandler
#
# ログクラス
#
class Log:
# -------------------------------------
# コンストラクタ
# -------------------------------------
def __init__(self):
# １．アプリケーションログ
l = logging.getLogger('APL')
formatter = logging.Formatter(
'%(asctime)s <%(levelname)s> : %(message)s')
fileHandler =
logging.FileHandler('./logs/APL.log', mode='a')
fileHandler.setFormatter(formatter)
l.setLevel(logging.INFO)
l.addHandler(fileHandler)
# ２．ＳＱＬログ
l = logging.getLogger('SQL')
formatter = logging.Formatter(
'%(asctime)s <%(levelname)s> : %(message)s')
fileHandler =
logging.FileHandler('./logs/SQL.log', mode='a')
fileHandler.setFormatter(formatter)
l.setLevel(logging.INFO)
l.addHandler(fileHandler)
# ３．エラーログ
l = logging.getLogger('ERROR')
formatter = logging.Formatter(
'%(asctime)s <%(levelname)s> : %(message)s')
fileHandler =
logging.FileHandler('./logs/ERROR.log', mode='a')
fileHandler.setFormatter(formatter)
l.setLevel(logging.INFO)
l.addHandler(fileHandler)
Log.__instance = self
# -------------------------------------
# ４．アプリケーションログにINFOでログ出力
# -------------------------------------
def aplInfo(self, msg):
log = logging.getLogger('APL')
log.info(msg)
# -------------------------------------
# ５．ＳＱＬログにINFOでログ出力
# -------------------------------------
def sqlInfo(self, msg):
log = logging.getLogger('SQL')
log.info(msg)
# -------------------------------------
# ６．エラーログにERRORでログ出力
# -------------------------------------
def errorError(self, msg):
log = logging.getLogger('ERROR')
log.error(msg)
順番に説明していきます。
まずは「１．アプリケーションログ」です。
‘APL’という名前のロガーを作成し、ログファイルの出力先パスや、ログファイルの出力フォーマット、および、ログ出力のモードを指定して、ログファイル出力のためのファイルハンドラを作成します。
l = logging.getLogger('APL')
formatter = logging.Formatter('%(asctime)s <%(levelname)s> : %(message)s')
fileHandler = logging.FileHandler('./logs/APL.log', mode='a')
fileHandler.setFormatter(formatter)
次に、ロガーのログレベルを設定し作成したファイルハンドラもロガーに設定すれば完了です。
l.setLevel(logging.INFO) l.addHandler(fileHandler)
「２．ＳＱＬログ」「３．エラーログ」も、設定するロガーが「SQL」「ERROR」といったように異なるだけで、「１．アプリケーションログ」と同様の作りです
４～６はログ出力のメソッドになります。
「４．アプリケーションログにINFOでログ出力」のメソッドである「aplInfo」はAPLロガーを使っています。
つまり、APL.logにログレベルINFOでログ出力をおこないます。
「５．ＳＱＬログにINFOでログ出力」のメソッドである「sqlInfo」も「aplInfo」と同様です。
異なる部分はSQLロガーを使っているということのみであり、SQL.logにログレベルINFOでログ出力をおこないます。
「６．エラーログにERRORでログ出力」は、ERRORロガーを使い、ERROR.logにログレベルERRORでログ出力をおこないます。
今回のサンプルでは３つのログ出力メソッドしか用意していませんが、必要であれば”アプリケーションログにERRORでログ出力””エラーログにINFOでログ出力”といったログ出力も可能な事がわかると思います。
ログを出力する
ログクラスを呼び出せば、ログクラスのコンストラクタでログ出力に必要なインスタンスを使ってくれるので、ログ出力をおこなう方の実装は極めてシンプルです。
以下のログ出力処理を、ログ出力したい箇所に実装すればログ出力がおこなわれます。
# インスタンス作成
log = Log()
# アプリケーションログをINFOで出力
log.aplInfo("アプリケーションログ")
# ＳＱＬログをINFOで出力
log.aplInfo(ＳＱＬログ")
# エラーログをERRORで出力
log.aplInfo(エラーログ")
