python 日志配置方案

原创

鱼弦CTO 2024-07-22 16:45:53 博主文章分类：基础 ©著作权

文章标签 日志记录 Python 日志管理 文章分类 Python 后端开发 私藏项目实操分享

©著作权归作者所有：来自51CTO博客作者鱼弦CTO的原创作品，请联系作者获取转载授权，否则将追究法律责任

介绍

在软件开发过程中，日志记录是一个关键的部分。它能帮助开发者调试代码、监控应用程序运行状态、捕捉异常以及审计用户行为。在 Python 中，logging 模块提供了一个灵活且强大的日志记录系统。

应用使用场景

调试：在开发阶段，用于记录和跟踪代码执行过程中的信息。
错误检测：捕捉和记录异常及错误信息，以便于问题排查。
性能监控：记录应用的性能指标，如时间消耗、资源使用情况等。
用户行为审计：追踪和记录用户操作，满足合规要求。
系统运维：监控系统运行状态，及时发现并解决潜在问题。

原理解释

Python 的 logging 模块基于四个核心组件：

Logger：记录生成器，负责产生日志记录。
Handler：处理器，决定日志记录的发送位置，如文件、控制台等。
Formatter：格式化器，定义日志记录的输出格式。
Filter：过滤器，提供更细粒度的控制，决定哪些日志记录应该被输出。

这些组件通过配置文件或编程接口组合在一起，实现灵活的日志记录功能。

算法原理流程图

graph TD;
    A[Logger] --> B[Handler];
    B --> C[Formatter];
    B --> D[Filter];

算法原理解释

Logger 生成日志记录对象，并传递给 Handler。
Handler 决定日志记录的输出目标（如文件、控制台）。
Formatter 定义日志记录的具体输出格式。
Filter 对日志记录进行过滤，决定哪些记录需要被输出。

应用场景代码示例实现

简单日志配置示例

import logging

# 创建 logger
logger = logging.getLogger('example_logger')
logger.setLevel(logging.DEBUG)

# 创建 console handler 和 文件 handler
console_handler = logging.StreamHandler()
file_handler = logging.FileHandler('example.log')

# 设置日志级别
console_handler.setLevel(logging.WARNING)
file_handler.setLevel(logging.ERROR)

# 创建 formatter 并添加到 handlers
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

# 添加 handlers 到 logger
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 生成日志记录
logger.debug('This is a debug message')
('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

使用配置文件方式

# logging.yaml
version: 1
formatters:
  simple:
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'

handlers:
  console:
    class: logging.StreamHandler
    level: WARNING
    formatter: simple
    stream: ext://sys.stdout
  
  file:
    class: logging.FileHandler
    level: ERROR
    formatter: simple
    filename: example.log

loggers:
  example_logger:
    level: DEBUG
    handlers: [console, file]

root:
  level: NOTSET
  handlers: [console]

import logging.config
import yaml

with open('logging.yaml', 'r') as f:
    config = yaml.safe_load(f.read())

logging.config.dictConfig(config)

logger = logging.getLogger('example_logger')

logger.debug('This is a debug message')
('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')