Django错误电子邮件太长了。我如何截断它?

时间:2016-03-22 21:41:46

标签: django django-errors

似乎Django 1.9中的错误电子邮件比以前长得多。 “设置”有一整段,我认为这是多余的,可能太暴露了。

编辑Django发送的错误电子邮件的最佳方法是什么?

编辑:我不只是试图隐藏敏感信息。 Django 1.9中的电子邮件中有更多内容,我希望将电子邮件的格式更改为更短。我以旧方式喜欢它。

2 个答案:

答案 0 :(得分:4)

django debug view中有一个django模板变量TECHNICAL_500_TEMPLATE / TECHNICAL_500_TEXT_TEMPLATE,用于控制错误报告中可见的内容,当然还有错误电子邮件。注释解释说模板在python变量中,以便在模板加载器中断时生成错误。您可以在django包中更改此变量,但我不建议这样做。 TECHNICAL_500_TEMPLATE类在同一文件中引用ExceptionReporter

django utils log中的班级AdminEmailHandler然后使用ExceptionReporter生成HTML错误报告。

您可以继承AdminEmailHandler并覆盖emit函数,以包含使用您自己定义的ExceptionReporter的{​​{1}}的子类版本。

以下是一个例子:

使用

创建TECHNICAL_500_TEMPLATE
reporter.py

然后只需将您的django设置设置为使用logging section中的新处理程序。

from copy import copy

from django.views import debug
from django.utils import log
from django.conf import settings
from django import template

TECHNICAL_500_TEMPLATE = """
    # custom template here, copy the original and make adjustments
"""
TECHNICAL_500_TEXT_TEMPLATE = """
    # custom template here, copy the original and make adjustments
"""

class CustomExceptionReporter(debug.ExceptionReporter):
    def get_traceback_html(self):
        t = debug.DEBUG_ENGINE.from_string(TECHNICAL_500_TEMPLATE)
        c = template.Context(self.get_traceback_data(), use_l10n=False)
        return t.render(c)

    def get_traceback_text(self):
        t = debug.DEBUG_ENGINE.from_string(TECHNICAL_500_TEXT_TEMPLATE)
        c = template.Context(self.get_traceback_data(), autoescape=False, use_l10n=False)
        return t.render(c)

class CustomAdminEmailHandler(log.AdminEmailHandler):
    def emit(self, record):
        try:
            request = record.request
            subject = '%s (%s IP): %s' % (
                record.levelname,
                ('internal' if request.META.get('REMOTE_ADDR') in settings.INTERNAL_IPS
                 else 'EXTERNAL'),
                record.getMessage()
            )
        except Exception:
            subject = '%s: %s' % (
                record.levelname,
                record.getMessage()
            )
            request = None
        subject = self.format_subject(subject)

        no_exc_record = copy(record)
        no_exc_record.exc_info = None
        no_exc_record.exc_text = None

        if record.exc_info:
            exc_info = record.exc_info
        else:
            exc_info = (None, record.getMessage(), None)

        reporter = CustomExceptionReporter(request, is_email=True, *exc_info)
        message = "%s\n\n%s" % (self.format(no_exc_record), reporter.get_traceback_text())
        html_message = reporter.get_traceback_html() if self.include_html else None
        self.send_mail(subject, message, fail_silently=True, html_message=html_message)

如果您只想隐藏设置,可以在LOGGING = { # Your other logging settings # ... 'handlers': { 'mail_admins': { 'level': 'ERROR', 'class': 'project.reporter.CustomAdminEmailHandler', 'filters': ['special'] } }, }

中覆盖并复制粘贴'settings': get_safe_settings(),,以便注释掉def get_traceback_data(self):第294行。

答案 1 :(得分:1)

对于仍在寻找答案的人:

在django 3.0中,他们添加了添加reporter_class的选项,该选项可自定义 just 电子邮件正文和回溯文本呈现。

因此,如果您只是想更改电子邮件模板,则无需覆盖AdminEmailHandler

因此,根据@Airith答案,您需要:

# custom_exception_reporter.py

from django.views import debug
from django import template

TECHNICAL_500_TEXT_TEMPLATE = """ 
# custom template here, copy the original and make adjustments 
"""

class CustomExceptionReporter(debug.ExceptionReporter):
    def get_traceback_text(self):
        t = debug.DEBUG_ENGINE.from_string(TECHNICAL_500_TEXT_TEMPLATE)
        c = template.Context(self.get_traceback_data(), autoescape=False, use_l10n=False)
        return t.render(c)

,然后在您的日志配置中:

'handlers': {
        'mail_admins': {
             'level': 'ERROR',
             'class': 'django.utils.log.AdminEmailHandler',
             'include_html': False,
             'reporter_class': 'project.custom_exception_reporter.CustomExceptionReporter'
        },

两个注意事项:

  1. 如果您还希望以HTML格式发送电子邮件正文,则需要具有另一个模板-TECHNICAL_500_TEMPLATE,新功能-get_traceback_html(),并在日志配置中设置include_html = True。同样在这里,您应该复制django的默认模板,然后更改所需的内容。
  2. 如果您不想将整个模板保存在该文件中,而是保存在另一个.html文件中,请注意,即使将其放置在您定义的模板目录中也不会找到它。 我通过将template.html文件保留在与 自定义报告程序.py文件。

custom_exception_report.py的示例,其中将模板保存在同一目录中(如注释2中所述):

import os
from django.views import debug
from django import template

TECHNICAL_500_TEXT_TEMPLATE = "technical_500.text"


class CustomExceptionReporter(debug.ExceptionReporter):
    def get_traceback_text(self):
        t = self._get_template(TECHNICAL_500_TEXT_TEMPLATE)
        c = template.Context(self.get_traceback_data(), autoescape=False, use_l10n=False)
        return t.render(c)

    @staticmethod
    def _get_template(template_name):
        dir_path = os.path.dirname(os.path.realpath(__file__))
        template_path = os.path.join(dir_path, template_name)
        with open(template_path, 'r') as fh:
            return debug.DEBUG_ENGINE.from_string(fh.read())

您可以在Django文档here

中阅读有关报告类的更多信息。