|
日志是我們項目開發(fā)中必不可少的，通過日志可以快速排查項目中的問題，日志對于項目的重要性不言而喻。
在python涉及的web開發(fā)中，我們常用就是django框架了，盡管django框架強大，日志模塊部分，我們可以使用logging模塊進(jìn)行相關(guān)配置，完善web項目的日志部分。下面就對logging模塊的相關(guān)使用做個總結(jié)分享，也為以后的開發(fā)留存記錄，方便隨時翻閱。
內(nèi)容主要分setting.py部分配置，視圖或中間件部分配置，通過在setting.py配置實現(xiàn)全局配置，在視圖或中間件部分配置實現(xiàn)具體那些部分記錄何種日志，話不多說，看以下總結(jié)。
1.setting.py的日志配置
首先先來看看在django項目中setting.py的配置。
# 日志文件存放路徑，當(dāng)然也可以指明一般的存儲路徑，比如BASE_DIR="/var/log/項目/服務(wù)名/logs/"
BASE_LOG_DIR = os.path.join(BASE_DIR, "log")
# Logging配置，通過此配置，可以實現(xiàn)以下功能：
# 1.哪些模塊中記錄日志，2.配置日志的級別，3.具體日志文件名，4.日志格式，5.切分日志(時間或大小)，6.日志編碼方式
LOGGING = {
'version': 1, # 保留字
'disable_existing_loggers': False, # 是否禁用Django框架開發(fā)的時候已經(jīng)存在的Logger實例，True的話，即禁用django本身存在的日志，否則，默認(rèn)False，不對本身存在的日志禁用處理
# part 1
'formatters': { # 格式化器，用以定義日志應(yīng)該以何種格式記錄
'standard': { # 標(biāo)準(zhǔn)的格式
'format': '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'
'[%(levelname)s][%(message)s]'
},
'simple': { # 簡單的格式
'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
},
'collect': { # 自定義格式，這個名字可以隨意起
'format': '%(message)s'
}
},
# part 2
'filters': { # 過濾器
'require_debug_true': {
'()': 'django.utils.log.RequireDebugTrue',
},
},
# part 3
'handlers': { # 處理器
'console': { # 定義一個在終端輸出的處理器，基本設(shè)置
'level': 'DEBUG', # 日志級別
'filters': ['require_debug_true'], # 只有在Django debug為True時才在屏幕打印日志
'class': 'logging.StreamHandler', # 日志流
'formatter': 'simple' # 用簡單格式打印日志
},
'SF': { # 定義一個名為SF的日志處理器(名字自己定義即可)，這通常就是自己項目中用到的處理器，會記錄到日志文件
'level': 'INFO', # 日志級別
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，根據(jù)文件大小自動切
'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"), # 日志文件，路徑及日志文件名
'maxBytes': 1024 * 1024 * 50, # 日志大小 50M
'backupCount': 3, # 備份數(shù)為3 xx.log --> xx.log.1 --> xx.log.2 --> xx.log.3
'formatter': 'standard', # 用標(biāo)準(zhǔn)格式打印日志
'encoding': 'utf-8',
},
'TF': { # 定義一個名為TF的日志處理器(名字自己定義即可)，比如項目有多個需求，需要配置多個日志部分
'level': 'INFO',
'class': 'logging.handlers.TimedRotatingFileHandler', # 保存到文件，根據(jù)時間自動切，根據(jù)時間切的，通常是請求/響應(yīng)
'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"), # 日志文件
'backupCount': 3, # 備份數(shù)為3 xx.log --> xx.log.2018-08-23_00-00-00 --> xx.log.2018-08-24_00-00-00 --> ...
'when': 'D', # 每天一切， 可選值有S/秒 M/分 H/小時 D/天 W0-W6/周(0=周一) midnight/如果沒指定時間就默認(rèn)在午夜
'formatter': 'standard',
'encoding': 'utf-8',
},
'error': {
'level': 'ERROR',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，自動切
'filename': os.path.join(BASE_LOG_DIR, "xxx_err.log"), # error日志文件
'maxBytes': 1024 * 1024 * 5, # 日志大小 50M
'backupCount': 5,
'formatter': 'standard',
'encoding': 'utf-8',
},
'collect': {
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，自動切
'filename': os.path.join(BASE_LOG_DIR, "xxx_collect.log"),
'maxBytes': 1024 * 1024 * 50, # 日志大小 50M
'backupCount': 5,
'formatter': 'collect',
'encoding': "utf-8"
}
},
# part 4
'loggers': { # 日志實例
'': { # 日志實例對象默認(rèn)配置
'handlers': ['SF', 'console', 'error'], # 使用哪幾種處理器，上線之后可以把'console'移除
'level': 'DEBUG', # 實例的級別
'propagate': True, # 是否向上傳遞日志流
},
'collect': { # 名為 'collect'的logger對象實例還單獨處理
'handlers': ['console', 'collect'],
'level': 'INFO',
},
'application_xx.module_xx': { # 為某個具體module配置日志處理
'handlers': ['console', 'collect', 'SF'],
'level': 'INFO',
},
},
}
通過上面的logging配置，可以實現(xiàn)django項目的日志記錄配置，主要：哪些模塊記錄何種日志，存儲位置，備份情況。
2.具體使用位置-views.py | 某些自己寫的middleware
views.py
import logging
# 生成一個以當(dāng)前模塊名為名字的Logger實例,info以上的級別存到xx_info.log
logger = logging.getLogger(__name__)
# 生成一個名為collect的Logger實例,info以上的級別存到xx_collect.log
collect_logger = logging.getLogger('collect')
def permission_update(request):
all_user = UserInfo.objects.all()
all_role = Role.objects.all()
all_menu = Menu.objects.all()
user_id = request.GET.get('user_id', None)
user_obj = UserInfo.objects.filter(pk=user_id).first()
role_id = request.GET.get('role_id', None)
role_obj = Role.objects.filter(id=role_id).first()
if request.method == 'POST':
post_type = request.POST.get('post_type', None)
logger.debug('獲取到了post_type:{}'.format(post_type)) # debug日志
if user_id and post_type == 'role':
role_id_list = request.POST.getlist('role_id')
user_obj.roles.set(role_id_list)
logger.info('用戶：{}跟新了{(lán)}的角色'.format(request.user.username, user_obj.username)) # 默認(rèn)實例的info日志
if role_id and post_type == 'permission':
permission_id_list = request.POST.getlist('permission_id')
role_obj.permissions.set(permission_id_list)
collect_logger.info('{}跟新了{(lán)}的權(quán)限'.format(request.user.username, role_obj.title)) # collect實例的info日志
return render(
request,
'rbac/permission_update.html',
{
...: ...
}
)
自己寫的middleware
首先我們在setting.py中設(shè)置自己的中間件：
設(shè)置后，在server接收處理請求時，按照中間件的訪問處理機制順序處理，在合適的位置，放置logger:
logger = logging.getLogger(__name__)
class xxxDebugLogMiddleware(MiddlewareMixin): # 自定義中間件
"""
Middleware to debug log.
"""
def init(self, get_response):
self.get_response = get_response
# One-time configuration and initialization.
def __call__(self, request):
hasattr(request, 'body')
response = self.get_response(request)
debuglog(request, response) # 日志記錄
return response
debuglog中自定義記錄哪些變量，具體在debuglog函數(shù)中的處理：
通過設(shè)置，可以實現(xiàn)記錄我們需要的的日志信息，日后開發(fā)如有需要，復(fù)制后定制編寫即可完成django項目的日志配置。
參考：
https://www.cnblogs.com/Zzbj/p/10049728.html
|
