logging模块
可在logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为,可用参数有
| 参数 | 作用 |
|---|---|
| filename | 用指定的文件名创建FiledHandler(后边会具体讲解handler的概念),这样日志会被存储在指定的文件中。 |
| filemode | 文件打开方式,在指定了filename时使用这个参数,默认值为’a’还可指定为’w’。 |
| format | 指定handler使用的日志显示格式。 |
| datefmt | 指定日期时间格式。 |
| level | 设置rootlogger(后边会讲解具体概念)的日志级别 |
| stream | 用指定的stream创建StreamHandler。可以指定输出到 |
format参数中可能用到的格式化串:
%(name)s Logger的名字
%(levelno)s 数字形式的日志级别
%(levelname)s 文本形式的日志级别
%(pathname)s 调用日志输出函数的模块的完整路径名,可能没有
%(filename)s 调用日志输出函数的模块的文件名
%(module)s 调用日志输出函数的模块名
%(funcName)s 调用日志输出函数的函数名
%(lineno)d 调用日志输出函数的语句所在的代码行
%(created)f 当前时间,用UNIX标准的表示时间的浮 点数表示
%(relativeCreated)d 输出日志信息时的,自Logger创建以 来的毫秒数
%(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d 线程ID。可能没有
%(threadName)s 线程名。可能没有
%(process)d 进程ID。可能没有
%(message)s用户输出的消息
1. 日志级别与配置
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time : 2021/2/7 8:39
# @Author : 小梁同学@0311
# @File : 1. 日志级别.py
# @Software: PyCharm
import logging
# 基础日志配置文件
logging.basicConfig(
# 1、日志输出位置:1. 终端; 2. 文件
# filename = 'access.log' # 不指定,默认打印到终端
# 2、日志格式
format='%(asctime)s - %(name)s - %(levelname)s -%(levelno)s -%(lineno)s- %(module)s: %(message)s',
# 3、时间格式
datefmt='%Y-%m-%d %H:%M:%S %p',
# 4、日志级别
# critical => 50
# error => 40
# waring => 30
# info => 20
# debug => 10
level=10,
)
logging.debug('调试debug')
logging.info('消息info')
logging.warning('警告warm')
logging.error('错误error')
logging.critical('严重critical')
2. 日志格式与输出位置
日志是给支撑运维人员看的
- 小梁老师写了ATM交易系统
- 系统交给银行,记录相关流入日志和报错日志
- 客户进行体验
备注:报错是给银行运维人员看的
3. 日志配置字典-settings.py
# settings.py
import os
# 1、定义三种日志输出格式,日志中可能用到的格式化串如下
# %(name)s Logger的名字
# %(levelno)s 数字形式的日志级别
# %(levelname)s 文本形式的日志级别
# %(pathname)s 调用日志输出函数的模块的完整路径名,可能没有
# %(filename)s 调用日志输出函数的模块的文件名
# %(module)s 调用日志输出函数的模块名
# %(funcName)s 调用日志输出函数的函数名
# %(lineno)d 调用日志输出函数的语句所在的代码行
# %(created)f 当前时间,用UNIX标准的表示时间的浮 点数表示
# %(relativeCreated)d 输出日志信息时的,自Logger创建以 来的毫秒数
# %(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
# %(thread)d 线程ID。可能没有
# %(threadName)s 线程名。可能没有
# %(process)d 进程ID。可能没有
# %(message)s用户输出的消息
# 2、强调:其中的%(name)s为getlogger时指定的名字
standard_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'
test_format = '[%(asctime)s] %(message)s'
# 3、日志配置字典
LOGGING_DIC = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'standard': {'format': standard_format},
'simple': {'format': simple_format},
'test': {'format': test_format}, },
'filters': {},
# handlers是日志的接收者,不同的handler会将日志输出到不同的位置
'handlers': {
# 打印到终端的日志
'console': {
'level': 'DEBUG',
'class': 'logging.StreamHandler', # 打印到屏幕
'formatter': 'simple'
},
# 打印到文件的日志,收集info及以上的日志
'default': {
'level': 'DEBUG',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件,日志轮转。 Rotating 日志轮转的意思
'formatter': 'standard',
# 可以定制日志文件路径
# BASE_DIR = os.path.dirname(os.path.abspath(__file__)) # log文件的目录
# LOG_PATH = os.path.join(BASE_DIR,'a1.log')
'filename': 'access1.log', # 日志文件
'maxBytes': 1024 * 1024 * 10, # 日志大小 10M
'backupCount': 5,
'encoding': 'utf-8', # 日志文件的编码,再也不用担心中文log乱码了
},
'other': {
'level': 'DEBUG',
'class': 'logging.FileHandler', # 保存到文件
'formatter': 'test',
'filename': 'access2.log',
'encoding': 'utf-8',
},
},
# loggers日志的产生者,产生的日志会传递给handler然后控制输出
'loggers': {
# logging.getLogger(__name__)拿到的logger配置
'TYPE1': {
'handlers': ['default', 'console'], # 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
'level': 'DEBUG', # loggers(第一层日志级别关限制)--->handlers(第二层日志级别关卡限制)
'propagate': False, # 默认为True,向上(更高level的logger)传递,通常设置为False即可,否则会一份日志向上层层传递
},
'TYPE2': {
'handlers': ['other', 'console'],
'level': 'DEBUG',
'propagate': False,
},
'专门的采集': {
'handlers': ['other', ],
'level': 'DEBUG',
'propagate': False,
},
},
}
4. 日志调用-common.py
方式一:
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time : 2021/2/7 14:10
# @Author : 小梁同学@0311
# @File : cs.py
# @Software: PyCharm
'''
接下来要做的是:拿到日志的产生者即loggers来产生日志
第一个日志的产生者:TYPE1
第二个日志的产生者:TYPE2
'''
# 首先需要导入日志配置字典LOGGING_DIC
import settings
from logging import config, getLogger
config.dictConfig(settings.LOGGING_DIC) # 加载配置项LOGGING_DIC
LOGGER1 = getLogger('TYPE2')
LOGGER1.info('这是一条info信息')
方式二:
# 只要是导入过程中存在的东西,哪怕是from logging import下 logging.a.b.c.f.g,这所有的东西都会被执行导入一遍
import logging.config
# 在导入config之前会导入一下 logging,所以logging也导入了
logging.config.dictConfig(settings.LOGGING_DIC) # 加载配置项LOGGING_DIC
LOGGER1 = logging.getLogger('TYPE2')
LOGGER1.info('这是一条info信息')
'''
需要注意的是:
import logging
config.dictConfig(settings.LOGGING_DIC)
这个会报错,因为logging 包下的__init__.py 下没有导入config模块,config属于 logging大文件夹下的子文件夹 只能顺着到子文件夹
'''
5. 日志名命名
日志名是区分日志业务归属的一种非常重要的标识,日志命名尽量和自己的模块相关,方便后期排查问题
解释:日志名是%(name)s Logger的名字所记录的日志的名字,即我settings.py 里的 loggers 的自定义的 key名(TYPE1、TYPE2、用户交易、用户登录等)
需求:
我想输出的日志文件位置是同一个,但是日志名不一样
# settings.py中 loggers 中自定义一个空key,不指定日志名,即
'': {
'handlers': ['other', ],
'level': 'DEBUG',
'propagate': False,
},
# 日志调用-common.py
LOGGER1 = logging.getLogger('用户交易') # 不存在该key时,调用settings.py中的空 key
LOGGER1.info('这是一条info信息')
LOGGER2 = logging.getLogger('用户常规操作') # 不存在该key时,调用settings.py中的空 key
LOGGER2.info('这是一条info信息')
# 以后经常遇到的业务是往一个日志中写不同场景的日志,只是业务名不一样,大多数日志都是记录到一起的
6. 日志轮转
日志记录着程序运行过程中的关键信息
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件,日志轮转。 Rotating 日志轮转的意思
'maxBytes': 1024 * 1024 * 10, # 日志大小 10M
'backupCount': 5,