searx.search.checker.background Namespace Reference

Classes
class	CheckerErr
class	CheckerOk
class	CheckerOther
class	EngineErr
class	EngineOk

Functions
Tuple[int, int]	_get_interval (Any every, str error_msg)
CheckerResult	get_result ()
	_set_result (CheckerResult result)
	_timestamp ()
	run ()
	_signal_handler (int _signum, Any _frame)
	initialize ()

Variables
str	VALKEY_RESULT_KEY = 'SearXNG_checker_result'
str	VALKEY_LOCK_KEY = 'SearXNG_checker_lock'
	CheckerResult = Union['CheckerOk', 'CheckerErr', 'CheckerOther']
	EngineResult = Union['EngineOk', 'EngineErr']

Function Documentation

_get_interval()

Tuple[int, int] searx.search.checker.background._get_interval ( Any every, str error_msg )

protected

Definition at line 65 of file background.py.

def _get_interval(every: Any, error_msg: str) -> Tuple[int, int]:
    if isinstance(every, int):
        return (every, every)
 
    if (
        not isinstance(every, (tuple, list))
        or len(every) != 2  # type: ignore
        or not isinstance(every[0], int)
        or not isinstance(every[1], int)
    ):
        raise SearxSettingsException(error_msg, None)
    return (every[0], every[1])
 
 

Referenced by initialize().

Here is the caller graph for this function:

_set_result()

searx.search.checker.background._set_result ( CheckerResult result )

protected

Definition at line 91 of file background.py.

def _set_result(result: CheckerResult):
    client = get_valkey_client()
    if client is None:
        # without Valkey, the function does nothing
        return
    client.set(VALKEY_RESULT_KEY, json.dumps(result))
 
 

Referenced by run().

Here is the caller graph for this function:

_signal_handler()

searx.search.checker.background._signal_handler ( int _signum, Any _frame )

protected

Definition at line 129 of file background.py.

def _signal_handler(_signum: int, _frame: Any):
    t = threading.Thread(target=run)
    t.daemon = True
    t.start()
 
 

_timestamp()

searx.search.checker.background._timestamp ( )

protected

Definition at line 99 of file background.py.

def _timestamp():
    return int(time.time() / 3600) * 3600
 
 

Referenced by run().

Here is the caller graph for this function:

get_result()

CheckerResult searx.search.checker.background.get_result

(

)

Definition at line 79 of file background.py.

def get_result() -> CheckerResult:
    client = get_valkey_client()
    if client is None:
        # without Valkey, the checker is disabled
        return {'status': 'disabled'}
    serialized_result: Optional[bytes] = client.get(VALKEY_RESULT_KEY)
    if serialized_result is None:
        # the Valkey key does not exist
        return {'status': 'unknown'}
    return json.loads(serialized_result)
 
 

initialize()

searx.search.checker.background.initialize

(

)

Definition at line 135 of file background.py.

def initialize():
    if hasattr(signal, 'SIGUSR1'):
        # Windows doesn't support SIGUSR1
        logger.info('Send SIGUSR1 signal to pid %i to start the checker', os.getpid())
        signal.signal(signal.SIGUSR1, _signal_handler)
 
    # special case when debug is activate
    if sxng_debug and settings['checker']['off_when_debug']:
        logger.info('debug mode: checker is disabled')
        return
 
    # check value of checker.scheduling.every now
    scheduling = settings['checker']['scheduling']
    if scheduling is None or not scheduling:
        logger.info('Checker scheduler is disabled')
        return
 
    # make sure there is a Valkey connection
    if get_valkey_client() is None:
        logger.error('The checker requires Valkey')
        return
 
    # start the background scheduler
    every_range = _get_interval(scheduling.get('every', (300, 1800)), 'checker.scheduling.every is not a int or list')
    start_after_range = _get_interval(
        scheduling.get('start_after', (300, 1800)), 'checker.scheduling.start_after is not a int or list'
    )
    t = threading.Thread(
        target=scheduler_function,
        args=(start_after_range[0], start_after_range[1], every_range[0], every_range[1], run),
        name='checker_scheduler',
    )
    t.daemon = True
    t.start()

References _get_interval().

Here is the call graph for this function:

run()

searx.search.checker.background.run

(

)

Definition at line 103 of file background.py.

def run():
    try:
        # use a Valkey lock to make sure there is no checker running at the same time
        # (this should not happen, this is a safety measure)
        with get_valkey_client().lock(VALKEY_LOCK_KEY, blocking_timeout=60, timeout=3600):
            logger.info('Starting checker')
            result: CheckerOk = {'status': 'ok', 'engines': {}, 'timestamp': _timestamp()}
            for name, processor in PROCESSORS.items():
                logger.debug('Checking %s engine', name)
                checker = Checker(processor)
                checker.run()
                if checker.test_results.successful:
                    result['engines'][name] = {'success': True}
                else:
                    result['engines'][name] = {'success': False, 'errors': checker.test_results.errors}
 
            _set_result(result)
            logger.info('Check done')
    except valkey.exceptions.LockError:
        _set_result({'status': 'error', 'timestamp': _timestamp()})
        logger.exception('Error while running the checker')
    except Exception:  # pylint: disable=broad-except
        _set_result({'status': 'error', 'timestamp': _timestamp()})
        logger.exception('Error while running the checker')
 
 

References _set_result(), and _timestamp().

Here is the call graph for this function:

Variable Documentation

CheckerResult

searx.search.checker.background.CheckerResult = Union['CheckerOk', 'CheckerErr', 'CheckerOther']

Definition at line 25 of file background.py.

EngineResult

searx.search.checker.background.EngineResult = Union['EngineOk', 'EngineErr']

Definition at line 49 of file background.py.

VALKEY_LOCK_KEY

str searx.search.checker.background.VALKEY_LOCK_KEY = 'SearXNG_checker_lock'

Definition at line 22 of file background.py.

VALKEY_RESULT_KEY

str searx.search.checker.background.VALKEY_RESULT_KEY = 'SearXNG_checker_result'

Definition at line 21 of file background.py.