手动触发Django电子邮件错误报告

Question

Django错误报告通过发送电子邮件处理未捕获的异常,并(可选)向用户显示一个不错的500错误页面.

这非常有效,但在少数情况下,我想让用户不间断地继续他们的业务,但仍然让Django向我发送有关异常的电子邮件错误报告.

所以基本上:即使我发现异常,我还可以手动发送电子邮件错误报告吗？

当然,我想避免手动生成错误报告电子邮件.

Answer 1

您可以使用以下代码手动发送有关a request和异常的电子邮件e:

import sys
import traceback
from django.core import mail
from django.views.debug import ExceptionReporter

def send_manually_exception_email(request, e):
    exc_info = sys.exc_info()
    reporter = ExceptionReporter(request, is_email=True, *exc_info)
    subject = e.message.replace('\n', '\\n').replace('\r', '\\r')[:989]
    message = "%s\n\n%s" % (
        '\n'.join(traceback.format_exception(*exc_info)),
        reporter.filter.get_request_repr(request)
    )
    mail.mail_admins(
        subject, message, fail_silently=True,
        html_message=reporter.get_traceback_html()
    )

你可以在这样的视图中测试它:

def test_view(request):
    try:
        raise Exception
    except Exception as e:
        send_manually_exception_email(request, e)

Answer 2

只需在您的设置中设置简单的日志处理程序.

LOGGING = {
    'version': 1, 
    'disable_existing_loggers': False,
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse'
        }
    },
    'handlers': {
        'mail_admins': {
            'level': 'ERROR',
            'filters': ['require_debug_false'],
            'class': 'django.utils.log.AdminEmailHandler'
        },
        'app': {
            'level': 'ERROR',
            'filters': ['require_debug_false'],
            'class': 'django.utils.log.AdminEmailHandler'
        },
    },
    'loggers': {
        'django.request': {
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': True,
        },
    }
}

然后在你看来,你可以做任何事情

 import logging
 logger = logging.getLogger('app')

 def some_view(request):
     try:
         # something
         if something_wnet_wrong:
             logger.error('Something went wrong!')
         return some_http_response
     except:
         #something else
         logger.error(sys.exc_info(), request)        
         return some_other_response

如果您需要详细的错误报告,可以尝试这样的方法.

您还需要处理敏感信息.

Answer 3

是的，即使您捕捉到异常，您也可以手动发送电子邮件错误报告。

有几种方法可以解决这个问题。

1. 您可以将现有的默认记录器配置（及其相关的处理程序配置，记录在此处）用于 django.request，它将所有错误消息发送到 mail_admins 处理程序，当 debug 为 false 时，该处理程序将使用 log.error 从 django.request 记录的任何内容发送为使用AdminEmailHandler发送电子邮件，其现有调用点在handle_uncaught_exception 中。
2. 您可以添加使用相同处理程序的其他记录器配置，以在 django.request 之前捕获异常并更早调用 log.error。
3. 您可以子类化 django.request，特别是 handle_uncaught_exception。
4. 您可以使用自定义中间件（例如 StandardExceptionMiddleware）或ExceptionMiddleware
5. 您可以直接手动调用emit inAdminEmailHandler或mail.mail_admins的内容。

在这些选项中，选项 4 似乎是最常用的。

根据您评论中的附加信息，下面是 2 的代码示例。

首先将添加到查看的代码

from django.http import HttpResponse
import logging
logger = logging.getLogger(__name__)

def my_view(request):

    try:
        result = do_something()
        return HttpResponse('<h1>Page was found' + result + '</h1>')
    except Exception: 
         # Can have whatever status_code and title you like, but I was just matching the existing call.
         logger.error('Internal Server Error: %s', request.path,
            exc_info=sys.exc_info(),
            extra={
            'status_code': 500,
            'request': request
            }
         )
         return HttpResponse('<h1>Page was found, and exception was mailed to admins.</h1>')

这是基于的Django的文档视图写作和并介绍Django的日志记录，但还没有经过测试。

然后将额外的记录器配置添加到记录器条目中（按照此处）

'nameofdjangoapplicationgoeshere': {
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': False,
        },

Answer 4

我主要将此模式与标准错误报告一起使用。

import logging    
logger = logging.getLogger('django.request')

#code block in view
try:
    #code that can raise exception
except:
    logger.exception('Information')
#continue as nothing happend

它将触发内置的错误报告，并且 logger.exception 将捕获堆栈帧。https://docs.djangoproject.com/en/1.8/topics/logging/#making-logging-calls

编辑：

我注意到电子邮件中缺少一些信息，为了获得准确的回溯，可以使用以下内置内容：

logger.exception('Internal Server Error: %s', request.path,
                 extra={'status_code': 500, 'request': request})

更多信息可以在这里找到： How to send django exception log Manual?