Python中的日志模块(logging)如何配置和使用?

Python的logging模块通过日志器、处理器、格式化器和过滤器实现灵活的日志管理,支持多级别、多目的地输出,相比print()具有可配置性强、格式丰富、线程安全等优势,适用于复杂项目的日志需求。

python中的日志模块(logging)如何配置和使用?

Python的

logging

模块是处理程序运行信息的核心工具,它允许你以灵活的方式记录各种事件,比如调试信息、普通消息、警告、错误乃至严重错误。其配置和使用主要围绕着几个核心概念:日志器(Logger)、处理器(Handler)、格式化器(Formatter)和过滤器(Filter)。简单来说,就是你告诉日志器要记录什么信息(日志级别),这些信息要通过哪些途径(处理器)输出到哪里(文件、控制台、网络等),以及输出时要以什么格式(格式化器)呈现。

解决方案

在我看来,掌握

logging

模块,首先要理解它的层次结构和配置灵活性。最简单的上手方式是使用

logging.basicConfig()

,这对于小型脚本或快速调试非常方便。它会为你设置一个默认的处理器(通常是

StreamHandler

,输出到控制台)和一个默认的格式。

import logging# 最简单的配置,日志会输出到控制台# 默认级别是WARNING,所以INFO和DEBUG不会显示logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')logging.debug("这是一条调试信息,通常在开发阶段有用。")logging.info("程序正常运行,记录一些关键步骤。")logging.warning("出现了一些潜在问题,但程序可能还能继续。")logging.error("程序执行出错,但可能不致命。")logging.critical("严重错误,程序可能无法继续运行。")# 如果想输出到文件,可以这样配置# logging.basicConfig(filename='app.log', level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

但真实项目往往需要更精细的控制。这时,我们就需要手动创建和配置日志器、处理器和格式化器。

获取日志器(Logger):这是你与日志系统交互的主要入口。通常会按模块或功能划分日志器,例如

logging.getLogger(__name__)

立即学习“Python免费学习笔记(深入)”;

import loggingmy_logger = logging.getLogger('my_app') # 获取一个名为'my_app'的日志器my_logger.setLevel(logging.DEBUG) # 设置该日志器的最低记录级别

创建处理器(Handler):决定日志的输出目的地。

StreamHandler

:输出到控制台(

sys.stderr

)。

FileHandler

:输出到文件。

RotatingFileHandler

:当文件达到一定大小后自动轮转(创建新文件)。

TimedRotatingFileHandler

:按时间间隔轮转。还有其他如

SMTPHandler

(邮件)、

HTTPHandler

(HTTP请求)等。

# 创建一个输出到控制台的处理器console_handler = logging.StreamHandler()console_handler.setLevel(logging.INFO) # 该处理器只处理INFO级别及以上的日志

创建一个输出到文件的处理器

file_handler = logging.FileHandler(‘app.log’)file_handler.setLevel(logging.DEBUG) # 该处理器处理DEBUG级别及以上的日志


定义格式化器(Formatter):控制日志消息的显示格式。

# 定义控制台日志的格式console_formatter = logging.Formatter('%(name)s - %(levelname)s - %(message)s')# 定义文件日志的格式,包含时间戳和文件名file_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(filename)s:%(lineno)d - %(message)s')

将格式化器绑定到处理器,再将处理器绑定到日志器

console_handler.setFormatter(console_formatter)file_handler.setFormatter(file_formatter)my_logger.addHandler(console_handler)my_logger.addHandler(file_handler)# 实际使用my_logger.debug("这条调试信息会写入文件,但不会显示在控制台。")my_logger.info("这条信息会同时写入文件和控制台。")my_logger.error("程序中发生了一个错误!")

这里需要注意,一个日志器可以有多个处理器,每个处理器可以有不同的级别和格式,这提供了极大的灵活性。例如,你可能希望控制台只显示警告和错误,而文件则记录所有详细信息。

为什么不直接用print(),Python日志模块的优势体现在哪里?

我个人觉得,很多人在项目初期,或者在调试一些小脚本时,都会习惯性地用

print()

。这确实很直接,但一旦项目规模扩大,或者需要部署到生产环境,

print()

的局限性就暴露无遗了。

logging

模块的优势,在我看来,主要体现在以下几个方面:

首先是日志级别(Levels)

print()

只有一种“级别”,就是输出。但

logging

模块提供了

DEBUG

,

INFO

,

WARNING

,

ERROR

,

CRITICAL

等预定义级别,你可以根据消息的重要性来分类。这意味着在生产环境中,我可以只显示

WARNING

及以上的信息,而在开发时则可以打开

DEBUG

级别,获取所有细节。这种按需筛选的能力,

print()

是完全无法提供的。

其次是输出目的地(Destinations)的灵活性。

print()

默认只能输出到标准输出(控制台)。但

logging

模块可以通过各种

Handler

将日志发送到文件、网络(HTTP、SMTP)、系统日志(syslog)、甚至数据库。比如,我曾经遇到一个需要将特定错误邮件通知管理员的场景,用

SMTPHandler

就能轻松实现,

print()

就无能为力了。

再来是格式化(Formatting)

logging.Formatter

允许你自定义日志的输出格式,可以包含时间戳、日志级别、文件名、行号、进程ID、线程ID等丰富的信息。这对于排查问题至关重要。一个带有时间戳和文件路径的错误日志,比一个光秃秃的错误信息,能帮助我更快地定位问题。

模块化与可配置性也是一个大亮点。在大型项目中,不同的模块可能有不同的日志需求。

logging

允许你为不同的模块创建独立的

Logger

,它们可以有自己的级别和处理器。更进一步,你可以通过配置文件(如

logging.config.fileConfig

logging.config.dictConfig

)在不修改代码的情况下调整日志行为,这在部署和维护阶段简直是神器。

最后,不得不提的是性能和并发安全

logging

模块在设计时考虑了多线程环境下的并发安全,而

print()

在多线程并发输出时可能会出现交错混乱。此外,

logging

在处理不需记录的低级别消息时,会有优化,避免不必要的字符串格式化开销。虽然这在小项目里不明显,但在高并发或日志量大的应用中,性能差异还是挺显著的。

在复杂项目中,如何有效管理多个日志文件和配置?

在复杂项目中,日志管理往往是个让人头疼的问题,如果处理不好,日志本身就会成为新的“噪音源”。我通常会采取以下几种策略来有效管理多个日志文件和配置,这能让日志系统既灵活又易于维护。

一个核心的思路是利用日志器的层级结构

logging

模块的日志器是树状结构的,比如

my_app.module_a

my_app

的子日志器。子日志器默认会将日志事件传递给父日志器(除非

propagate

属性被设置为

False

)。这允许我们为整个应用设置一个通用的根日志器,再为特定模块或功能设置更具体的日志器。例如,数据库操作可以有一个

db

日志器,API接口可以有一个

api

日志器。

# app.pyimport logginglogger = logging.getLogger('my_app')logger.setLevel(logging.INFO) # 父日志器级别# db.pyimport loggingdb_logger = logging.getLogger('my_app.db') # 继承父日志器,但可以有自己的配置db_logger.debug("数据库连接尝试...") # 如果父日志器级别是INFO,这里不会显示# api.pyimport loggingapi_logger = logging.getLogger('my_app.api')api_logger.warning("API请求参数异常!")

这样,我就可以通过

my_app.db

来单独控制数据库相关的日志输出,而不会影响到其他模块。

更进一步,使用配置文件进行日志配置是复杂项目的标准做法。手动在代码中配置所有的

Logger

Handler

Formatter

会非常臃肿且难以维护。Python的

logging.config

模块提供了两种主要方式:

fileConfig()

(基于INI格式)和

dictConfig()

(基于字典,通常从YAML或JSON加载)。我个人更倾向于

dictConfig()

,因为它与Python数据结构更贴合,也更容易与现代配置管理工具集成。

# logging_config.yaml (示例,实际应用中可以更复杂)version: 1disable_existing_loggers: False # 保持现有日志器不变formatters:  simple:    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'  detailed:    format: '%(asctime)s - %(name)s - %(levelname)s - %(filename)s:%(lineno)d - %(message)s'handlers:  console:    class: logging.StreamHandler    level: INFO    formatter: simple    stream: ext://sys.stdout  file_app:    class: logging.handlers.RotatingFileHandler    level: DEBUG    formatter: detailed    filename: logs/app.log    maxBytes: 10485760 # 10MB    backupCount: 5  file_errors:    class: logging.handlers.RotatingFileHandler    level: ERROR    formatter: detailed    filename: logs/errors.log    maxBytes: 10485760    backupCount: 3loggers:  my_app:    level: INFO    handlers: [console, file_app]    propagate: False # 不将日志传递给父日志器(这里是root)  my_app.db:    level: DEBUG    handlers: [file_app] # 数据库日志只写入文件    propagate: False  '': # root logger    handlers: [console, file_errors]    level: WARNING

然后在代码中加载:

import logging.configimport yaml # 或者jsonwith open('logging_config.yaml', 'rt') as f:    config = yaml.safe_load(f.read())logging.config.dictConfig(config)logger = logging.getLogger('my_app')db_logger = logging.getLogger('my_app.db')logger.info("应用启动...")db_logger.debug("尝试连接数据库...")logger.error("一个严重的应用程序错误!")

通过这种方式,我可以清晰地定义不同的日志输出策略:比如所有日志都写到

app.log

,但错误日志单独写到

errors.log

,同时控制台只显示

INFO

以上的信息。这种解耦让日志配置变得非常灵活,部署时只需修改配置文件即可。

处理日志中的异常和错误,有哪些最佳实践?

处理日志中的异常和错误,这块儿我踩过不少坑,也总结了一些经验。关键在于如何让错误信息既全面又易于理解,同时避免日志系统本身成为性能瓶颈。

首先,使用

logger.exception()

来记录异常。这是我最推荐的做法。当你在

except

块中捕获到异常时,使用

logger.exception("发生了一个意料之外的错误!")

,它会自动包含完整的堆栈跟踪信息(traceback),而不需要你手动去获取

sys.exc_info()

。这比

logger.error()

强大得多,因为

logger.error()

只记录你传入的消息,不会自动附带堆栈。

import logginglogger = logging.getLogger('my_app')logger.setLevel(logging.INFO)handler = logging.StreamHandler()formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')handler.setFormatter(formatter)logger.addHandler(handler)def divide(a, b):    try:        result = a / b        logger.info(f"计算结果: {result}")        return result    except ZeroDivisionError:        logger.exception("尝试进行除零操作!") # 会自动包含堆栈信息    except Exception as e:        logger.error(f"发生未知错误: {e}", exc_info=True) # 也可以手动传入exc_info=Truedivide(10, 2)divide(10, 0)

注意,

logger.exception()

的级别是

ERROR

,所以它会按照

ERROR

级别进行处理。

其次,提供足够的上下文信息。一个错误日志如果只有“发生错误”,那几乎是没用的。在记录错误时,尽可能地包含导致错误发生的上下文数据,比如用户ID、请求参数、操作对象等。

logging

模块的

extra

参数就是为此而生。

user_id = 123request_data = {'item_id': 456, 'quantity': 0}try:    # 模拟一个业务逻辑错误    if request_data['quantity'] <= 0:        raise ValueError("购买数量必须大于0")except ValueError as e:    logger.error("处理订单失败", extra={'user_id': user_id, 'request_data': request_data})

虽然默认的Formatter不会自动显示

extra

信息,但你可以自定义Formatter来解析并显示这些信息,或者在进行结构化日志(如JSON格式)时,这些

extra

数据会非常有用。

提到结构化日志,这在现代微服务架构和日志分析系统中变得越来越重要。将日志输出为JSON格式,可以方便地被ELK Stack(Elasticsearch, Logstash, Kibana)或Splunk等工具解析和查询。你可以自定义一个

json.Formatter

,或者使用像

python-json-logger

这样的第三方库。

# 假设使用一个简单的JSON formatterimport jsonclass JsonFormatter(logging.Formatter):    def format(self, record):        log_entry = {            "timestamp": self.formatTime(record, self.datefmt),            "level": record.levelname,            "logger": record.name,            "message": record.getMessage(),            "filename": record.filename,            "lineno": record.lineno,        }        if record.exc_info:            log_entry["exc_info"] = self.formatException(record.exc_info)        # 合并extra数据        for key, value in record.__dict__.items():            if key not in log_entry and not key.startswith('_'): # 避免内部属性                log_entry[key] = value        return json.dumps(log_entry, ensure_ascii=False)json_handler = logging.StreamHandler()json_handler.setFormatter(JsonFormatter())logger.addHandler(json_handler)logger.info("这是一个普通事件", extra={'user_agent': 'Mozilla/5.0'})try:    1 / 0except ZeroDivisionError:    logger.exception("除零错误发生!")

这样,每条日志都是一个独立的JSON对象,机器可读性极高,便于后续的日志聚合、搜索和分析。

最后,要考虑日志的量级和告警机制。不是所有的错误都需要立即人工干预。对于一些可预期的、低频率的错误,记录下来以备分析即可。但对于关键业务流程的错误或高频率的异常,可能需要集成告警系统(如通过邮件、短信、钉钉等)。

logging

模块本身不提供告警功能,但你可以编写自定义的

Handler

来触发这些外部服务。同时,要警惕“日志洪水”(log flood),特别是当某个错误在短时间内大量发生时,过多的日志输出会迅速耗尽磁盘空间,并影响应用性能。这时可以考虑使用

logging.handlers.MemoryHandler

或自行实现一些日志限流的逻辑,避免重复的错误消息淹没真正的关键信息。

以上就是Python中的日志模块(logging)如何配置和使用?的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1370021.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
如何在Keras回调函数中获取model.fit参数值
上一篇 2025年12月14日 10:10:15
如何使用Python进行数据可视化(Matplotlib, Seaborn基础)?
下一篇 2025年12月14日 10:10:21

相关推荐

  • composer require-dev和require有什么不同_Composer Require与Require-Dev区别解析

    require用于声明项目运行必需的依赖,如框架、数据库组件和第三方SDK,这些包会随项目部署到生产环境;2. require-dev用于声明仅在开发和测试阶段需要的工具,如PHPUnit、PHPStan、Faker等,不会默认部署到生产环境;3. 安装时composer install根据环境决定…

    2026年5月10日
    1000
  • 修复Django电商项目中AJAX过滤产品列表图片不显示问题

    在Django电商项目中,当使用AJAX动态加载过滤后的产品列表时,常遇到图片无法正常显示的问题。这通常是由于前端模板中图片加载方式(如data-setbg属性结合JavaScript库)与AJAX动态内容更新机制不兼容所致。解决方案是直接在AJAX返回的HTML中使用标准的标签来渲染图片,确保浏览…

    2026年5月10日
    700
  • 开源免费PHP工具 PHP开发效率提升利器

    推荐开源免费PHP开发工具以提升效率:VS Code、Sublime Text轻量高效,PhpStorm专业强大;调试用Xdebug、Kint、Ray;依赖管理选Composer;代码质量工具包括PHPStan、Psalm、PHP_CodeSniffer;数据库管理可用%ignore_a_1%MyA…

    2026年5月10日
    000
  • Matplotlib 地图中多类型图例的创建与优化

    Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化

    本教程旨在解决matplotlib地图可视化中,如何在一个图例中同时展示颜色块(如区域分类)和自定义标记(如特定兴趣点)的问题。文章详细介绍了当传统`patch`对象无法正确显示标记时,如何利用`matplotlib.lines.line2d`创建标记图例句柄,并将其与颜色块图例句柄合并,从而生成一…

    2026年5月10日 用户投稿
    900
  • Golang JSON序列化:控制敏感字段暴露的最佳实践

    本教程探讨golang中如何高效控制结构体字段在json序列化时的可见性。当需要将包含敏感信息的结构体数组转换为json响应时,通过利用`encoding/json`包提供的结构体标签,特别是`json:”-“`,可以轻松实现对特定字段的忽略,从而避免敏感数据泄露,确保api…

    2026年5月10日
    300
  • 利用海象运算符简化条件赋值:Python教程与最佳实践

    本文旨在探讨Python中海象运算符(:=)在条件赋值场景下的应用。通过对比传统if/else语句与海象运算符,以及条件表达式,分析海象运算符在简化代码、提高可读性方面的优势与局限性。并通过具体示例,展示如何在列表推导式等场景下合理使用海象运算符,同时强调其潜在的复杂性及替代方案,帮助开发者更好地掌…

    2026年5月10日
    300
  • Debian syslog性能优化技巧有哪些

    提升Debian系统syslog (通常基于rsyslog)性能,关键在于精简配置和高效处理日志。以下策略能有效优化日志管理,提升系统整体性能: 精简配置,高效加载: 在rsyslog配置文件中,仅加载必要的输入、输出和解析模块。 使用全局指令设置日志级别和格式,避免不必要的处理。 自定义模板: 创…

    2026年5月10日
    000
  • 比特币新手教程 比特币交易平台有哪些

    比特币是一种去中心化的数字货币,基于区块链技术实现点对点交易,具有匿名性、有限发行和不可篡改等特点;新手可通过交易所购买,P2P交易获得比特币,常用平台包括Binance、OKX和Huobi;交易流程包括注册账户、实名认证、绑定支付方式、充值法币并下单购买,可选择市价单或限价单;比特币存储方式有交易…

    2026年5月10日
    000
  • c++中的SFINAE技术是什么_c++模板编程中的SFINAE原理与应用

    SFINAE 是“替换失败不是错误”的原则,指模板实例化时若参数替换导致错误,只要存在其他合法候选,编译器不报错而是继续重载决议。它用于条件启用模板、类型检测等场景,如通过 decltype 或 enable_if 控制函数重载,实现类型特征判断。尽管 C++20 引入 Concepts 简化了部分…

    2026年5月10日
    000
  • 如何让动态追加元素的类事件生效?

    如何在追加元素后使其绑定类事件生效 在页面中引入三方 JavaScript 类并通过添加相应 class 来调用事件方法是一种常见的做法。然而,如果通过 JavaScript 追加标签元素,即使添加了对应的 class,事件也可能无法生效。 为了解决这个问题,可以尝试以下步骤: 检查追加的标签是否为…

    2026年5月10日
    000
  • Go语言mgo查询构建:深入理解bson.M与日期范围查询的正确实践

    本文旨在解决go语言mgo库中构建复杂查询时,特别是涉及嵌套`bson.m`和日期范围筛选的常见错误。我们将深入剖析`bson.m`的类型特性,解释为何直接索引`interface{}`会导致“invalid operation”错误,并提供一种推荐的、结构清晰的代码重构方案,以确保查询条件能够正确…

    2026年5月10日
    100
  • RichHandler与Rich Progress集成:解决显示冲突的教程

    在使用rich库的`richhandler`进行日志输出并同时使用`progress`组件时,可能会遇到显示错乱或溢出问题。这通常是由于为`richhandler`和`progress`分别创建了独立的`console`实例导致的。解决方案是确保日志处理器和进度条组件共享同一个`console`实例…

    2026年5月10日
    300
  • 理解编程指令:当结果正确,但实现方式不符要求时

    本文探讨了在编程实践中,即使程序输出了正确的结果,但若其实现方式未能严格遵循既定指令,仍可能被视为“不正确”的问题。我们将通过具体示例,对比直接求和与累加求和两种实现策略,强调理解和遵守编程规范的重要性,以确保代码的健壮性、可维护性及符合项目要求。 在软件开发过程中,我们经常会遇到这样的情况:编写的…

    2026年5月10日
    000
  • Golang goroutine与channel调试技巧

    使用go run -race检测数据竞争,结合runtime.NumGoroutine监控协程数量,通过pprof分析阻塞调用栈,利用select超时避免永久阻塞,有效排查goroutine泄漏、死锁和数据竞争问题。 Go语言的goroutine和channel是并发编程的核心,但它们也带来了调试上…

    2026年5月10日
    000
  • 使用 Jupyter Notebook 进行探索性数据分析

    Jupyter Notebook通过单元格实现代码与Markdown结合,支持数据导入(pandas)、清洗(fillna)、探索(matplotlib/seaborn可视化)、统计分析(describe/corr)和特征工程,便于记录与分享分析过程。 Jupyter Notebook 是进行探索性…

    2026年5月10日
    000
  • 《魔兽世界》将于6月11日开启国服回归技术测试

    《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试《魔兽世界》将于6月11日开启国服回归技术测试

    《%ign%ignore_a_1%re_a_1%》官方宣布,将于6月11日开启国服回归技术测试,时间为7天,并称可以在6月内正式开服,玩家们可以访问官网下载战网客户端并预下载“巫妖王之怒”客户端,技术测试详情见下图。 WordAi WordAI是一个AI驱动的内容重写平台 53 查看详情 以上就是《…

    2026年5月10日 用户投稿
    400
  • 如何在HTML中插入表单元素_HTML表单控件与输入类型使用指南

    HTML表单通过标签构建,包含action和method属性定义数据提交目标与方式,常用input类型如text、password、email等适配不同输入需求,配合label、required、placeholder提升可用性,结合textarea、select、button等控件实现完整交互,是…

    2026年5月10日
    300
  • 前端缓存策略与JavaScript存储管理

    根据数据特性选择合适的存储方式并制定清晰的读写与清理逻辑,能显著提升前端性能;合理运用Cookie、localStorage、sessionStorage、IndexedDB及Cache API,结合缓存策略与定期清理机制,可在保证用户体验的同时避免安全与性能隐患。 前端缓存和JavaScript存…

    2026年5月10日
    200
  • 网站标题关键词更新后,搜索引擎为何仍显示旧标题?

    网站标题更新后,搜索引擎为何显示旧标题? 网站SEO优化中,站长常修改网站标题关键词,期望搜索结果显示自定义标题。然而,即使更新标签、meta keywords、meta description和结构化数据中的name属性后,搜索结果仍显示旧标题,这令人费解。本文将对此进行解释。 问题:站长修改了网…

    2026年5月10日
    300
  • HTML5网页如何实现手势操作 HTML5网页移动端交互的处理技巧

    首先利用原生touch事件实现滑动判断,再通过preventDefault解决滚动冲突,接着引入Hammer.js处理复杂手势,最后通过优化点击区域、避免事件冲突和增加视觉反馈提升体验。 在移动端浏览器中,HTML5网页可以通过触摸事件实现手势操作,提升用户体验。虽然原生JavaScript提供了基…

    2026年5月10日
    000

发表回复

登录后才能评论
关注微信