Python日志系统logging使用介绍

最新推荐文章于 2024-09-11 13:40:03 发布
最新推荐文章于 2024-09-11 13:40:03 发布
阅读量963 收藏 10
点赞数 20
文章标签： python java 数据库
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xjt921122/article/details/135983502
版权

日志记录对于软件开发调试和运行都非常重要。Python标准库提供了一个日志记录系统，可以很方便的在python项目中添加日志记录。本文将详细介绍如何使用python的 logging 模块来记录日志。

目录

基础使用 日志级别 基本配置 保存日志到文件 格式化输出 捕获异常信息自定义logger 日志模块四大组件 处理器 格式器 过滤器 示例其他配置方法 fileConfig()方法 dictConfig()方法 1. yaml配置文件 2. json配置文件

基础使用

日志级别

主要包括了5种日志级别，代表5种严重级别（严重程度由低到高）：

  • DEBUG：提供详细的详细

  • INFO：程序运行的关键步骤信息

  • WARNING：警告信息

  • ERROR：程序错误，某个功能无法执行

  • CRITICAL：严重错误，可能整个程序无法执行

Logger提供了一个默认的记录器，称为root Logger。

import logging``   ``logging.debug('Debug 级别日志信息')``logging.info('Info 级别日志信息')``logging.warning('Warning 级别日志信息')``logging.error('Error 级别日志信息')``logging.critical('Critical 级别日志信息')

输出：

WARNING:root:Warning 级别日志信息``ERROR:root:Error 级别日志信息``CRITICAL:root:Critical 级别日志信息

默认打印WARNING及更高严重级别的日志。

基本配置

可以使用basicConfig(**kwargs)方法对日志系统进行配置。常用参数如下:

  • level: 指定严重级别。

  • filename: 指定文件。

  • filemode: 如果指定了filename，则以该模式打开文件。默认是a，表示追加。

  • a：追加

  • w：覆盖

  • format:日志信息的格式。默认levelname, name和message属性，用冒号分隔。

注意：basicConfig函数只能被调用一次。

level参数可以设置要记录的日志消息的严重级别:

import logging``   ``logging.basicConfig(level=logging.DEBUG)``   ``logging.debug('Debug 级别日志信息')``logging.info('Info 级别日志信息')``logging.warning('Warning 级别日志信息')``logging.error('Error 级别日志信息')``logging.critical('Critical 级别日志信息')

输出：

DEBUG:root:Debug 级别日志信息``INFO:root:Info 级别日志信息``WARNING:root:Warning 级别日志信息``ERROR:root:Error 级别日志信息``CRITICAL:root:Critical 级别日志信息

保存日志到文件

import logging``   ``logging.basicConfig(filename='test.log', filemode='w', format='%(name)s - %(levelname)s - %(message)s')``logging.debug('Debug 级别日志信息')``logging.info('Info 级别日志信息')``logging.warning('Warning 级别日志信息')``logging.error('Error 级别日志信息')``logging.critical('Critical 级别日志信息')

格式化输出

format 参数用于格式化输出设置，除了默认设置levelname, name和message属性：

属性名使用格式描述
asctime%(asctime)s时间，默认格式为 ‘2003-07-08 16:49:45,896’
created%(created)f时间戳
relativeCreated%(relativeCreated)d相对于加载日志模块的时间(以毫秒为单位)。
msecs%(msecs)d日志创建时间的毫秒部分
filename%(filename)s脚本文件名称
funcName%(funcName)s调用日志记录的函数名称
module%(module)s脚本模块名
pathname%(pathname)s脚本文件绝对路径名
name%(name)s记录器名称，默认logger名为root
levelname%(levelname)s文本类型的日志级别 ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL').
levelno%(levelno)s数字类型的日志级别 (10, 20, 30, 40, 50).
lineno%(lineno)d日志调用的代码所在行号
message%(message)s日志信息
process%(process)d进程ID
processName%(processName)s进程名称
thread%(thread)d线程ID
threadName%(threadName)s线程名

其中 asctime 时间格式可以使用 datefmt 属性更改，语法格式与python datetime模块的格式化函数相同，例如:

import logging``   ``logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(message)s', datefmt='%Y%m%d-%H:%M:%S')``   ``logging.debug('Debug 级别日志信息')``logging.info('Info 级别日志信息')``logging.warning('Warning 级别日志信息')``logging.error('Error 级别日志信息')``logging.critical('Critical 级别日志信息')

输出：

20230228-22:13:05 - Debug 级别日志信息``20230228-22:13:05 - Info 级别日志信息``20230228-22:13:05 - Warning 级别日志信息``20230228-22:13:05 - Error 级别日志信息``20230228-22:13:05 - Critical 级别日志信息

除了以上属性外，还支持自定义属性，使用 extra 参数传递：

import logging``   ``FORMAT = '%(asctime)s - %(clientip)s - %(message)s'``logging.basicConfig(format=FORMAT)``clientip = '192.168.0.1'``d = {'clientip':clientip}``   ``logging.info('Info 级别日志信息')``logging.warning('Warning 级别日志信息', extra=d)

输出：

2023-03-04 11:21:23,459 - 192.168.0.1 - Warning 级别日志信息

捕获异常信息

设置 exc_info 参数为 True 可以输出信息报错信息：

import logging``   ``try:`  `res = 1 / 0``except Exception as e:`  `logging.error(e, exc_info=True)

输出：

ERROR:root:division by zero``Traceback (most recent call last):`  `File "d:\logging\log_demo3.py", line 4, in <module>`    `res = 1 / 0``ZeroDivisionError: division by zero

也可以使用 logging.exception() 方法，效果一样：

logging.exception(e)

另外，stack_info 参数设置为 True 是可以打印堆栈信息。

自定义logger

可以通过创建logger类的对象来定义自己的记录器。

日志模块四大组件

日志模块最常用的类:

  • Logger：公开了一个接口，代码通过使用该接口记录日志消息。

  • Handler：处理器，将logger创建的日志发送到目的地（控制台或文件）。常用的处理程序包括:

  • FileHandler:用于将日志消息发送到文件

  • StreamHandler:用于向输出流(如stdout)发送日志消息

  • SyslogHandler:用于向syslog守护进程发送日志消息

  • HTTPHandler:用于使用HTTP协议发送日志消息

  • Filter：过滤器，提供一种机制来确定记录哪些日志。

  • Formatter：格式器，决定日志消息的输出格式。

Logger类是入口，使用模块级别函数 logging.getLogger(name) 实例化，最终由Handler来对日志进行处理，Handler会调用Filter和Formatter来对日志进行过滤和格式化。

import logging``   ``logger = logging.getLogger('mylogger')``   ``logger.debug('Debug 级别日志信息')``logger.info('Info 级别日志信息')``logger.warning('Warning 级别日志信息')``logger.error('Error 级别日志信息')``logger.critical('Critical 级别日志信息')

自定义logger不能使用 basicConfig() 来配置，需要使用 处理器（Handler）和 格式器（Formatter）来配置。

处理器

可以使用处理器（Handler）来配置自定义logger将日志保存到文件、输出到控制台、通过HTTP发送或者通过邮件发送。

处理器也可以设置日志严重级别，为文件处理器(FileHandler)和控制台处理器(StreamHandler)设置不同的日志级别。

# 创建处理器 handlers``console_handler = logging.StreamHandler() # 输出到控制台``file_handler    = logging.FileHandler(logname) # 输出到文件``console_handler.setLevel(logging.WARNING)``file_handler.setLevel(logging.ERROR)

格式器

格式器（Formatter）用来配置格式化输出。

# 创建格式器``console_format = logging.Formatter('%(name)s - %(levelname)s - %(message)s', '%Y%m%d-%H:%M:%S')``file_format    = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', '%Y%m%d-%H:%M:%S')

过滤器

过滤器（Filter）可实现日志过滤操作，

import logging``import sys``import os``   ``class failureFilter(logging.Filter):`    `def filter(self, record):`        `if 'Failure' in record.msg:`            `return True`        `return False``   ``logger = logging.getLogger(__name__)`  `console_handler = logging.StreamHandler(stream=sys.stdout) # 输出到控制台``# 添加filter``loggingFiletr = failureFilter()``console_handler.addFilter(loggingFiletr)``   ``logger.addHandler(console_handler)``logger.info('Info 级别日志信息')``logger.error('Failure')

示例

自定义logger示例脚本：

import logging``import sys``import os``   ``class failureFilter(logging.Filter):`    `def filter(self, record):`        `if 'Failure' in record.msg:`            `return True`        `return False``   ``logger = logging.getLogger(__name__)``logger.setLevel(logging.INFO)``   ``abspath = os.path.dirname(os.path.abspath(__file__)) # 脚本绝对路径``logname = os.path.join(abspath, 'file.log')``   ``# 创建处理器 handlers``console_handler = logging.StreamHandler(stream=sys.stdout) # 输出到控制台``file_handler    = logging.FileHandler(logname) # 输出到文件``console_handler.setLevel(logging.WARNING)``file_handler.setLevel(logging.ERROR)``   ``# 添加filter``loggingFiletr = failureFilter()``console_handler.addFilter(loggingFiletr)``file_handler.addFilter(loggingFiletr)``   ``# 创建格式器``console_format = logging.Formatter('%(name)s - %(levelname)s - %(message)s', '%Y%m%d-%H:%M:%S')``file_format    = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s', '%Y%m%d-%H:%M:%S')``   ``# 将格式器添加到处理器中``console_handler.setFormatter(console_format)``file_handler.setFormatter(file_format)``   ``# 将处理器添加到logger``logger.addHandler(console_handler)``logger.addHandler(file_handler)``   ``logger.info('Info 级别日志信息')``logger.error('Failure')

其他配置方法

除了前面介绍的 basicConfig() 方法、logger、handler和formatter来配置日志记录器外，还可以使用 fileConfig() 或 dictConfig() 方法来加载配置文件或字典实现日志记录器的配置。

fileConfig()方法

配置文件（可使用configparser类读取）格式如下，此配置文件配置了控制台和文件输出两种方式：

[loggers]``keys=root,mylogger``   ``[handlers]``keys=consoleHandler,fileHandler``   ``[formatters]``keys=sampleFormatter``   ``[logger_root]``level=DEBUG``handlers=consoleHandler``   ``[logger_mylogger]``level=DEBUG``handlers=consoleHandler,fileHandler``qualname=mylogger``propagate=0``   ``[handler_consoleHandler]``class=StreamHandler``level=DEBUG``formatter=sampleFormatter``args=(sys.stdout,)``   ``[handler_fileHandler]``class=FileHandler``level=DEBUG``formatter=sampleFormatter``args=("config.log", "a")``   ``[formatter_sampleFormatter]``format=%(asctime)s - %(name)s - %(levelname)s - %(message)s``qualname=mylogger

使用 fileConfig 方法来加载配置：

import logging``import logging.config``import os``   ``abspath = os.path.dirname(os.path.abspath(__file__))` `confpath = os.path.join(abspath, 'logging.conf')``   ``if os.path.exists(confpath):`    `logging.config.fileConfig(fname=confpath, disable_existing_loggers=False)``   ``# create logger``logger = logging.getLogger("mylogger")``   ``logger.debug('Debug 级别日志信息')``logger.info('Info 级别日志信息')

dictConfig()方法

配置字典可以使用yaml或者json代码来编写。

1. yaml配置文件

创建logging.yaml：

version: 1``formatters:`  `simple:`    `format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'`    `datefmt: '%Y-%m-%d %H:%M:%S'``handlers:`  `console:`    `class: logging.StreamHandler`    `level: INFO`    `formatter: simple`    `stream: ext://sys.stdout`  `fileHandler:`    `class: logging.FileHandler`    `level: DEBUG`    `formatter: simple`    `filename: yaml.log`    `encoding: utf8``loggers:`  `mylogger:`    `level: DEBUG`    `handlers: [console,fileHandler]`    `propagate: no``root:`  `level: DEBUG`  `handlers: [console]

调用示例：

import logging``import logging.config``import os``import yaml``   ``abspath = os.path.dirname(os.path.abspath(__file__))``confpath = os.path.join(abspath, 'logging.yaml')``   ``if os.path.exists(confpath):`    `with open(confpath, 'r') as f:`        `config = yaml.safe_load(f.read())`    `logging.config.dictConfig(config)``   ``logger = logging.getLogger('mylogger')``   ``logger.debug('Debug 级别日志信息')``logger.info('Info 级别日志信息')

2. json配置文件

创建logging.json：

{`    `"version":1,`    `"disable_existing_loggers":false,`    `"formatters":{`        `"simple":{`            `"format":"%(asctime)s - %(name)s - %(levelname)s - %(message)s",`            `"datefmt":"%Y-%m-%d %H:%M:%S"`        `}`    `},`    `"handlers":{`        `"console":{`            `"class":"logging.StreamHandler",`            `"level":"DEBUG",`            `"formatter":"simple",`            `"stream":"ext://sys.stdout"`        `},`        `"fileHandler":{`            `"class":"logging.handlers.RotatingFileHandler",`            `"level":"INFO",`            `"formatter":"simple",`            `"filename":"json.log",`            `"maxBytes":10485760,`            `"backupCount":10,`            `"encoding":"utf8"`        `}`    `},`    `"loggers":{`        `"mylogger":{`            `"level":"INFO",`            `"handlers":["fileHandler"],`            `"propagate":"no"`        `}`    `},`    `"root":{`        `"level":"INFO",`        `"handlers":["console","fileHandler"]`    `}``}

调用示例：

import logging``import logging.config``import os``import json``   ``abspath = os.path.dirname(os.path.abspath(__file__))` `confpath = os.path.join(abspath, 'logging.json')``   ``if os.path.exists(confpath):`    `with open(confpath, 'r') as f:`        `config = json.load(f)`    `logging.config.dictConfig(config)``   ``logger = logging.getLogger("mylogger")``   ``logger.debug('Debug 级别日志信息')``logger.info('Info 级别日志信息')

点击下方安全链接前往获取

CSDN大礼包：《Python入门&进阶学习资源包》免费分享

👉Python实战案例👈

光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

图片

图片

👉Python书籍和视频合集👈

观看零基础学习视频，看视频学习是最快捷也是最有效果的方式，跟着视频中老师的思路，从基础到深入，还是很容易入门的。

图片

👉Python副业创收路线👈

图片

这些资料都是非常不错的，朋友们如果有需要《Python学习路线&学习资料》，点击下方安全链接前往获取

CSDN大礼包：《Python入门&进阶学习资源包》免费分享

本文转自网络，如有侵权，请联系删除。

xjt921122
关注
Python常用模块 之 logging：日志模块
孤寒者的博客
08-02 16万+
目录????0.引言：1.Logging模块第一阶段——基本使用！1.简介：2.日志等级：3.formater格式：4.日志等级&format格式模拟使用：5.日志信息保存为文件：第二阶段——进阶版操作！1.logging模块还提供了模块化组件的方法——灵活配置日志器：2.模块化组件使用：（1）使用步骤：（2）实战使用一（一个日志记录器对应一个日志处理器）：（3）实战使用二（一个日志记录器对应多[此处是两个]个日志处理器）：2.In The End！ ????0.引言： ????????相信很多初
python-logging配置
weixin_42125148的博客
05-15 744
1、logging四个组件：logger（日志记录器），handler（日志处理器），formatter（格式化器）、filter（日志过滤器）一个项目中可以设置多个logger，logger = logging.getLogger('***')，每个logger定义不同的日志级别、处理器过滤器等，以便日志分类查询handler可以配置日志级别、日志格式化样式、日志过滤器等。
Python日志库logging
weixin_44245323的博客
06-28 948
上面的基本使用可以让我们快速上手 logging 模块，但一般并不能满足实际使用，我们还需要自定义 Logger。一个系统只有一个 Logger 对象，并且该对象不能被直接实例化，没错，这里用到了单例模式，获取 Logger 对象的方法为 getLogger。
100天精通Python（基础篇）——第32天：日志标准库logging
最新发布
2401_86437188的博客
09-11 1053
PS：当为某个应用程序指定一个日志级别后，应用程序会记录所有日志级别大于或等于指定日志级别的日志信息，而不是仅仅记录指定级别的日志信息，只要级别大于或等于该指定日志级别的日志记录才会被输出，小于该级别的日志记录将会被丢弃。2、logging工作流程Logger：日志，暴露函数给应用程序，基于日志记录器和过滤器级别决定哪些日志有效。LogRecord ：日志记录器，将日志传到相应的处理器处理。Handler ：处理器, 将(日志记录器产生的)日志记录发送至合适的目的地。Filter ：过滤器, 提供了更好的粒
Python014--python中的logging日志模块
码到成龚的博客
10-22 1372
一，logging概述 二，直接将日志打印在控制台 1，使用logging模块自带的日志打印方法 2，使用logging模块创建对象 1）StreamHandler（） 三，将日志输入到文件中 1，FileHandler() 2,TimedRotatingFileHandler（）
python使用json做配置_python logging通过json文件配置的步骤
weixin_39830917的博客
12-09 395
logconfig.json{"version":1,"disable_existing_loggers":false,"formatters":{"simple":{"format":"[%(asctime)s - %(levelname)s - line(%(lineno)d) - %(filename)s]: %(message)s","datefmt":"%Y-%m-%d %H:%M:%S...
Python 日志文件分级导出 json配置logging
kangzi139的博客
06-30 338
若有错误，敬请指正…… json配置文件 { "version":1, "disable_existing_loggers":false, "formatters":{ "simple":{ "format":"%(asctime)s - %(filename)s - [line:%(lineno)d] - %(name)s - %(levelname)s - %(message)s", "datefmt":"%Y
python日志logging模块使用方法分析
01-01
本文实例讲述了python日志logging模块使用方法。分享给大家供大家参考，具体如下： 一、从一个使用场景开始 开发一个日志系统， 既要把日志输出到控制台， 还要写入日志文件 import logging # 创建一个logger ...
python 日志 logging模块详细解析
09-17
Python 的 `logging` 模块提供了一套强大且灵活的日志系统，适用于各种规模的项目。通过设置不同级别、格式和处理器，开发者可以有效地监控和调试程序，确保问题得到及时解决。无论是在开发阶段还是在生产环境中，...
Python中使用logging模块打印log日志详解
09-22
Python中的logging模块是该语言内置的日志记录系统，它可以帮助开发者记录程序运行时的各种消息，便于进行错误查找、性能分析和调试。logging模块提供了一种灵活的框架，可以用来记录不同类型的信息，从程序中的调试...
Python日志处理(logging模块介绍)
ranxirui8580的博客
01-02 1173
logging模块是Python的一个标准库模块，由标准库模块提供日志记录API的关键好处是所有Python模块都可以使用这个日志记录功能。第一种方式是使用logging提供的模块级别的函数。第二种方式是使用Logging日志系统的四大组件其实，logging所提供的模块级别的日志记录函数也是对logging日志系统相关类的封装而已。logging模块定义的模块级别的常用函数函数说明创建一条严重级别为DEBUG的日志记录创建一条严重级别为INFO的日志记录。
python logging模块-写日志、log回滚
alex1801
06-15 6921
1、logging模块简介 logging模块是Python内置的标准模块，主要用于输出运行日志，可以设置输出日志的等级、日志保存路径、日志文件回滚等；相比print，具备如下优点： 1、可以通过设置不同的日志等级，在release版本中只输出重要信息，而不必显示大量的调试信息； 2、print将所有信息都输出到标准输出中，严重影响开发者从标准输出中查看其它数据；logging则可以由开发者决定将信息输出到什么地方，以及怎么输出； 3、其它特点：basicConfig整个工程只在第一次配置时生效。
Python日志库logging总结(最全的版本)
Chelseady的博客
09-02 3223
转自：https://cloud.tencent.com/developer/article/1354396 1、日志级别 Python 标准库 logging 用作记录日志，默认分为六种日志级别（括号为级别对应的数值），NOTSET（0）、DEBUG（10）、INFO（20）、WARNING（30）、ERROR（40）、CRITICAL（50）。我们自定义日志级别时注意不要和默认的日志...
Python日志logging实战教程
qq_41314882的博客
11-14 2205
日志数据的核心就是日志消息或日志，日志消息是计算机系统、设备、软件等在某种刺激下反应生成的东西。日志数据（log data）就是一条日志消息的内在含义，用来告诉你为什么生成日志消息的信息。日志（log）指用于展示某些事件全貌的日志消息的集合。
在python中记录log
qq_18677445的博客
03-27 820
在python中记录log
20、Python 日志管理工具：logging
Man
03-23 115
通过记录和分析日志可以了解一个系统或软件。，也可以在应用程序出现故障时。
python 简单实现日志功能以及实现每天自动产生新的日志文件
weixin_44598554的博客
01-30 2617
做项目的时候，将代码的输出结果以日志的方式保存下来，是很有必要的在python中，内置了一个日志模块logging，用来输出日志信息，我们可以进行配置各种参数，从而满足我们大部分场景对日志的需求。
python log日志_Python中logging日志的四个等级和使用
weixin_39640909的博客
11-29 389
1. logging日志的介绍在现实生活中，记录日志非常重要，比如:银行转账时会有转账记录；飞机飞行过程中，会有个黑盒子（飞行数据记录器）记录着飞机的飞行过程，那在咱们python程序中想要记录程序在运行时所产生的日志信息，怎么做呢?可以使用 logging 这个包来完成记录程序日志信息的目的是:1. 可以很方便的了解程序的运行情况2. 可以分析用户的操作行为、喜好等信息3. 方便开发人员检查bu...
logging日志的四个等级和使用
灵感点滴的分享
05-08 1829
1. logging日志的介绍 在现实生活中，记录日志非常重要，比如:银行转账时会有转账记录；飞机飞行过程中，会有个黑盒子（飞行数据记录器）记录着飞机的飞行过程，那在咱们python程序中想要记录程序在运行时所产生的日 志信息，怎么做呢? 可以使用 logging 这个包来完成 记录程序日志信息的目的是: 可以很方便的了解程序的运行情况 可以分析用户的操作行为、喜好等信息 方便开发人员检查bug...
Python日志处理 logging详解及实战应用
本文档深入浅出地介绍了Python中的logging模块，一个用于日志记录的强大工具。Python作为一种动态语言，其灵活性使得在程序运行过程中可能遇到难以预见的问题，因此一个有效的日志系统对于大型项目至关重要。logging...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值