Files
edx-platform/openedx/core/djangoapps/heartbeat/runchecks.py

42 lines
1.4 KiB
Python

"""
Code for system checks.
"""
from importlib import import_module
from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
def runchecks(include_extended=False):
"""
Iterates through a tuple of systems checks, then returns a dictionary containing the check name as the key, and a
dict containing a status boolean and string describing the status, including any failure or error messages
"""
response_dict = {}
list_of_checks = list(settings.HEARTBEAT_CHECKS)
if include_extended:
list_of_checks += settings.HEARTBEAT_EXTENDED_CHECKS
for path in list_of_checks:
module, _, attr = path.rpartition('.')
try:
if module[0] == '.': # Relative path, assume relative to this app
mod = import_module(module, __package__)
else:
mod = import_module(module)
func = getattr(mod, attr)
check_name, is_ok, message = func()
response_dict[check_name] = {
'status': is_ok,
'message': message
}
except ImportError as e:
raise ImproperlyConfigured(f'Error importing module {module}: "{e}"') # lint-amnesty, pylint: disable=raise-missing-from
except AttributeError:
raise ImproperlyConfigured(f'Module "{module}" does not define a "{attr}" callable') # lint-amnesty, pylint: disable=raise-missing-from
return response_dict