Djangoでログ/ロガーの設定(logging)

Djangoを使ってWebサービスを作っているときに、ロガーを導入したときの備忘録。

環境は、Django1.10.1, Python2.7。

Qiitaにsakamossanさんのすてきな記事があったので、ほぼ流用

setting.pyにloggerの設定を書く

LOGGING = {
    'version': 1,   # これを設定しないと怒られる
    'formatters': { # 出力フォーマットを文字列形式で指定する
        'all': {    # 出力フォーマットに`all`という名前をつける
            'format': '\t'.join([
                "[%(levelname)s]",
                "asctime:%(asctime)s",
                "module:%(module)s",
                "message:%(message)s",
                # "process:%(process)d",
                # "thread:%(thread)d",
            ])
        },
    },
    'handlers': {  # ログをどこに出すかの設定
        'file': {  # どこに出すかの設定に名前をつける `file`という名前をつけている
            'level': 'DEBUG',  # DEBUG以上のログを取り扱うという意味
            'class': 'logging.handlers.RotatingFileHandler',  # ログを出力するためのクラスを指定(サイズローテーション
            'filename': os.path.join(BASE_DIR, 'django.log'),  # どこに出すか
            'formatter': 'all',  # どの出力フォーマットで出すかを名前で指定
            'maxBytes': 1024 * 1024 * 10, # 10GBでローテーション
            'backupCount': 10, # バックアップファイルは10ファイルまで
        },
        'console': { # どこに出すかの設定をもう一つ、こちらの設定には`console`という名前
            'level': 'DEBUG',
            # こちらは標準出力に出してくれるクラスを指定
            'class': 'logging.StreamHandler', 
            'formatter': 'all'
        },
    },
    'loggers': {  # どんなloggerがあるかを設定する
        'command': {  # commandという名前のloggerを定義
            'handlers': ['file', 'console'],  # 先述のfile, consoleの設定で出力
            'level': 'DEBUG',
        },
    },
}

ロガーを使う

ロガーは、以下の感じで使う。

logger = logging.getLogger('command')
logger.info("表示するメッセージ")

以上！！

参考になる書籍

基礎から学ぶ Django

Python Django 超入門

現場で使える Django の教科書《基礎編》

現場で使える Django の教科書《実践編》

参考にしたサイト様

• ロギング | Django ドキュメント | Django
• djangoのloggerの(最低限の)使い方 - Qiita
• Python3+Django+loggingアレコレ - Qiita