Clarified who the AdminEmailHandler emails.

This commit is contained in:
Frédéric Massart 2017-11-21 18:21:31 +08:00 committed by Tim Graham
parent d97f026a7a
commit a5f1e5809f
2 changed files with 12 additions and 13 deletions

View File

@ -48,15 +48,14 @@ of the case of the actual model class name.
Default: ``[]`` (Empty list) Default: ``[]`` (Empty list)
A list of all the people who get code error notifications. When A list of all the people who get code error notifications. When
``DEBUG=False`` and a view raises an exception, Django will email these people :setting:`DEBUG=False <DEBUG>` and :class:`~django.utils.log.AdminEmailHandler`
with the full exception information. Each item in the list should be a tuple is configured in :setting:`LOGGING` (done by default), Django emails these
of (Full name, email address). Example:: people the details of exceptions raised in the request/response cycle.
Each item in the list should be a tuple of (Full name, email address). Example::
[('John', 'john@example.com'), ('Mary', 'mary@example.com')] [('John', 'john@example.com'), ('Mary', 'mary@example.com')]
Note that Django will email *all* of these people whenever an error happens.
See :doc:`/howto/error-reporting` for more information.
.. setting:: ALLOWED_HOSTS .. setting:: ALLOWED_HOSTS
``ALLOWED_HOSTS`` ``ALLOWED_HOSTS``

View File

@ -379,13 +379,13 @@ This logging configuration does the following things:
* Defines two handlers: * Defines two handlers:
* ``console``, a StreamHandler, which will print any ``INFO`` * ``console``, a :class:`~logging.StreamHandler`, which prints any ``INFO``
(or higher) message to stderr. This handler uses the ``simple`` output (or higher) message to ``sys.stderr``. This handler uses the ``simple``
format. output format.
* ``mail_admins``, an AdminEmailHandler, which will email any * ``mail_admins``, an :class:`AdminEmailHandler`, which emails any ``ERROR``
``ERROR`` (or higher) message to the site admins. This handler uses (or higher) message to the site :setting:`ADMINS`. This handler uses the
the ``special`` filter. ``special`` filter.
* Configures three loggers: * Configures three loggers:
@ -587,7 +587,7 @@ Python logging module.
.. class:: AdminEmailHandler(include_html=False, email_backend=None) .. class:: AdminEmailHandler(include_html=False, email_backend=None)
This handler sends an email to the site admins for each log This handler sends an email to the site :setting:`ADMINS` for each log
message it receives. message it receives.
If the log record contains a ``request`` attribute, the full details If the log record contains a ``request`` attribute, the full details