Python中怎么记录程序日志

发布时间：2021-07-05 14:56:56 作者：Leah
来源：亿速云阅读：370

# Python中怎么记录程序日志

## 引言

在软件开发过程中，日志记录是至关重要的环节。良好的日志系统能帮助开发者快速定位问题、监控程序运行状态以及分析用户行为。Python作为一门广泛使用的高级编程语言，提供了多种灵活的日志记录方案。本文将详细介绍Python中的日志记录方法，包括内置`logging`模块的使用、第三方库的选择以及最佳实践。

---

## 一、为什么需要记录日志

1. **问题诊断**：当程序出现异常时，日志能提供关键的错误上下文
2. **运行监控**：通过日志分析系统运行状态和性能指标
3. **审计追踪**：满足合规要求，记录关键操作的历史轨迹
4. **数据分析**：用户行为日志可用于后续业务分析

---

## 二、Python内置logging模块

### 2.1 基本使用方法

```python
import logging

# 基础配置
logging.basicConfig(
    level=logging.DEBUG,
    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
    filename='app.log'
)

# 记录不同级别日志
logging.debug('调试信息')
logging.info('常规信息')
logging.warning('警告信息')
logging.error('错误信息')
logging.critical('严重错误')

2.2 日志级别详解

级别	数值	使用场景
DEBUG	10	开发调试细节
INFO	20	程序正常运行信息
WARNING	30	潜在问题警告
ERROR	40	功能错误
CRITICAL	50	系统级严重错误

2.3 高级配置示例

import logging
from logging.handlers import RotatingFileHandler

logger = logging.getLogger('my_app')
logger.setLevel(logging.DEBUG)

# 创建处理器
console_handler = logging.StreamHandler()
file_handler = RotatingFileHandler(
    'app.log', maxBytes=1024*1024, backupCount=5
)

# 设置格式
formatter = logging.Formatter(
    '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
)
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

# 添加处理器
logger.addHandler(console_handler)
logger.addHandler(file_handler)

三、结构化日志记录

现代日志系统推荐使用结构化格式（如JSON）以便后续处理：

import logging
import json
from pythonjsonlogger import jsonlogger

logger = logging.getLogger()

formatter = jsonlogger.JsonFormatter(
    '%(asctime)s %(name)s %(levelname)s %(message)s'
)

handler = logging.StreamHandler()
handler.setFormatter(formatter)
logger.addHandler(handler)

logger.info('用户登录', extra={
    'user_id': 12345,
    'ip': '192.168.1.1',
    'browser': 'Chrome'
})

四、第三方日志库推荐

4.1 Loguru

from loguru import logger

logger.add("file_{time}.log", rotation="500 MB")

logger.debug("优雅的日志记录")
logger.error("自动包含堆栈信息")

优点： - 更简单的API - 自动日志文件轮转 - 更好的异常处理

4.2 Structlog

import structlog

structlog.configure(
    processors=[
        structlog.processors.JSONRenderer()
    ]
)

log = structlog.get_logger()
log.info("用户操作", action="click", item_id=42)

特点： - 专注于结构化日志 - 灵活的处理器管道

五、日志记录最佳实践

合理分级：生产环境通常使用INFO级别
避免敏感信息：不要记录密码、密钥等敏感数据
上下文丰富：包含请求ID、用户ID等追踪信息

性能考量：

避免在热路径中进行字符串格式化
使用isEnabledFor检查级别

if logger.isEnabledFor(logging.DEBUG):
   logger.debug(f"耗时操作: {expensive_function()}")

日志轮转：使用RotatingFileHandler防止日志膨胀

六、分布式系统日志处理

在微服务架构中，建议： 1. 使用ELK栈（Elasticsearch+Logstash+Kibana） 2. 或采用Fluentd/Loki等现代日志收集系统 3. 为每个请求添加唯一追踪ID

import uuid
from flask import g

@app.before_request
def set_request_id():
    g.request_id = uuid.uuid4().hex
    logger.info("请求开始", request_id=g.request_id)

七、常见问题解决方案

7.1 多模块日志记录

# 主模块
logger = logging.getLogger(__name__)

# 子模块
module_logger = logging.getLogger(__name__ + '.submodule')

7.2 捕获未处理异常

import sys

def handle_exception(exc_type, exc_value, exc_traceback):
    logger.critical("未捕获异常", 
                   exc_info=(exc_type, exc_value, exc_traceback))

sys.excepthook = handle_exception

7.3 Django日志配置

# settings.py
LOGGING = {
    'version': 1,
    'handlers': {
        'file': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': 'django.log',
        },
    },
    'loggers': {
        'django': {
            'handlers': ['file'],
            'level': 'INFO',
        },
    },
}

结语

良好的日志实践是专业开发的重要标志。Python提供了从简单到复杂的多种日志解决方案，开发者应根据项目规模和要求选择合适的方案。记住：日志不是越多越好，而是要有价值、可操作且高效。

提示：定期审查日志配置，删除不再需要的调试日志，保持日志系统的整洁和有效。 “`

本文约1550字，涵盖了Python日志记录的各个方面，包括基础使用、高级技巧和最佳实践，采用Markdown格式编写，可直接用于技术文档或博客发布。