Django日誌配置

木子七發表於2023-02-14
Django

Django使用Python內建的logging模組列印日誌,配置由四個部分組成

  • 記錄器:Logger
  • 處理程式:Handler
  • 過濾器:Filter
  • 格式化:formatter
 

記錄器-Logger

Logger為日誌系統的入口,每個logger命名都是bucket,可以向bucket寫入需要處理的訊息
Python定義以及幾種日誌級別:
  • DEBUG:用於除錯目的的日誌
  • INFO:普通的系統訊息
  • WARNING:表示出現一個較小的問題
  • ERROR:表示出現一個較大的問題
  • CRITICAL:表示出現一個致命的問題
處理邏輯:
當一條訊息傳遞給Logger的時候,訊息的日誌級別將與logger的日誌級別進行比較
如果訊息的日誌級別大於等於logger的日誌訊息,該訊息績效往下處理,如果小於,該訊息被忽略
Logger一旦決定訊息需要處理,它將傳遞該訊息給一個Handler
 
logger日誌級別
級別
值
描述
CRITICAL
 
50
關鍵錯誤/訊息
 
ERROR
40
錯誤
WARNING
30
警告訊息
INFO
20
通知訊息
DEBUG
 
10
除錯
NOTSET
0
無級別

logger配置

logger對應的值是字典,其中每一個健都是logger的名字,每一個值又是個字典
  • level(可選) - logger的級別
  • propagate(可選) - logger的傳播設定
  • filters(可選) - logger的fillter的識別符號列表
  • handlers(可選) - logger的handler的識別符號列表
配置示例
#settings
LOGGING = { 
    #記錄器
    'loggers': {
        'reboot': {
            'handlers': ['reboot'],
            'level': 'INFO',
        }
    }
}

''' 
level配置的日誌級別為INFO
那麼在程式中 如果使用logger.DEBUG,DEBUG級別小於INFO,則不會處理
如果是大於等於INFO，則會交給handlers處理日誌
'''
 

處理程式-Handler

handler決定如何處理logger中的每條訊息,它表示一個特定的日誌行為,例如將訊息寫到螢幕、檔案中或者網路socket
與logger一樣,handler也有一個日誌解蔽,如果訊息的日誌級別小於handler的級別,handler將忽略這條訊息
logger可以有多個handler,而每個handler可以有不同的日誌級別
#配置示例 settings
LOGGING = {
    # 記錄器    
    'loggers': {
        'reboot': {
            'handlers': ['reboot'], # 處理器對應下方handlers中的reboot
            'level': 'INFO',
        }
    },
    # 處理器
    'handlers': {
        'reboot': {
            'level': 'INFO',
            'class': 'logging.StreamHandler', # 以流的形式寫入
            'formatter': 'reboot', # 指定交給哪個格式化處理
        }
    }
}
'''
loggers中的reboot,定義級別為INFO,如果滿足INFO級別,交給handlers處理,loggers中的handler配置的是reboot
在下發的handlers配置reboot的具體處理方式
'''
class
logging.StreamHandler	                         類似與sys.stdout或者sys.stderr的任何檔案物件(file object)輸出資訊
logging.FileHandler	                             將日誌訊息寫入檔案filename。
logging.handlers.DatagramHandler(host，port)     傳送日誌訊息給位於制定host和port上的UDP伺服器。使用UDP協議，將日誌資訊傳送到網路
logging.handlers.HTTPHandler(host, url) 	     使用HTTP的GET或POST方法將日誌訊息上傳到一臺HTTP 伺服器。
logging.handlers.RotatingFileHandler(filename)   將日誌訊息寫入檔案filename。如果檔案的大小超出maxBytes制定的值，那麼它將被備份為filenamel。
logging.handlers.SocketHandler	                 使用TCP協議，將日誌資訊傳送到網路。
logging.handlers.SysLogHandler	                 日誌輸出到syslog
logging.handlers.NTEventLogHandler	             遠端輸出日誌到Windows NT/2000/XP的事件日誌
logging.handlers.SMTPHandler	                 遠端輸出日誌到郵件地址
logging.handlers.MemoryHandler	                 日誌輸出到記憶體中的指定buffer
 

過濾器-Filters

filter用於對從logger傳遞給handler的日誌記錄進行額外的控制
預設情況滿足日誌級別的任何訊息都被處理,可以使用filter,對日誌處理新增額外的條件,例如只允許處理特定源的ERROR訊息
filters還可以用於修改將要處理的日誌記錄的優先順序,例如日誌滿足特定條件,可以透過filter將日誌記錄從ERROR降到WARNING
filters可以在logger上或者handler上，多個filter可以串聯起來實現多層的filter行為
 

格式化-Formatters

日誌記錄需要轉換成文字或者其他格式 ,formatter表示文字的格式
formatter通常由包含日誌記錄屬性的Python格式字串組成
訊息日誌格式
Django日誌配置
#配置示例

LOGGING = {
    'version': 1,  # 版本
    'disable_existing_loggers': False,# 預設為True，True：設定已存在的logger失效。False：讓已存在的logger不失效，保證日誌資訊完整。一般情況下設定為False
    # 記錄器
    'loggers': {
        'reboot': {
            'handlers': ['reboot'],
            'level': 'INFO',
        }
    },
    # 處理器
    'handlers': {
        'reboot': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'reboot',  # 指定
        }
    },
    # 格式化
    'formatters': {
        'reboot': {
            'format': '%(asctime)s - %(pathname)s:%(lineno)d[%(levelname)s] - %(message)s'
        }
    }
}

日誌使用

import logging
# 生成logger物件 引數指定交給哪個loggers處理
# 不傳參可走Django內建的配置
logger = logging.getLogger('reboot') 

logger.info('xxx')
Django內建logger
  • django-獲取所有日誌
  • django.request-處理與請求相關的日誌,5xx響應報出ERROR日誌,4xx報出warning日誌
  • django.db.backends-處理與資料庫之間互動的日誌
  • django.security.* -處理與安全相關的日誌
  • django.db.backends.schemea-處理資料庫遷移時的日誌
 

可用完整配置

# 日誌配置
cur_path = os.path.dirname(os.path.realpath(__file__))  # log_path是存放日誌的路徑
log_path = os.path.join(os.path.dirname(cur_path), 'Log')

LOGGING = {
    'version': 1,
    'disable_existing_loggers': True,
    'formatters': {
        # 日誌格式
        'standard': {
            'format': '[%(asctime)s] [%(filename)s:%(lineno)d] [%(module)s:%(funcName)s] '
                      '[%(levelname)s]- %(message)s'},
        'simple': {  # 簡單格式
            'format': '%(levelname)s %(message)s'
        },
    },
    # 過濾
    'filters': {
    },
    # 定義具體處理日誌的方式
    'handlers': {
        # 預設記錄所有日誌
        'default': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(log_path, 'django.log'.format(time.strftime('%Y-%m'))),
            'maxBytes': 1024 * 1024 * 5,  # 檔案大小
            'backupCount': 5,  # 備份數
            'formatter': 'standard',  # 輸出格式
            'encoding': 'utf-8',  # 設定預設編碼，否則列印出來漢字亂碼
        },
        # 輸出錯誤日誌
        'error': {
            'level': 'ERROR',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(log_path, 'error-{}.log'.format(time.strftime('%Y-%m'))),
            'maxBytes': 1024 * 1024 * 5,  # 檔案大小
            'backupCount': 5,  # 備份數
            'formatter': 'standard',  # 輸出格式
            'encoding': 'utf-8',  # 設定預設編碼
        },
        # 控制檯輸出
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'standard'
        },
        # 輸出info日誌
        'info': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(log_path, 'info-{}.log'.format(time.strftime('%Y-%m'))),
            'maxBytes': 1024 * 1024 * 5,
            'backupCount': 5,
            'formatter': 'standard',
            'encoding': 'utf-8',  # 設定預設編碼
        },
    },
    # 配置用哪幾種 handlers 來處理日誌
    'loggers': {
        # 型別 為 django 處理所有型別的日誌， 預設呼叫
        'django': {
            'handlers': ['default', 'console'],
            'level': 'INFO',
            'propagate': False
        },
        # log 呼叫時需要當作引數傳入
        'log': {
            'handlers': ['error', 'info', 'console', 'default'],
            'level': 'INFO',
            'propagate': True
        },
    }
}
 

相關文章