当DEBUG = False时不触发自定义记录器

时间:2019-04-18 14:00:10

标签: python django django-logging

我在settings.py中有以下代码:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'require_debug_true': { '()': 'django.utils.log.RequireDebugTrue', },
    },
    'handlers': {
        'console': {
            'filters': ['require_debug_true'],
            'class': 'logging.StreamHandler',
        },
        'kodular': {
            'level': 'WARNING',
            'class': 'account.reporter.KodularExceptionHandler',
        },
    },
    'loggers': {
        'django': {
            'handlers': ['console', 'kodular'],
            'level': os.getenv('DJANGO_LOG_LEVEL', 'DEBUG'),
        },
    },
}

KodularExceptionHandler类如下所示:

from copy import copy
import json
import logging
import requests

from django.conf import settings
from django.utils.log import AdminEmailHandler
from django.views.debug import ExceptionReporter

class KodularExceptionHandler(AdminEmailHandler):
    def emit(self, record, *args, **kwargs):
        print("Triggered")
        try:
            request = record.request
            subject = record.getMessage()
        except Exception:
            return

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

        reporter = ExceptionReporter(request, is_email=True, *exc_info)
        message = "%s\n\n%s" % (self.format(copy(record)), reporter.get_traceback_text())

        text = "**Error Level**: *%s* | **Status Code**: `%s`\n\n\n" % (record.levelname, record.status_code)

        url = 'https://api.github.com/repos/'+settings.GITHUB_ORG+'/'+settings.GITHUB_REPO+'/issues'
        session = requests.Session()
        session.auth = (settings.GITHUB_USERNAME, settings.GITHUB_PASSWORD)
        issue = {'title': subject,
                'body': text+message.replace('*', '\*').replace('_', '\_'),
                'labels': ["error"]}
        r = session.post(url, json.dumps(issue))
        if r.status_code != 201:
            return
        github_issue_url = json.loads(r.content)['html_url']



        if record.levelname == "WARNING":
            return

        attachments =  [{
            'title': subject,
            'color': 'danger',
            'actions': [{
                'type': 'button',
                'text': 'Github Issue',
                'url': github_issue_url,
                'style': 'primary',
            }],
            'fields': [{
                "title": "Level",
                "value": record.levelname,
                "short": True
            },{
                "title": "Method",
                "value": request.method if request else 'No Request',
                "short": True
            },{
                "title": "Path",
                "value": request.path if request else 'No Request',
                "short": True
            },{
                "title": "User",
                "value": ( (request.user.username + ' (' + str(request.user.pk) + ')'
                        if request.user.is_authenticated else 'Anonymous' )
                        if request else 'No Request' ),
                "short": True
            },{
                "title": "Status Code",
                "value": record.status_code,
                "short": True
            },{
                "title": "UA",
                "value": ( request.META['HTTP_USER_AGENT']
                        if request and request.META else 'No Request' ),
                "short": False
            },{
                "title": 'GET Params',
                "value": json.dumps(request.GET) if request else 'No Request',
                "short": False
            },{
                "title": "POST Data",
                "value": json.dumps(request.POST) if request else 'No Request',
                "short": False
            }]
        }]

        data = { 'payload': json.dumps({'attachments': attachments}) }
        webhook_url = settings.SLACK_HOOK
        r = requests.post(webhook_url, data=data)

当我在设置中设置DEBUG = True时,一切正常:控制台处理错误(并打印“ Reached”),创建Github问题,并发送Slack通知。

但是,如果我设置DEBUG = False,则会出错。可以想象,控制台输出的信息更少;但既不会创建Github问题,也不会发送Slack通知。

我认为记录器处理程序中某个地方存在问题。看来KodularExceptionHandler没有被触发,因为控制台不会打印“ Reached”,而在启用调试时会触发。

您知道是什么原因导致将debug设置为false时无法触发自定义错误报告类吗?

2 个答案:

答案 0 :(得分:1)

之所以发生这种情况,是因为这是AdminEmailHandler(它是KodularExceptionHandler类的父类)的默认行为(在配置中定义)。由于django应用正在加载(https://github.com/django/django/blob/stable/2.2.x/django/utils/log.py#L49)时AdminEmailHandler类已启用django.utils.log.RequireDebugFalse过滤器,因此该过滤器扩展到从处理程序继承的任何类。

您可以使用设置'disable_existing_loggers': True,也可以完全不继承自AdminEmailHandler。如果查看AdminEmailHandlerhttps://github.com/django/django/blob/stable/2.2.x/django/utils/log.py#L79)的代码,您会注意到您已覆盖其大部分代码(__init__除外)。也许您可以改为从logging.Handler继承。

答案 1 :(得分:0)

我的urls.py文件中有一个小问题。我正在使用自定义错误页面处理程序:

from account import views

handler404 = views.error404
handler500 = views.error500

但是,文件views.py如下所示:

from django.shortcuts import render

from account.admin import requires_login

def error404(request, *args, **kwargs):
    return render(request, 'error/404.html')

def error500(request, *args, **kwargs):
    return render(request, 'error/500.html')

我将所有内容更改为

from django.shortcuts import render

from account.admin import requires_login

def error404(request, *args, **kwargs):
    return render(request, 'error/404.html', status=404)

def error500(request, *args, **kwargs):
    return render(request, 'error/500.html', status=500)