python日志logging熟识

logging日志介绍

日志可以被用来记录银行转账、飞机飞行数据、事件执行步骤等。在python中,logging模块是Python内置的标准模块,主要用于输出运行日志,可以设置输出日志的等级、日志保存路径、日志文件回滚等。

一、日志等级

1、DEBUG:程序调试bug时使用
2、INFO:程序正常运行时使用
3、WARNING:程序未按预期运行时使用,但并不是错误,如手机号已被注册
4、ERROR:程序出错误时使用,如:IO操作失败
5、CRITICAL:特别严重的问题,导致程序不能再继续运行时使用,如:服务器宕机、磁盘爆满
默认的是WARNING等级,当在WARNING或WARNING之上等级的才记录日志信息。
等级级别低→高: DEBUG < INFO < WARNING < ERROR < CRITICAL,默认WARNING,则在WARNING及之上等级的才会被记录

二、日志显示数据格式

%(levelno)s:打印日志级别的数值
%(levelname)s:打印日志级别的名称
%(pathname)s:打印当前执行程序的路径,其实就是sys.argv[0]
%(filename)s:打印当前执行程序名
%(funcName)s:打印日志的当前函数
%(lineno)d:打印日志的当前行号
%(asctime)s:打印日志的时间
%(thread)d:打印线程ID
%(threadName)s:打印线程名称
%(process)d:打印进程ID
%(message)s:打印日志信息

三、进阶教程

应用阶段一(控制台、文件二选一输出)

1、璞玉(无修饰)

import logging

logging.debug('这是⼀个debug级别的⽇志信息')
logging.info('这是⼀个info级别的⽇志信息')
logging.warning('这是⼀个warning级别的⽇志信息')
logging.error('这是⼀个error级别的⽇志信息')
logging.critical('这是⼀个critical级别的⽇志信息')

注:输出到控制台,因为默认为warning,所以只会显示后三行信息
2、雕刻(添加打印样式)

import logging

logging.basicConfig(
    level=logging.DEBUG,
    format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s'
)

logging.debug('这是⼀个debug级别的⽇志信息')
logging.info('这是⼀个info级别的⽇志信息')
logging.warning('这是⼀个warning级别的⽇志信息')
logging.error('这是⼀个error级别的⽇志信息')
logging.critical('这是⼀个critical级别的⽇志信息')

注: 输出到控制台
3、上色(修改输出位置)

import logging
logging.basicConfig(
    level=logging.DEBUG,
    format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s',
    filename='log.txt',
    filemode='a'
)

logging.debug('这是⼀个debug级别的⽇志信息')
logging.info('这是⼀个info级别的⽇志信息')
logging.warning('这是⼀个warning级别的⽇志信息')
logging.error('这是⼀个error级别的⽇志信息')
logging.critical('这是⼀个critical级别的⽇志信息')

注: 输出到文件

应用阶段二(控制台、文件全选)

import logging

# 第一步,创建一个logger
logger = logging.getLogger()
logger.setLevel(logging.INFO)  # Log等级总开关  此时是INFO

# 第二步,创建一个handler,用于输出到控制台
terHandler = logging.StreamHandler()
terHandler.setLevel(logging.WARNING)   # 输出到console的log等级的开关

# 第三步,再创建一个handler,用于写入日志文件
fileName = 'log.txt'   # 文件路径可按需配置
fileHandler = logging.FileHandler(fileName, mode='a')  # open的打开模式rwa,此处用a,默认情况下,也是追加形式
fileHandler.setLevel(logging.DEBUG)  # 输出到file的log等级的开关

# 第四步,定义handler的输出格式(时间,文件,行数,错误级别,错误提示)
formatter = logging.Formatter("%(asctime)s - %(filename)s:%(lineno)s - %(levelname)s: %(message)s")
terHandler.setFormatter(formatter)
fileHandler.setFormatter(formatter)

# 第五步,将logger添加到handler里面
logger.addHandler(terHandler)
logger.addHandler(fileHandler)

# 日志级别
logger.debug('这是 logger debug message')
logger.info('这是 logger info message')
logger.warning('这是 logger warning message')
logger.error('这是 logger error message')
logger.critical('这是 logger critical message')

应用阶段三(日志文件全选并回滚)

什么是日志回滚:

将日志信息输出到一个单一的文件中,随着应用程序的持续使用,该日志文件会越来越庞大,进而影响系统的性能。因此,有必要对日志文件按某种条件进行切分,要切分日志文件。

分割日志的触发条件:大小、日期,或者大小加上日期。

说是切分,实际上是,当一个日志文件达到触发条件后,对日志文件进行重命名,之后再新建原来名称的日志文件(此时就是空文件了),新产生的日志就写入新的日志文件。

为啥叫回滚呢?当分割的日志文件达到指定数目的上限个数时,最老的日志文件就会被删除。
logging库提供了两个可以用于日志滚动的class

1)TimeRotatingFileHandler,它主要是根据时间进行滚动。在实际应用中,我们通常根据时间进行滚动

# 阶段为二里的代码
fileHandler = logging.FileHandler(fileName, mode='a')  # open的打开模式rwa,此处用a,不填的情况下,也是追加形式
# 更改为
# 1、增加导包选项
from logging.handlers import TimedRotatingFileHandler, RotatingFileHandler
# 2、时间回滚日志,一天产生一个文件,最多保留最近60个文件
fileHandler = TimedRotatingFileHandler(fileName, when='D', interval=1, backupCount=60)  # 不提供改读写模式,默认情况下,追加形式写数据
# 3、设置后缀名称
fileHandler.suffix = "%Y-%m-%d_%H-%M-%S.log"

注:如果设定是天,就必须写成“%Y-%m-%d.log”,写成其他格式会导致删除旧文件不生效。这个配置在源码里能看出来。

名词解释
①、when
“S”: Seconds
“M”: Minutes
“H”: Hours
“D”: Days
“W”: Week day (0=Monday)
“midnight”: Roll over at midnight
②、interval
指等待多少个单位when的时间后,Logger会自动重建文件,当然,这个文件的创建
取决于filename+suffix,若这个文件跟之前的文件有重名,则会自动覆盖掉以前的文件,所以
有些情况suffix要定义的不能因为when而重复
③、backupCount
保留日志个数。默认的0是不会自动删除掉日志。若设3,则在文件的创建过程中
库会判断是否有超过这个3,若超过,则会从最先创建的开始删除。

2)RotatingFileHandler,它主要是根据日志文件的大小进行滚动,

# 阶段为二里的代码
fileHandler = logging.FileHandler(fileName, mode='a')  # open的打开模式rwa,此处用a,不填的情况下,也是追加形式
# 更改为
# 1、增加导包选项
from logging.handlers import TimedRotatingFileHandler, RotatingFileHandler
# 2、大小回滚日志,每一个文件最大为100Bytes,仅保留5个文件
fileHandler = RotatingFileHandler(fileName, maxBytes=500, backupCount=5)  # 不提供改读写模式,默认情况下,追加形式写数据
# 3、设置后缀名称
fileHandler.suffix = "%Y-%m-%d_%H-%M-%S.log"

四、关于django的log配置

4.1、setting配置

  • 基本模式
LOGGING = {
    'version': 1,  # dictConnfig的版本,目前就只有一个版本
    'disable_existing_loggers': False,  # 指明是否禁用所有的已经存在的日志配置
    'filters': {},  # 过滤器用于对日志消息的二次验证,不常用
    'formatters': {}  # 日志打印格式
    'handlers': {}  # 指明日志操作形式
    'loggers': {}  # 声明log实例,可多个,按需求决定实际项目用哪个
}
  • 玩真的
# log配置,log_path是存放日志的路径
cur_path = os.path.dirname(os.path.realpath(__file__))  # os.path.realpath(__file__)获取的当前文件的绝对路径(带文件名)
# os.path.dirname(cur_path) 获取的是cur_path的上一级路径
log_path = os.path.join(os.path.dirname(os.path.dirname(cur_path)), 'log')
if not os.path.exists(log_path): os.mkdir(log_path)  # 如果不存在这个log文件夹,就自动创建一个

LOGGING = {
    'version': 1,  # dictConnfig的版本,目前就只有一个版本
    'disable_existing_loggers': False,  # 指明是否禁用所有的已经存在的日志配置
    'filters': {  # 过滤器用于对日志消息的二次验证,不常用
        'special': {}  # 未配置
    },
    'formatters': {  # 日志格式配置
        'standard': {  # 标准
            'format': '[%(asctime)s][%(levelname)s][%(filename)s:%(lineno)d:%(funcName)s]:%(message)s',
            'datefmt': '%Y-%m-%d %H:%M:%S'
        },
        'simple': {  # 简单
            'format': '[%(asctime)s][%(levelname)s]:%(message)s',
            'datefmt': '%Y-%m-%d %H:%M:%S'
        }
    },
    'handlers': {  # 处理器handle表明操作日志的形式
        'console': {  # 在console输出配置
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        'default': {  # 文件分割日志,default配置:将日志存入文件
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(log_path, 'info-{}.log'.format(time.strftime('%Y-%m-%d'))),
            'maxBytes': 1024 * 1024 * 50,  # 日志大小50M
            'backupCount': 5,
            'formatter': 'standard',
            'encoding': 'utf-8',
        },
        'time_handler': {  # 时间分割日志,约定时间将日志存入文件
              'level': 'INFO',
              'class': 'logging.handlers.TimedRotatingFileHandler',
              'filename': os.path.join(log_path, 'time-{}.log'.format(time.strftime('%Y-%m-%d'))),
              'when': 'S',
              'interval': 10,
              'backupCount': 5,
              'formatter': 'standard',
              'encoding': 'utf-8',
          },
        'email_handler': {  # 邮箱日志配置,将日志发送给邮箱
              'level': 'ERROR',
              'class': 'logging.handlers.SMTPHandler',
              'formatter': 'standard',
              'mailhost': ('smtp.163.com', 25),
              'fromaddr': 'xxxx@163.com',
              'toaddrs': ['xxx@qq.com'],
              'subject': 'test',
              'credentials': ('邮箱用户名', '邮箱密码'),
          },
    },
    'loggers': {  # 定义log实例
        # 需要知道的是django有默认的日志DEFAULT_LOGGING,此下方django实例属于重写了该日志配置
        'django': {  # 创建实例名为django,根据下面配置知,当使用INFO级别以上记录日志时,既会在terminal(参照handle之console)显示,也会保存到log文件中(参照handle之default)
            'handlers': ['console', 'default'],  # 指定处理器列表
            'filters': [],  # 指定过滤器列表
            'level': 'INFO',  # 指定记录日志的级别
            'propagate': True  # 设置该记录器的日志是否传播到父记录器,不设置则是True
        },
        'django.request': {  # django记录器的子记录器,记录与请求处理相关的消息,处理ERROR级别及以上的日志
            'handlers': ['email_handler'],
            'level': 'ERROR',
            'propagate': False,  # False,表明不传播日志给 "django",只需传递给mail_admins控制器
        },
        'myproject.custom': {
            'handlers': ['console', 'email_handler'],  # 传递日志给console、mail_admins处理
            'level': 'INFO',
            'filters': ['special']  # 使用过滤器special来过滤日志
        }
    },
}

4.1、view配置

import logging
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

# 绑定logger实例
logger = logging.getLogger('django')  # 也可以绑定setting中配置的django.request或myproject.custom

class AccountView(GenericViewSet):
	# queryset = User.objects.all()
	# authentication_classes = []
	# permission_classes = [AllowAny]
	# serializer_class = serializers.AccountSerializer
	
	# @swagger_auto_schema()
	@action(methods=['POST'], detail=False, permission_classes=[], uthentication_classes=[])
	def login(request):
		logger.info("开始登陆")

五、结束,希望你们学到了!!!

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
Python中的logging模块提供了一种灵活且可配置的方式来记录信息。通过使用不同的handler、formatter和logger对象的组合,可以控制日志消息的输出方式、输出位置和格式。使用logging模块可以在代码中记录各种级别的消息,例如调试信息、警告、错误和致命错误。下面是一个简单的例子: ```python import logging # 创建一个logger logger = logging.getLogger('my_logger') logger.setLevel(logging.DEBUG) # 创建一个文件handler,用于写入日志文件 fh = logging.FileHandler('mylog.log') fh.setLevel(logging.DEBUG) # 创建一个控制台handler,用于输出到控制台 ch = logging.StreamHandler() ch.setLevel(logging.ERROR) # 定义日志输出格式 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') fh.setFormatter(formatter) ch.setFormatter(formatter) # 将handler添加到logger中 logger.addHandler(fh) logger.addHandler(ch) # 记录日志 logger.debug('debug message') logger.info('info message') logger.warning('warning message') logger.error('error message') logger.critical('critical message') ``` 上面的代码创建了一个logger对象,并添加了一个文件handler和一个控制台handler。文件handler会将日志信息写入到指定的文件中,控制台handler会将错误级别以上的日志信息输出到控制台。该例子还定义了日志信息的格式,最后通过调用logger对象的各个方法来记录不同级别的日志信息。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

学无止境gwx

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值