48e0aa23f5
* fix: log to stdout/stderr in json format * chore: remove UTILS_LOGGER_LEVELS This is not used (there _is_ a setting for the django.security logger in settings_local.py on production, but it is redundant with the settings.LOGGING configuration and is not doing anything). * chore: revert to debug_console django logging * chore: log.log to syslog via datatracker logger * chore: remove unused imports --------- Co-authored-by: Robert Sparks <rjsparks@nostrum.com>
125 lines
4.7 KiB
Python
125 lines
4.7 KiB
Python
# Copyright The IETF Trust 2007-2020, All Rights Reserved
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
|
import sys
|
|
import logging
|
|
import logging.handlers
|
|
import inspect
|
|
import os.path
|
|
import traceback
|
|
|
|
from django.conf import settings
|
|
|
|
import debug # pyflakes:ignore
|
|
|
|
|
|
def getclass(frame):
|
|
cls = None
|
|
argnames, varargs, varkw, defaults = inspect.getargvalues(frame)
|
|
if len(argnames) > 0:
|
|
selfname = argnames[0]
|
|
cls = defaults[selfname].__class__
|
|
return cls
|
|
|
|
def getcaller():
|
|
parent, pfile, pline, pfunction, lines, index = inspect.stack()[2]
|
|
pmodule = inspect.getmodulename(pfile)
|
|
pclass = getclass(parent)
|
|
return (pmodule, pclass, pfunction, pfile, pline)
|
|
|
|
def log(msg, e=None):
|
|
"Logs the given calling point and message to the logging framework's datatracker handler at severity INFO"
|
|
if settings.SERVER_MODE == 'test' and not getattr(settings, 'show_logging',False):
|
|
return
|
|
if not isinstance(msg, str):
|
|
msg = msg.encode('unicode_escape')
|
|
try:
|
|
mod, cls, func, file, line = getcaller()
|
|
file = os.path.abspath(file)
|
|
file = file.replace(settings.BASE_DIR, "")
|
|
if func == "<module>":
|
|
where = ""
|
|
else:
|
|
where = " in " + func + "()"
|
|
except IndexError:
|
|
file, line, where = "/<UNKNOWN>", 0, ""
|
|
|
|
logging.getLogger("datatracker").info(msg=msg, extra = {"file":file, "line":line, "where":where})
|
|
|
|
|
|
def exc_parts():
|
|
info = sys.exc_info()
|
|
extype = info[0]
|
|
value = info[1]
|
|
tb = traceback.format_tb(info[2])
|
|
return (extype, value, tb)
|
|
|
|
def build_traceback(stack):
|
|
"""
|
|
Build something that looks sufficiently like a traceback to be passed to a
|
|
logging.logger as the exc_info argument.
|
|
"""
|
|
class Traceback():
|
|
pass
|
|
next = None
|
|
for frame_record in stack:
|
|
fr_frame, fr_filename, fr_lineno, fr_funcname, fr_context, fr_context_this = frame_record
|
|
tb = Traceback()
|
|
tb.tb_frame = fr_frame
|
|
tb.tb_lasti = fr_frame.f_lasti
|
|
tb.tb_lineno = fr_lineno
|
|
tb.tb_next = next
|
|
next = tb
|
|
# Stop traceback at _get_response() -- we don't want to see the
|
|
# middleware, debug server, or wsgi internals when the exception
|
|
# occurs in our app code, below _get_response():
|
|
if fr_funcname == '_get_response' and fr_filename.endswith('django/core/handlers/base.py'):
|
|
break
|
|
return tb
|
|
|
|
def assertion(statement, state=True, note=None):
|
|
"""
|
|
This acts like an assertion. It uses the django logger in order to send
|
|
the failed assertion and a backtrace as for an internal server error.
|
|
"""
|
|
logger = logging.getLogger("django") # Note this is a change - before this would have gone to "django"
|
|
frame = inspect.currentframe().f_back
|
|
value = eval(statement, frame.f_globals, frame.f_locals)
|
|
if bool(value) != bool(state):
|
|
if (settings.DEBUG is True) or (settings.SERVER_MODE == 'test') :
|
|
if note:
|
|
raise AssertionError("Assertion failed: '%s': %s != %s (%s)." % (statement, repr(value), state, note))
|
|
else:
|
|
raise AssertionError("Assertion failed: '%s': %s != %s." % (statement, repr(value), state))
|
|
else:
|
|
# build a simulated traceback object
|
|
tb = build_traceback(inspect.stack()[1:])
|
|
e = AssertionError(statement)
|
|
# provide extra info if available
|
|
extra = {}
|
|
for key in [ 'request', 'status_code', ]:
|
|
if key in frame.f_locals:
|
|
extra[key] = frame.f_locals[key]
|
|
if note:
|
|
logger.error("Assertion failed: '%s': %s != %s (%s)", statement, repr(value), state, note, exc_info=(AssertionError, e, tb), extra=extra)
|
|
else:
|
|
logger.error("Assertion failed: '%s': %s != %s", statement, repr(value), state, exc_info=(AssertionError, e, tb), extra=extra)
|
|
|
|
def unreachable(date="(unknown)"):
|
|
"Raises an assertion or sends traceback to admins if executed."
|
|
logger = logging.getLogger("django")
|
|
frame = inspect.currentframe().f_back
|
|
if settings.DEBUG is True or settings.SERVER_MODE == 'test':
|
|
raise AssertionError("Arrived at code in %s() which was marked unreachable on %s." % (frame.f_code.co_name, date))
|
|
else:
|
|
# build a simulated traceback object
|
|
tb = build_traceback(inspect.stack()[1:])
|
|
# provide extra info if available
|
|
extra = {}
|
|
for key in [ 'request', 'status_code', ]:
|
|
if key in frame.f_locals:
|
|
extra[key] = frame.f_locals[key]
|
|
logger.error("Arrived at code in %s() which was marked unreachable on %s." % (frame.f_code.co_name, date),
|
|
exc_info=(AssertionError, None, tb), extra=extra)
|