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

Создайте словарь 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',
        },
    },
}

Различные классы обработчиков принимают различные параметры конфигурации. Для получения дополнительной информации о доступных классах обработчиков смотрите 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 attributes для атрибутов 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,
        },
    },
}