Условия ведения журнала по умолчанию¶

Полный набор условий ведения журнала по умолчанию:

Когда DEBUG имеет значение True:

• Регистратор django отправляет сообщения в иерархии django (кроме django.server) на уровне INFO или выше на консоль.

Когда DEBUG имеет значение False:

• Регистратор django отправляет сообщения в иерархии django (кроме django.server) с уровнем ERROR или CRITICAL в AdminEmailHandler.

Независимо от значения DEBUG:

• Регистратор джанго.сервер отправляет сообщения на уровне INFO или выше на консоль.

Все регистраторы, кроме джанго.сервер, передают журналирование своим родителям, вплоть до корневого регистратора django. Обработчики console и mail_admins прикреплены к корневому регистратору, чтобы обеспечить поведение, описанное выше.

Собственные настройки Python по умолчанию отправляют на консоль записи уровня «WARNING» и выше.

Определение ведения журнала по умолчанию¶

Конфигурация ведения журналов Django по умолчанию наследует настройки Python по умолчанию. Он доступен как django.utils.log.DEFAULT_LOGGING и определен в django/utils/log.py:

{
    "version": 1,
    "disable_existing_loggers": False,
    "filters": {
        "require_debug_false": {
            "()": "django.utils.log.RequireDebugFalse",
        },
        "require_debug_true": {
            "()": "django.utils.log.RequireDebugTrue",
        },
    },
    "formatters": {
        "django.server": {
            "()": "django.utils.log.ServerFormatter",
            "format": "[{server_time}] {message}",
            "style": "{",
        }
    },
    "handlers": {
        "console": {
            "level": "INFO",
            "filters": ["require_debug_true"],
            "class": "logging.StreamHandler",
        },
        "django.server": {
            "level": "INFO",
            "class": "logging.StreamHandler",
            "formatter": "django.server",
        },
        "mail_admins": {
            "level": "ERROR",
            "filters": ["require_debug_false"],
            "class": "django.utils.log.AdminEmailHandler",
        },
    },
    "loggers": {
        "django": {
            "handlers": ["console", "mail_admins"],
            "level": "INFO",
        },
        "django.server": {
            "handlers": ["django.server"],
            "level": "INFO",
            "propagate": False,
        },
    },
}

См. Настройка логгирования о том, как дополнить или заменить эту конфигурацию ведения журнала по умолчанию.

Регистраторы¶

Django предоставляет несколько встроенных средств журналирования.

LOGGING = {
    # ...
    "handlers": {
        "null": {
            "class": "logging.NullHandler",
        },
    },
    "loggers": {
        "django.security.DisallowedHost": {
            "handlers": ["null"],
            "propagate": False,
        },
    },
    # ...
}

Обработчики¶

Django предоставляет один обработчик журнала в дополнение к тех, которые предоставляются модулем ведения журналов Python.

class AdminEmailHandler(include_html=False, email_backend=None, reporter_class=None)¶

Этот обработчик отправляет электронное письмо на сайт ADMINS для каждого полученного сообщения журнала.

Если запись журнала содержит атрибут «запрос», в электронное письмо будет включена полная информация о запросе. Тема электронного письма будет включать фразу «внутренний IP», если IP-адрес клиента указан в настройке INTERNAL_IPS; в противном случае он будет включать «ВНЕШНИЙ IP-адрес».

Если запись журнала содержит информацию о трассировке стека, эта трассировка стека будет включена в электронное письмо.

Аргумент include_html в AdminEmailHandler используется для контроля того, включает ли отслеживаемое электронное письмо HTML-вложение, содержащее полное содержимое веб-страницы отладки, которая была бы создана, если бы DEBUG имел значение True. Чтобы установить это значение в вашей конфигурации, включите его в определение обработчика для django.utils.log.AdminEmailHandler, например:

"handlers": {
    "mail_admins": {
        "level": "ERROR",
        "class": "django.utils.log.AdminEmailHandler",
        "include_html": True,
    },
}

Помните о последствиях безопасности при регистрации при использовании AdminEmailHandler.

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

"handlers": {
    "mail_admins": {
        "level": "ERROR",
        "class": "django.utils.log.AdminEmailHandler",
        "email_backend": "django.core.mail.backends.filebased.EmailBackend",
    },
}

По умолчанию будет использоваться экземпляр почтового сервера, указанный в EMAIL_BACKEND.

Аргумент reporter_class в AdminEmailHandler позволяет предоставить подкласс django.views.debug.ExceptionReporter для настройки текста трассировки, отправляемого в теле письма. Вы предоставляете путь импорта строки к классу, который хотите использовать, например:

"handlers": {
    "mail_admins": {
        "level": "ERROR",
        "class": "django.utils.log.AdminEmailHandler",
        "include_html": True,
        "reporter_class": "somepackage.error_reporter.CustomErrorReporter",
    },
}

send_mail(subject, message, *args, **kwargs)¶

Отправляет электронные письма администраторам. Чтобы настроить это поведение, вы можете создать подкласс класса AdminEmailHandler и переопределить этот метод.

Фильтры¶

Django предоставляет некоторые фильтры журналов в дополнение к тем, которые предоставляются модулем журналирования Python.

class CallbackFilter(callback)¶

Этот фильтр принимает функцию обратного вызова (которая должна принимать один аргумент — запись, которая должна быть зарегистрирована) и вызывает ее для каждой записи, проходящей через фильтр. Обработка этой записи не будет продолжена, если обратный вызов вернет False.

Например, чтобы отфильтровать UnreadablePostError (возникает, когда пользователь отменяет загрузку) из электронных писем администратора, вы должны создать функцию фильтра:

from django.http import UnreadablePostError


def skip_unreadable_post(record):
    if record.exc_info:
        exc_type, exc_value = record.exc_info[:2]
        if isinstance(exc_value, UnreadablePostError):
            return False
    return True

а затем добавьте его в свою конфигурацию журналирования:

LOGGING = {
    # ...
    "filters": {
        "skip_unreadable_posts": {
            "()": "django.utils.log.CallbackFilter",
            "callback": skip_unreadable_post,
        },
    },
    "handlers": {
        "mail_admins": {
            "level": "ERROR",
            "filters": ["skip_unreadable_posts"],
            "class": "django.utils.log.AdminEmailHandler",
        },
    },
    # ...
}

class RequireDebugFalse¶

Этот фильтр будет передавать записи только в том случае, если для параметра settings.DEBUG установлено значение False.

Этот фильтр используется в конфигурации по умолчанию LOGGING следующим образом, чтобы гарантировать, что AdminEmailHandler отправляет электронные письма об ошибках администраторам только тогда, когда DEBUG имеет значение False:

LOGGING = {
    # ...
    "filters": {
        "require_debug_false": {
            "()": "django.utils.log.RequireDebugFalse",
        },
    },
    "handlers": {
        "mail_admins": {
            "level": "ERROR",
            "filters": ["require_debug_false"],
            "class": "django.utils.log.AdminEmailHandler",
        },
    },
    # ...
}

class RequireDebugTrue¶

Этот фильтр аналогичен RequireDebugFalse, за исключением того, что записи передаются только тогда, когда DEBUG имеет значение True.