searx.metrics.error_recorder Namespace Reference

Classes
class	ErrorContext

Functions
None	add_error_context (str engine_name, ErrorContext error_context)
	get_trace (traces)
str|None	get_hostname (HTTPError exc)
tuple[str|None, str|None, str|None]	get_request_exception_messages (HTTPError exc)
tuple[str,...]	get_messages (exc, filename)
str	get_exception_classname (BaseException exc)
ErrorContext	get_error_context (framerecords, exception_classname, log_message, LogParametersType log_parameters, bool secondary)
None	count_exception (str engine_name, BaseException exc, bool secondary=False)
None	count_error (str engine_name, str log_message, LogParametersType|None log_parameters=None, bool secondary=False)

Variables
dict	errors_per_engines = {}
	LogParametersType = tuple[str, ...]

Function Documentation

add_error_context()

None searx.metrics.error_recorder.add_error_context	(	str	engine_name,
		ErrorContext	error_context )

Definition at line 87 of file error_recorder.py.

def add_error_context(engine_name: str, error_context: ErrorContext) -> None:
    errors_for_engine = errors_per_engines.setdefault(engine_name, {})
    errors_for_engine[error_context] = errors_for_engine.get(error_context, 0) + 1
    engines[engine_name].logger.warning('%s', str(error_context))
 
 

Referenced by count_error(), and count_exception().

Here is the caller graph for this function:

count_error()

None searx.metrics.error_recorder.count_error	(	str	engine_name,
		str	log_message,
		LogParametersType | None	log_parameters = None,
		bool	secondary = False )

Definition at line 187 of file error_recorder.py.

) -> None:
    if not settings['general']['enable_metrics']:
        return
    framerecords = list(reversed(inspect.stack()[1:]))
    try:
        error_context = get_error_context(framerecords, None, log_message, log_parameters or (), secondary)
        add_error_context(engine_name, error_context)
    finally:
        del framerecords

References add_error_context(), and get_error_context().

Here is the call graph for this function:

count_exception()

None searx.metrics.error_recorder.count_exception	(	str	engine_name,
		BaseException	exc,
		bool	secondary = False )

Definition at line 174 of file error_recorder.py.

def count_exception(engine_name: str, exc: BaseException, secondary: bool = False) -> None:
    if not settings['general']['enable_metrics']:
        return
    framerecords = inspect.trace()
    try:
        exception_classname = get_exception_classname(exc)
        log_parameters = get_messages(exc, framerecords[-1][1])
        error_context = get_error_context(framerecords, exception_classname, None, log_parameters, secondary)
        add_error_context(engine_name, error_context)
    finally:
        del framerecords
 
 

References add_error_context(), get_error_context(), get_exception_classname(), and get_messages().

Here is the call graph for this function:

get_error_context()

ErrorContext searx.metrics.error_recorder.get_error_context	(		framerecords,
			exception_classname,
			log_message,
		LogParametersType	log_parameters,
		bool	secondary )

Definition at line 160 of file error_recorder.py.

) -> ErrorContext:
    searx_frame = get_trace(framerecords)
    filename = searx_frame.filename
    if filename.startswith(searx_parent_dir):
        filename = filename[len(searx_parent_dir) + 1 :]
    function = searx_frame.function
    line_no = searx_frame.lineno
    code = searx_frame.code_context[0].strip()
    del framerecords
    return ErrorContext(filename, function, line_no, code, exception_classname, log_message, log_parameters, secondary)
 
 

References get_trace().

Referenced by count_error(), and count_exception().

Here is the call graph for this function:

Here is the caller graph for this function:

get_exception_classname()

str searx.metrics.error_recorder.get_exception_classname

(

BaseException

exc

)

Definition at line 151 of file error_recorder.py.

def get_exception_classname(exc: BaseException) -> str:
    exc_class = exc.__class__
    exc_name = exc_class.__qualname__
    exc_module = exc_class.__module__
    if exc_module is None or exc_module == str.__class__.__module__:
        return exc_name
    return exc_module + '.' + exc_name
 
 

Referenced by count_exception().

Here is the caller graph for this function:

get_hostname()

str | None searx.metrics.error_recorder.get_hostname

(

HTTPError

exc

)

Definition at line 103 of file error_recorder.py.

def get_hostname(exc: HTTPError) -> str | None:
    url = exc.request.url
    if url is None and exc.response is not None:
        url = exc.response.url
    return urlparse(url).netloc
 
 

get_messages()

tuple[str, ...] searx.metrics.error_recorder.get_messages	(		exc,
			filename )

Definition at line 131 of file error_recorder.py.

def get_messages(exc, filename) -> tuple[str, ...]:  # pylint: disable=too-many-return-statements
    if isinstance(exc, JSONDecodeError):
        return (exc.msg,)
    if isinstance(exc, TypeError):
        return (str(exc),)
    if isinstance(exc, ValueError) and 'lxml' in filename:
        return (str(exc),)
    if isinstance(exc, HTTPError):
        return get_request_exception_messages(exc)
    if isinstance(exc, SearxXPathSyntaxException):
        return (exc.xpath_str, exc.message)
    if isinstance(exc, SearxEngineXPathException):
        return (exc.xpath_str, exc.message)
    if isinstance(exc, SearxEngineAPIException):
        return (str(exc.args[0]),)
    if isinstance(exc, SearxEngineAccessDeniedException):
        return (exc.message,)
    return ()
 
 

References get_request_exception_messages().

Referenced by count_exception().

Here is the call graph for this function:

Here is the caller graph for this function:

get_request_exception_messages()

tuple[str | None, str | None, str | None] searx.metrics.error_recorder.get_request_exception_messages

(

HTTPError

exc

)

Definition at line 110 of file error_recorder.py.

) -> tuple[str | None, str | None, str | None]:
    url = None
    status_code = None
    reason = None
    hostname = None
    if hasattr(exc, '_request') and exc._request is not None:  # pylint: disable=protected-access
        # exc.request is property that raise an RuntimeException
        # if exc._request is not defined.
        url = exc.request.url
    if url is None and hasattr(exc, 'response') and exc.response is not None:
        url = exc.response.url
    if url is not None:
        hostname = url.host
    if isinstance(exc, HTTPStatusError):
        status_code = str(exc.response.status_code)
        reason = exc.response.reason_phrase
    return (status_code, reason, hostname)
 
 

Referenced by get_messages().

Here is the caller graph for this function:

get_trace()

searx.metrics.error_recorder.get_trace

(

traces

)

Definition at line 93 of file error_recorder.py.

def get_trace(traces):
    for trace in reversed(traces):
        split_filename: list[str] = trace.filename.split('/')
        if '/'.join(split_filename[-3:-1]) == 'searx/engines':
            return trace
        if '/'.join(split_filename[-4:-1]) == 'searx/search/processors':
            return trace
    return traces[-1]
 
 

Referenced by get_error_context().

Here is the caller graph for this function:

Variable Documentation

errors_per_engines

dict searx.metrics.error_recorder.errors_per_engines = {}

Definition at line 20 of file error_recorder.py.

LogParametersType

searx.metrics.error_recorder.LogParametersType = tuple[str, ...]

Definition at line 22 of file error_recorder.py.