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

В settings.py:

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

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

Настроить обработчик¶

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

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 и выше.

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

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

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-attributes для атрибутов LogRecord, которые можно включить.

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

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

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

Безымянная конфигурация '' захватывает логи из любого приложения 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., 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,
        },
    },
}