Как настроить и использовать журналирование

Создать словарь LOGGING

В вашем settings.py:

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

Практически всегда имеет смысл сохранить и расширить стандартную конфигурацию ведения журнала, установив disable_existing_loggers в значение False.

Настройка обработчика

В этом примере настраивается единственный обработчик с именем file, который использует FileHandler Python для сохранения логов уровня DEBUG и выше в файл general.log (в корне проекта):

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

Разные классы обработчиков принимают разные параметры конфигурации. Более подробную информацию о доступных классах обработчиков см. в AdminEmailHandler, предоставляемом Django, и различных handler classes, предоставляемых Python.

Уровни логов также можно устанавливать в обработчиках (по умолчанию они принимают сообщения всех уровней). Используя пример выше, добавление:

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

определит конфигурацию обработчика, которая принимает только записи уровня DEBUG и выше.

Настройка отображения логгера

Для отправки записей в этот обработчик настройте отображение логгера, чтобы использовать его, например:

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

Имя отображения определяет, какие записи лога оно будет обрабатывать. Эта конфигурация ('') неименованная. Это означает, что она будет обрабатывать записи всех логгеров (см. Использование пространства имён логгеров ниже, чтобы узнать, как использовать имя отображения для определения логгеров, для которых она будет обрабатывать записи).

Она будет пересылать сообщения уровней DEBUG и выше обработчику с именем file.

Обратите внимание, что один логгер может пересылать сообщения нескольким обработчикам, поэтому отношение между логгерами и обработчиками — многие ко многим.

Если вы выполните:

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

в своём коде, вы найдёте это сообщение в файле general.log в корне проекта.

Настройка форматера

По умолчанию конечный вывод журнала содержит часть сообщения каждого объекта log record. Используйте форматер, если хотите включить дополнительные данные. Сначала назовите и определите форматеры — этот пример определяет форматеры с именами verbose и 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, которые вы можете включить.

Чтобы применить форматер к обработчику, добавьте запись formatter в словарь обработчика, ссылаясь на форматер по имени, например:

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

Использование пространства имён логгеров

Неименованная конфигурация ведения журнала '' собирает журналы из любого приложения Python. Наименованная конфигурация ведения журнала будет собирать журналы только из логгеров с соответствующими именами.

Пространство имён экземпляра логгера определяется с помощью getLogger(). Например, в views.py из 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,
        },
    },
}