# Django 4.1.8.dev20230308103347 ドキュメント

# ロギング

参考

- How to configure and use logging
- Django logging reference

Python programmers will often use `print()` in their code as a quick and convenient debugging tool. Using the logging framework is only a little more effort than that, but it's much more elegant and flexible. As well as being useful for debugging, logging can also provide you with more - and better structured - information about the state and health of your application.

## 概要

Django uses and extends Python's builtin `logging` module to perform system logging. This module is discussed in detail in Python's own documentation; this section provides a quick overview.

### 登場人物

Pythonのロギングは4つの部分で構成されます。

- ロガー
- ハンドラ
- フィルタ
- フォーマッタ

#### ロガー

A logger is the entry point into the logging system. Each logger is a named bucket to which messages can be written for processing.

ロガーには ログレベル が設定されています。このログレベルはハンドリングされたログメッセージの深刻さを表しています。Pythonは下記のログレベルを定義しています。

- `DEBUG`: デバッグのための低レベルシステム情報
- `INFO`: 一般的なシステム情報
- `WARNING`: 重要度の小さい問題が発生したことを示す情報
- `ERROR`: 大きな問題が発生したことを示す情報
- `CRITICAL`: 重大な問題が発生したことを示す情報

ロガーに記載された各メッセージは ログレコード です。各ログレコードは、特定のメッセージの重要性を表す ログレベル を持ちます。ログレコードには、記録されたイベントを説明するメタデータを含むことができます。これには、スタックトレースやエラーコードと言った詳細を含めることができます。

ロガーにメッセージが渡されたとき、メッセージのログレベルはロガーのログレベルと比較されます。メッセージのログレベルがロガー自体のログレベルと同等以上の場合、メッセージは次の処理に進みます。それ以外の場合、メッセージは無視されます。

ロガーによってメッセージの処理が必要だと判断された場合、メッセージは ハンドラ に渡されます。

#### ハンドラ

The handler is the engine that determines what happens to each message in a logger. It describes a particular logging behavior, such as writing a message to the screen, to a file, or to a network socket.

ロガーと同様に、ハンドラもログレベルを持ちます。ログレコードのログレベルがハンドラのレベルに満たない場合、ハンドラはメッセージを無視します。

ロガーには複数のハンドラを設定でき、また各ハンドラは異なるログレベルを持つことができます。この方法により、メッセージの重要性に応じて通知方法を変えることができます。たとえば、`ERROR` と `CRITICAL` メッセージを呼び出しサービスに転送するハンドラを設定する一方で、後で分析するために (`ERROR` や``CRITICAL`` も含む) すべてのメッセージをファイルに記録する 2 つめのハンドラをセットすることができます。

#### フィルタ

A filter is used to provide additional control over which log records are passed from logger to handler.

デフォルトでは、ログレベル要件を満たしたすべてのログメッセージが処理されます。しかし、フィルタを使用することで、ロギングのプロセスに追加的な要件を設定できます。たとえば、特定のソースからの `ERROR` のみを処理するようにフィルタを設定することができます。

フィルタは、処理前にログレコードを修正するためにも使えます。たとえば、特定の条件を満たした場合に `ERROR` ログレコードを `WARNING` レコードに格下げさせるようなフィルタを設定できます。

フィルタは、ロガーもしくはハンドラに対して設定できます; 複数のフィルタを使って複数のフィルタ動作を連鎖させることも可能です。

#### フォーマッタ

Ultimately, a log record needs to be rendered as text. Formatters describe the exact format of that text. A formatter usually consists of a Python formatting string containing LogRecord attributes; however, you can also write custom formatters to implement specific formatting behavior.

## Security implications

The logging system handles potentially sensitive information. For example, the log record may contain information about a web request or a stack trace, while some of the data you collect in your own loggers may also have security implications. You need to be sure you know:

- what information is collected
- where it will subsequently be stored
- how it will be transferred
- who might have access to it.

To help control the collection of sensitive information, you can explicitly designate certain sensitive information to be filtered out of error reports -- read more about how to filter error reports.

### `AdminEmailHandler`

The built-in `AdminEmailHandler` deserves a mention in the context of security. If its `include_html` option is enabled, the email message it sends will contain a full traceback, with names and values of local variables at each level of the stack, plus the values of your Django settings (in other words, the same level of detail that is exposed in a web page when `DEBUG` is `True`).

It's generally not considered a good idea to send such potentially sensitive information over email. Consider instead using one of the many third-party services to which detailed logs can be sent to get the best of multiple worlds -- the rich information of full tracebacks, clear management of who is notified and has access to the information, and so on.

## ロギングを設定する

Python のロギングライブラリは、実用的なインターフェースから設定ファイルまで、ロギング設定のテクニックを提供しています。デフォルトでは、Django は dictConfig フォーマット を使用します。

In order to configure logging, you use `LOGGING` to define a dictionary of logging settings. These settings describe the loggers, handlers, filters and formatters that you want in your logging setup, and the log levels and other properties that you want those components to have.

デフォルトでは、`LOGGING` 設定は、以下のスキームを使って Django のデフォルトロギング設定 に統合されています。

`LOGGING` の `disable_existing_loggers` キーの値を `True` にすると、全てのデフォルトの設定が無効になります（キーが存在しない場合は `dictConfig` のデフォルトになります）。このため、 `'disable_existing_loggers': True` を使う場合は注意してください。 `True` を設定する必要は殆どないでしょう。 `disable_existing_loggers` を `False` に設定して、デフォルトのロガーの一部、または全てを定義しなおすこともできます。あるいは、 `LOGGING_CONFIG` を `None` に設定して、 ロギングの設定を自分で行うこと も出来ます。

ロギングは、一般的な Django の `setup()` 関数の一部として設定されます。したがって、ロガーが常にプロジェクトコード内で使用準備ができていることが保証されています。

### 例

dictConfig フォーマット に関する完全なドキュメントが、ロギング設定ディクショナリの最高の教材です。とはいえ、どんなことが可能なのか知ってもらうため、以下にいくつかの例を示します。

最初に、全てのログメッセージをコンソールに出力するための最低限の設定がこちらです。

`settings.py`

    import os

    LOGGING = {
        'version': 1,
        'disable_existing_loggers': False,
        'handlers': {
            'console': {
                'class': 'logging.StreamHandler',
            },
        },
        'root': {
            'handlers': ['console'],
            'level': 'WARNING',
        },
    }

この設定では、 `root` という名前の親のロガーがあり、 `WARNING` レベル以上のメッセージを受け取ったら、 console ハンドラに送るようになっています。 level を `INFO` または `DEBUG` にすると、より詳細なメッセージも表示されるようになります。この設定は開発中に役に立ちます。

Next we can add more fine-grained logging. Here's an example of how to make the logging system print more messages from just the django named logger:

`settings.py`

    import os

    LOGGING = {
        'version': 1,
        'disable_existing_loggers': False,
        'handlers': {
            'console': {
                'class': 'logging.StreamHandler',
            },
        },
        'root': {
            'handlers': ['console'],
            'level': 'WARNING',
        },
        'loggers': {
            'django': {
                'handlers': ['console'],
                'level': os.getenv('DJANGO_LOG_LEVEL', 'INFO'),
                'propagate': False,
            },
        },
    }

By default, this config sends messages from the `django` logger of level `INFO` or higher to the console. This is the same level as Django's default logging config, except that the default config only displays log records when `DEBUG=True`. Django does not log many such `INFO` level messages. With this config, however, you can also set the environment variable `DJANGO_LOG_LEVEL=DEBUG` to see all of Django's debug logging which is very verbose as it includes all database queries.

必ずしもコンソールに出力する必要はありません。 django という名前のロガーをファイルに書き込むにはこのように設定します。

`settings.py`

    LOGGING = {
        'version': 1,
        'disable_existing_loggers': False,
        'handlers': {
            'file': {
                'level': 'DEBUG',
                'class': 'logging.FileHandler',
                'filename': '/path/to/django/debug.log',
            },
        },
        'loggers': {
            'django': {
                'handlers': ['file'],
                'level': 'DEBUG',
                'propagate': True,
            },
        },
    }

この例を使用するときは、`'filename'` のパスを Django アプリケーションを実行しているユーザーが書き込み可能な場所に変更してください。

最後に、かなり複雑なロギングの設定の例です。

`settings.py`

    LOGGING = {
        'version': 1,
        'disable_existing_loggers': False,
        'formatters': {
            'verbose': {
                'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
                'style': '{',
            },
            'simple': {
                'format': '{levelname} {message}',
                'style': '{',
            },
        },
        'filters': {
            'special': {
                '()': 'project.logging.SpecialFilter',
                'foo': 'bar',
            },
            'require_debug_true': {
                '()': 'django.utils.log.RequireDebugTrue',
            },
        },
        'handlers': {
            'console': {
                'level': 'INFO',
                'filters': ['require_debug_true'],
                'class': 'logging.StreamHandler',
                'formatter': 'simple'
            },
            'mail_admins': {
                'level': 'ERROR',
                'class': 'django.utils.log.AdminEmailHandler',
                'filters': ['special']
            }
        },
        'loggers': {
            'django': {
                'handlers': ['console'],
                'propagate': True,
            },
            'django.request': {
                'handlers': ['mail_admins'],
                'level': 'ERROR',
                'propagate': False,
            },
            'myproject.custom': {
                'handlers': ['console', 'mail_admins'],
                'level': 'INFO',
                'filters': ['special']
            }
        }
    }

このロギング設定は、以下のことを行います:

- 設定が「dictConfig バージョン 1」形式であることを明示します。 現在、これが唯一の dictConfig 形式のバージョンです。

- 2 つのフォーマッタを定義します:

  - `simple`, that outputs the log level name (e.g., `DEBUG`) and the log message.

    この `format` 文字列は標準の Python 文字列フォーマットで、各ログ行で出力される詳細を定義します。出力可能な詳細の全リストは Formatter Objects に記載されています。

  - `verbose` は、ログレベルの名称とログメッセージに加えて、時刻、プロセス、スレッド、ログメッセージを生成したモジュールを出力します。

- 2 つのフィルタを定義します:

  - `project.logging.SpecialFilter`, using the alias `special`. If this filter required additional arguments, they can be provided as additional keys in the filter configuration dictionary. In this case, the argument `foo` will be given a value of `bar` when instantiating `SpecialFilter`.
  - `django.utils.log.RequireDebugTrue` は、`DEBUG` が `True` のときにレコードの処理を進めます。

- 2 つのハンドラを定義します:

  - `console` は、すべての `INFO` 以上のメッセージを `sys.stderr` に表示 (print) する `StreamHandler` クラスです。このハンドラは `simple` 出力フォーマットを使用します。
  - `mail_admins`, an `AdminEmailHandler`, which emails any `ERROR` (or higher) message to the site `ADMINS`. This handler uses the `special` filter.

- 3 つのロガーを設定します:

  - `django` は、すべてのメッセージを `console` ハンドラに渡します。
  - `django.request` は、すべての `ERROR` メッセージを `mail_admins` ハンドラに渡します。加えて、このロガーはメッセージを親に 伝えない よう設定されています。これは、`django.request` 内に記述されたログメッセージは `django` ロガーで処理されないことを意味します。
  - `myproject.custom` は `INFO` もしくはそれ以上のすべてのメッセージを渡し、`special` フィルタを 2 つのハンドラに引き渡します -- `console` と `mail_admins` です。これは、`INFO` 以上のレベルのメッセージがコンソールで表示され、さらに `ERROR` と `CRITICAL` のメッセージは E メールでも出力されることを意味します。

### カスタムのロギング設定

ロガーの設定に Python の dictConfig フォーマットを使用したくない場合は、あなた自身の設定スキームを定義することができます。

The `LOGGING_CONFIG` setting defines the callable that will be used to configure Django's loggers. By default, it points at Python's `logging.config.dictConfig()` function. However, if you want to use a different configuration process, you can use any other callable that takes a single argument. The contents of `LOGGING` will be provided as the value of that argument when logging is configured.

### ロギング設定を無効化する

ロギングを全く設定したくない（あるいは、自分でロギングをやりたい）なら、 `LOGGING_CONFIG` を `None` に設定することもできます。これにより、 Django のデフォルトのロギング設定 を無効化できます。

`LOGGING_CONFIG` を `None` に設定すると、自動でロギングの設定が行われなくなるだけです。ロギング自体が使えなくなるわけではありません。自動でのロギング設定を無効化しても、 Django はロギングのメソッドを呼び、もしログ設定がされていれば、そこに出力されます。

Django の自動でのログ設定を無効化し、手動で設定する場合はこのようにします。

`settings.py`

    LOGGING_CONFIG = None

    import logging.config
    logging.config.dictConfig(...)

Note that the default configuration process only calls `LOGGING_CONFIG` once settings are fully-loaded. In contrast, manually configuring the logging in your settings file will load your logging config immediately. As such, your logging config must appear after any settings on which it depends.