ロギングの設定と利用Link to this heading#

LOGGING 辞書を作成するLink to this heading#

settings.py に以下を追加します:

LOGGING = {
    "version": 1,  # the dictConfig format version
    "disable_existing_loggers": False,  # retain the default loggers
}

ほとんどの場合、 disable_existing_loggers を False に設定することで、デフォルトのロギング設定を保持し、拡張できます。

ハンドラを設定するLink to this heading#

この例では、Python の FileHandler を使って、レベル DEBUG 以上のログを (プロジェクトルート内の) general.log ファイルに保存する file という名前のハンドラを設定します:

LOGGING = {
    # ...
    "handlers": {
        "file": {
            "class": "logging.FileHandler",
            "filename": "general.log",
        },
    },
}

Different handler classes take different configuration options. For more information on available handler classes, see the AdminEmailHandler provided by Django and the various handler classes provided by Python.

ログレベルはハンドラで設定することもできます（デフォルトでは、ハンドラはすべてのレベルのログメッセージを受け取ります）。上の例を使うと、次のように書けます:

{
    "class": "logging.FileHandler",
    "filename": "general.log",
    "level": "DEBUG",
}

これで、レベル DEBUG 以上のレコードだけを受け付けるようにハンドラを設定できます。

ロガーマッピングを設定するLink to this heading#

このハンドラにレコードを送信するには、ロガーマッピングをそのハンドラを使うように設定します。例えば:

LOGGING = {
    # ...
    "loggers": {
        "": {
            "level": "DEBUG",
            "handlers": ["file"],
        },
    },
}

マッピングの名前はどのログレコードを処理するかを決定します。この設定 ("") は 無名 です。つまり、 すべての ロガーからのレコードを処理します（レコードを処理するロガーを決定するためにマッピング名を使用する方法については、以下の ロガーの名前空間を使う を参照してください）。

これは DEBUG レベル以上のメッセージを file というハンドラーに転送します。

ロガーは複数のハンドラーにメッセージを転送できるので、ロガーとハンドラーの関係は多対多であることに注意してください。

このコードを実行したら、:

logger.debug("Attempting to connect to API")

プロジェクトルートの general.log ファイルにそのメッセージが保存されるでしょう。

フォーマッタを設定するLink to this heading#

By default, the final log output contains the message part of each LogRecord object. Use a formatter if you want to include additional data. First name and define your formatters - this example defines formatters named verbose and simple:

LOGGING = {
    # ...
    "formatters": {
        "verbose": {
            "format": "{name} {levelname} {asctime} {module} {process:d} {thread:d} {message}",
            "style": "{",
        },
        "simple": {
            "format": "{levelname} {message}",
            "style": "{",
        },
    },
}

style キーワードを使用すると、 str.format() 用の { または string.Template フォーマット用の $ を指定できます。デフォルトは $ です。

含めることができる LogRecord 属性については LogRecord attributes を参照してください。

ハンドラにフォーマッタを適用するには、ハンドラの辞書に formatter エントリを追加します:

"handlers": {
    "file": {
        "class": "logging.FileHandler",
        "filename": "general.log",
        "formatter": "verbose",
    },
}

ロガーの名前空間を使うLink to this heading#

無名のロギング設定 "" は任意の Python アプリケーションからログを取り込みます。名前付きロギング設定は、一致する名前のロガーからだけログを取得します。

The namespace of a logger instance is defined using getLogger(). For example in views.py of my_app:

logger = logging.getLogger(__name__)

これは my_app.views 名前空間にロガーを作成します。 __name__ を使うと、プロジェクト内のアプリケーションにおけるログメッセージの出所に基づいて、自動的にそれらを整理できます。また、それによって名前の衝突が起こらなくなります。

my_app.views という名前のロガーマッピングは、このロガーからレコードを取得します:

LOGGING = {
    # ...
    "loggers": {
        "my_app.views": {...},
    },
}

my_app という名前のロガーマッピングはより広く、 my_app 名前空間内のロガー（my_app.views、my_app.utils などを含む）からレコードを取得します:

LOGGING = {
    # ...
    "loggers": {
        "my_app": {...},
    },
}

ロガーの名前空間を明示的に定義することもできます:

logger = logging.getLogger("project.payment")

そして、それに応じてロガーマッピングを設定することもできます。

LOGGING = {
    # ...
    "loggers": {
        "my_app": {
            # ...
        },
        "my_app.views": {
            # ...
        },
        "my_app.views.private": {
            # ...
            "propagate": False,
        },
    },
}