logconf.py

import os

from django.core.cache import cache

#
# To see all log messages: export DJANGO_LOG_LEVEL=DEBUG
#

VALID_LEVELS = ['DEBUG', 'INFO', 'WARNING', 'ERROR']

LOG_LEVEL = os.getenv('ENGINE_LOG_LEVEL', '').upper() or 'INFO'

assert LOG_LEVEL in VALID_LEVELS, f"level {LOG_LEVEL} not in {VALID_LEVELS}"

DJANGO_LOG_LEVEL = os.getenv('DJANGO_LOG_LEVEL', '').upper() or 'WARNING'

assert DJANGO_LOG_LEVEL in VALID_LEVELS


class RateLimitFilter(object):
    """
    Limits the number of error emails when errors get triggered.
    """
    # Time out in seconds.
    TIMEOUT = 300
    CACHE_KEY = "error-limiter"

    def filter(self, record):
        exists = cache.get(self.CACHE_KEY)
        if not exists:
            cache.set(self.CACHE_KEY, 1, self.TIMEOUT)

        return not exists


# Override the Django defaults
#
# https://stackoverflow.com/questions/20282521/django-request-logger-not-propagated-to-root
#
# LOGGING_CONFIG = None
#
LOGGING = {

    'version': 1,

    'disable_existing_loggers': False,

    'formatters': {

        'verbose': {
            'format': '%(levelname)s\t%(asctime)s\t%(module)s.%(funcName)s\t%(lineno)s\t%(message)s\t'
        },

        'simple': {
            'format': '%(levelname)s\t%(module)s\t%(message)s'
        },

    },

    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse'
        },

        'rate_limit': {
            '()': 'biostar.logconf.RateLimitFilter',
        },
    },

    'handlers': {

        'console': {
            'class': 'logging.StreamHandler',
            'formatter': 'verbose'
        },

        'mail_admins': {
            'level': 'ERROR',
            'filters': ['require_debug_false', 'rate_limit'],
            'class': 'django.utils.log.AdminEmailHandler',
            'include_html': True,

        },

        'errors': {
            'level': 'ERROR',
            'filters': ['rate_limit'],
            'class': 'logging.FileHandler',
            'filename': 'error.log',
        }

    },

    'loggers': {

        'django': {
            'handlers': ['console', 'mail_admins'],
            'level': DJANGO_LOG_LEVEL,
            'propagate': True,
        },

        'engine': {
            'handlers': ['console', 'mail_admins'],
            'level': LOG_LEVEL,
            'propagate': True,
        },

    },
}