Django多进程滚动日志的问题

Posted 2021-12-24 luozx207

使用RotatingFileHandler控制日志文件的大小

# settings.py
LOGGING = 
    ...
    'handlers': 
        ...
        'file': 
            'level': 'INFO',
            'class': 'logging.RotatingFileHandler',
            'filename': os.path.join(LOGS_DIR, 'app.log'),
            'formatter': 'verbose',
            'maxBytes': 1024,
            'backupCount': 5
        ,
        ...
    
    ...

设置RotatingFileHandler的maxBytes与backupCount，这两个参数默认是0。

当两个参数都不为0时，会执行rallover过程：log文件大小接近maxBytes时，新建一个文件作为log的输出，旧的文件会被加上类似‘.1‘、‘.2‘的后缀。

举个例子，如果backupCount=5，log file定义的名字为app.log，你会得到app.log, app.log.1, app.log.2 一直到 app.log.5。

然而被写入日志的永远是app.log，写满了之后重命名为app.log.1，如果app.log.1存在，app.log.1会先被重名名为app.log.2，依此类推。

另外，如果app.log.5存在，它会被删除。

windows环境遇到的问题

PermissionError: [WinError 32] 另一个程序正在使用此文件，进程无法访问。

首先，Django默认启用两个进程，一个进程用来检测文件变化，另一个进程是正经的服务器进程。settting.py这个文件被加载了两次，也就是日志文件打开了两次，如果是服务器进程先启动，则看不出毛病来；如果是监控进程首先打开了从settings.py加载了日志，那么正经服务器进程就无法再次加载日志了。

如果你的Django项目是单进程的，那么在启动Django项目的时候使用--noreload就可以解决

python manage.py runserver 0.0.0.0:80 --noreload

noreload表示不启动Django的监控进程，也就是说项目代码的改变不再会影响已经载入内存中的代码，这样，Django就只会起一个进程。

但是，如果你的项目是多进程的，或者在某些单独的模块，比如celery中为了使用Django的ORM而使用了django.setup()

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "myproject.settings")
import django
django.setup()

那么就需要用另一个日志模块解决

pip install concurrent-log-handler

在LOGGING中，用concurrent_log_handler.ConcurrentRotatingFileHandler代替logging.RotatingFileHandler

# settings.py
LOGGING = 
    ...
    'handlers': 
        ...
        'file': 
            'level': 'INFO',
            'class': 'concurrent_log_handler.ConcurrentRotatingFileHandler',
            'filename': os.path.join(LOGS_DIR, 'app.log'),
            'formatter': 'verbose',
            'maxBytes': 1024,
            'backupCount': 5
        ,
        ...
    
    ...

测试一下，问题解决

另外，如果是linux系统下的多进程Django，可以用ConcurrentLogHandler模块

pip install ConcurrentLogHandler

# settings.py
LOGGING = 
    ...
    'handlers': 
        ...
        'file': 
            'level': 'INFO',
            'class': 'cloghandler.ConcurrentRotatingFileHandler',
            'filename': os.path.join(LOGS_DIR, 'app.log'),
            'formatter': 'verbose',
            'maxBytes': 1024,
            'backupCount': 5
        ,
        ...
    
    ...