Django 设置默认日志记录

Question

我似乎不知道如何为我的 Django 安装设置“默认”记录器。我想在 settings.py 中使用 Django 1.3 的新 LOGGING 设置。

我看过 Django Logging Doc 的示例，但它看起来对我来说，他们只设置处理程序来为特定的记录器进行日志记录。在他们的示例中，他们为名为“django”、“django.request”和“myproject.custom”的记录器设置了处理程序。

我想要做的就是设置一个默认的logging.handlers.RotatingFileHandler，它将默认处理所有记录器。即，如果我在项目中的某个位置创建一个新模块，并且用类似以下内容表示：my_app_name.my_new_module，我应该能够执行此操作并将所有日志记录转到旋转文件日志。

# In file './my_app_name/my_new_module.py'
import logging
logger = logging.getLogger('my_app_name.my_new_module')
logger.debug('Hello logs!') # <-- This should get logged to my RotatingFileHandler that I setup in `settings.py`!

Answer 1

弄清楚了...

您通过使用空字符串引用“catch all”记录器来设置它：''。

例如，在以下设置中，我将所有日志事件保存到 logs/mylog.log 中，但 django.request 日志事件将被保存到logs/django_request.log。由于我的 django.request 记录器的 'propagate' 设置为 False，因此日志事件永远不会到达“catch all”记录器。

LOGGING = {
    'version': 1,
    'disable_existing_loggers': True,
    'formatters': {
        'standard': {
            'format': '%(asctime)s [%(levelname)s] %(name)s: %(message)s'
        },
    },
    'handlers': {
        'default': {
            'level':'DEBUG',
            'class':'logging.handlers.RotatingFileHandler',
            'filename': 'logs/mylog.log',
            'maxBytes': 1024*1024*5, # 5 MB
            'backupCount': 5,
            'formatter':'standard',
        },  
        'request_handler': {
            'level':'DEBUG',
            'class':'logging.handlers.RotatingFileHandler',
            'filename': 'logs/django_request.log',
            'maxBytes': 1024*1024*5, # 5 MB
            'backupCount': 5,
            'formatter':'standard',
        },
    },
    'loggers': {
        '': {
            'handlers': ['default'],
            'level': 'DEBUG',
            'propagate': True
        },
        'django.request': {
            'handlers': ['request_handler'],
            'level': 'DEBUG',
            'propagate': False
        },
    }
}

Answer 2

正如您在您的答案中所说，克里斯，定义默认记录器的一种选择是使用空字符串作为其键。

但是，我认为预期的方法是在日志记录配置字典的 root 键下定义一个特殊的记录器。我在 Python 文档 中找到了这一点：

root - 这将是根记录器的配置。配置的处理将与任何记录器一样，除了 propagate 设置不适用。

以下是将您的答案中的配置更改为使用 root 键：

LOGGING = {
    'version': 1,
    'disable_existing_loggers': True,
    'formatters': {
        'standard': {
            'format': '%(asctime)s [%(levelname)s] %(name)s: %(message)s'
        },
    },
    'handlers': {
        'default': {
            'level':'DEBUG',
            'class':'logging.handlers.RotatingFileHandler',
            'filename': 'logs/mylog.log',
            'maxBytes': 1024*1024*5, # 5 MB
            'backupCount': 5,
            'formatter':'standard',
        },  
        'request_handler': {
            'level':'DEBUG',
            'class':'logging.handlers.RotatingFileHandler',
            'filename': 'logs/django_request.log',
            'maxBytes': 1024*1024*5, # 5 MB
            'backupCount': 5,
            'formatter':'standard',
        },
    },
    'root': {
        'handlers': ['default'],
        'level': 'DEBUG'
    },
    'loggers': {
        'django.request': {
            'handlers': ['request_handler'],
            'level': 'DEBUG',
            'propagate': False
        },
    }
}

公平地说，我看不出两种配置之间的行为有任何差异。看来使用空字符串键定义记录器将修改根记录器，因为 logging.getLogger('') 将返回根记录器。

我更喜欢 'root' 而不是 '' 的唯一原因是它对于修改根记录器是明确的。如果您好奇，如果您定义了两者，'root' 会覆盖 ''，因为根条目是最后处理的。

Answer 3

import logging
logger = logging.getLogger(__name__)

添加后：

logging.basicConfig(
    level = logging.DEBUG,
    format = '%(name)s %(levelname)s %(message)s',
)

我们可以将格式更改为：

format = '"%(levelname)s:%(name)s:%(message)s"  ',

或

format = '%(name)s %(asctime)s %(levelname)s %(message)s',

Answer 4

我做了一个快速示例来检查在配置字典中引用 root 键和空 '' 记录器时使用的配置。

import logging.config

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'fmt1': {
            'format': '[FMT1] %(asctime)-15s %(message)s',
        },
        'fmt2': {
            'format': '[FMT2] %(asctime)-15s %(message)s',
        }
    },
    'handlers': {
        'console1': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'fmt1',
        },
        'console2': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'fmt2',
        },
    },
    # First config for root logger: console1 -> fmt1
    'root': {
        'handlers': ['console1'],
        'level': 'DEBUG',
        'propagate': True,
    },
    'loggers': {
        # Second config for root logger: console2 -> fmt2
        '': {
            'handlers': ['console2'],
            'level': 'DEBUG',
            'propagate': True,
        },
    },
}

logging.config.dictConfig(LOGGING)

l1 = logging.getLogger()
l2 = logging.getLogger('')
root = logging.root

l1.info("l1")
l2.info("l2")
root.info("root logger")

打印结果如下：

[FMT1] 2018-12-18 17:24:47,691 l1
[FMT1] 2018-12-18 17:24:47,691 l2
[FMT1] 2018-12-18 17:24:47,691 root logger

表示root键下的配置优先级最高。如果删除该块，结果是：

[FMT2] 2018-12-18 17:25:43,757 l1
[FMT2] 2018-12-18 17:25:43,757 l2
[FMT2] 2018-12-18 17:25:43,757 root logger

在这两种情况下，我都能够调试并确定所有三个记录器（l1、l2 和 root) 引用了同一个记录器实例，即根记录器。

希望这能帮助像我一样对配置根记录器的两种不同方法感到困惑的其他人。