vassili/seitime-frappe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

feat: Allow_site flag in frappe.logger

Browse source
This commit is contained in:
Gavin D'souza 2020-07-27 17:31:12 +05:30
parent ad1152f8e8
commit 1345c2feb3
3 changed files with 16 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
frappe/__init__.py
View file

@ -1559,10 +1559,10 @@ def get_doctype_app(doctype):
loggers = {}
log_level = None
def logger(module=None, with_more_info=False, _site=None, filter=None):
def logger(module=None, with_more_info=False, allow_site=True, filter=None):
'''Returns a python logger that uses StreamHandler'''
from frappe.utils.logger import get_logger
return get_logger(module=module, with_more_info=with_more_info, _site=_site, filter=filter)
return get_logger(module=module, with_more_info=with_more_info, allow_site=allow_site, filter=filter)
def log_error(message=None, title=_("Error")):
'''Log error to Error Log'''

2
frappe/app.py
View file

@ -100,7 +100,7 @@ def application(request):
frappe.recorder.dump()
_site = get_site_name(request.host)
frappe.logger("frappe.web", _site=_site).info({
frappe.logger("frappe.web", allow_site=_site).info({
"site": _site,
"remote_addr": getattr(request, "remote_addr", "NOTFOUND"),
"base_url": getattr(request, "base_url", "NOTFOUND"),

22
frappe/utils/logger.py
View file

@ -14,22 +14,20 @@ import frappe
default_log_level = logging.DEBUG
site = getattr(frappe.local, 'site', None)
def get_logger(module, with_more_info=False, _site=None, filter=None):
def get_logger(module, with_more_info=False, allow_site=True, filter=None):
"""Application Logger for your given module
Args:
module (str): Name of your logger and consequently your log file.
with_more_info (bool, optional): Will log the form dict using the SiteContextFilter. Defaults to False.
_site (str, optional): Overrides the global site variable set in this scope. Defaults to None.
allow_site ((str, bool), optional): Pass site name to explicitly log under it's logs. If True and unspecified, guesses which site the logs would be saved under. Defaults to True.
filter (function, optional): Add a filter function for your logger
Returns:
<class 'logging.Logger'>: Returns a Python logger object with Site and Bench level logging capabilities.
"""
global site
if module in frappe.loggers:
return frappe.loggers[module]
@ -39,8 +37,14 @@ def get_logger(module, with_more_info=False, _site=None, filter=None):
with_more_info = True
logfile = module + '.log'
site = getattr(frappe.local, 'site', None)
equivalent_site = _site or site
if allow_site == True:
site = getattr(frappe.local, 'site', None)
elif allow_site:
site = allow_site
else:
site = False
LOG_FILENAME = os.path.join('..', 'logs', logfile)
logger = logging.getLogger(module)
@ -51,8 +55,8 @@ def get_logger(module, with_more_info=False, _site=None, filter=None):
handler = RotatingFileHandler(LOG_FILENAME, maxBytes=100_000, backupCount=20)
logger.addHandler(handler)
if equivalent_site:
SITELOG_FILENAME = os.path.join(equivalent_site, 'logs', logfile)
if site:
SITELOG_FILENAME = os.path.join(site, 'logs', logfile)
site_handler = RotatingFileHandler(SITELOG_FILENAME, maxBytes=100_000, backupCount=20)
site_handler.setFormatter(formatter)
logger.addHandler(site_handler)
@ -73,7 +77,7 @@ class SiteContextFilter(logging.Filter):
"""This is a filter which injects request information (if available) into the log."""
def filter(self, record):
if "Form Dict" not in text_type(record.msg):
record.msg = text_type(record.msg) + "\nSite: {0}\nForm Dict: {1}".format(site, getattr(frappe.local, 'form_dict', None))
record.msg = text_type(record.msg) + "\nSite: {0}\nForm Dict: {1}".format(getattr(frappe.local, 'site', None), getattr(frappe.local, 'form_dict', None))
return True
def set_log_level(level):