synapse-product/synapse/util/logutils.py

195 lines
5.1 KiB
Python
Raw Normal View History

2014-08-12 10:10:52 -04:00
# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 10:10:52 -04:00
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import inspect
2018-07-09 02:09:20 -04:00
import logging
import time
2018-07-09 02:09:20 -04:00
from functools import wraps
from inspect import getcallargs
from six import PY3
_TIME_FUNC_ID = 0
def _log_debug_as_f(f, msg, msg_args):
name = f.__module__
logger = logging.getLogger(name)
if logger.isEnabledFor(logging.DEBUG):
if PY3:
lineno = f.__code__.co_firstlineno
pathname = f.__code__.co_filename
else:
lineno = f.func_code.co_firstlineno
pathname = f.func_code.co_filename
record = logging.LogRecord(
name=name,
level=logging.DEBUG,
pathname=pathname,
lineno=lineno,
msg=msg,
args=msg_args,
2019-06-20 05:32:02 -04:00
exc_info=None,
)
logger.handle(record)
2014-08-12 10:10:52 -04:00
def log_function(f):
""" Function decorator that logs every call to that function.
"""
func_name = f.__name__
@wraps(f)
2014-08-12 10:10:52 -04:00
def wrapped(*args, **kwargs):
name = f.__module__
logger = logging.getLogger(name)
level = logging.DEBUG
if logger.isEnabledFor(level):
bound_args = getcallargs(f, *args, **kwargs)
def format(value):
r = str(value)
if len(r) > 50:
r = r[:50] + "..."
return r
2019-06-20 05:32:02 -04:00
func_args = ["%s=%s" % (k, format(v)) for k, v in bound_args.items()]
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
msg_args = {"func_name": func_name, "args": ", ".join(func_args)}
2014-08-12 10:10:52 -04:00
2019-06-20 05:32:02 -04:00
_log_debug_as_f(f, "Invoked '%(func_name)s' with args: %(args)s", msg_args)
2014-08-12 10:10:52 -04:00
return f(*args, **kwargs)
wrapped.__name__ = func_name
return wrapped
def time_function(f):
func_name = f.__name__
@wraps(f)
def wrapped(*args, **kwargs):
global _TIME_FUNC_ID
id = _TIME_FUNC_ID
_TIME_FUNC_ID += 1
start = time.clock()
try:
2019-06-20 05:32:02 -04:00
_log_debug_as_f(f, "[FUNC START] {%s-%d}", (func_name, id))
r = f(*args, **kwargs)
finally:
end = time.clock()
_log_debug_as_f(
2019-06-20 05:32:02 -04:00
f, "[FUNC END] {%s-%d} %.3f sec", (func_name, id, end - start)
)
return r
return wrapped
def trace_function(f):
func_name = f.__name__
linenum = f.func_code.co_firstlineno
pathname = f.func_code.co_filename
2014-10-29 21:21:33 -04:00
@wraps(f)
def wrapped(*args, **kwargs):
name = f.__module__
logger = logging.getLogger(name)
level = logging.DEBUG
s = inspect.currentframe().f_back
to_print = [
2019-06-20 05:32:02 -04:00
"\t%s:%s %s. Args: args=%s, kwargs=%s"
% (pathname, linenum, func_name, args, kwargs)
]
while s:
if True or s.f_globals["__name__"].startswith("synapse"):
filename, lineno, function, _, _ = inspect.getframeinfo(s)
args_string = inspect.formatargvalues(*inspect.getargvalues(s))
to_print.append(
2019-06-20 05:32:02 -04:00
"\t%s:%d %s. Args: %s" % (filename, lineno, function, args_string)
)
s = s.f_back
msg = "\nTraceback for %s:\n" % (func_name,) + "\n".join(to_print)
record = logging.LogRecord(
name=name,
level=level,
pathname=pathname,
lineno=lineno,
msg=msg,
args=None,
2019-06-20 05:32:02 -04:00
exc_info=None,
)
logger.handle(record)
return f(*args, **kwargs)
wrapped.__name__ = func_name
2014-08-12 10:10:52 -04:00
return wrapped
2016-02-04 05:22:44 -05:00
def get_previous_frames():
s = inspect.currentframe().f_back.f_back
to_return = []
while s:
if s.f_globals["__name__"].startswith("synapse"):
filename, lineno, function, _, _ = inspect.getframeinfo(s)
args_string = inspect.formatargvalues(*inspect.getargvalues(s))
2019-06-20 05:32:02 -04:00
to_return.append(
"{{ %s:%d %s - Args: %s }}" % (filename, lineno, function, args_string)
)
2016-02-04 05:22:44 -05:00
s = s.f_back
2019-06-20 05:32:02 -04:00
return ", ".join(to_return)
2016-02-04 05:22:44 -05:00
def get_previous_frame(ignore=[]):
s = inspect.currentframe().f_back.f_back
while s:
if s.f_globals["__name__"].startswith("synapse"):
if not any(s.f_globals["__name__"].startswith(ig) for ig in ignore):
filename, lineno, function, _, _ = inspect.getframeinfo(s)
args_string = inspect.formatargvalues(*inspect.getargvalues(s))
return "{{ %s:%d %s - Args: %s }}" % (
2019-06-20 05:32:02 -04:00
filename,
lineno,
function,
args_string,
2016-02-04 05:22:44 -05:00
)
s = s.f_back
return None