Python日志增强：上下文信息的三种实现策略
14 浏览量
更新于2024-08-29
收藏 82KB PDF 举报
在Python中，日志记录是软件开发中的重要环节，特别是在处理复杂系统的信息追踪和调试时。在标准的日志记录过程中，我们通常会关注消息本身（msg），但有时需要附加额外的上下文信息以提供更丰富的日志细节。本文将探讨三种方法来向日志输出中添加上下文信息：
1. 通过`extra`参数传递：
在调用`logging`模块的记录方法（如`debug`、`info`等）时，可以使用`extra`参数携带额外的数据。例如，通过定义一个字典`extra_dict`存储客户端的IP地址和用户名，然后在日志记录时作为`extra`参数传入。这样，这些额外的信息会被合并到日志输出中，如示例所示：
```python
extra_dict = {"ip": "113.208.78.29", "username": "Petter"}
logger.debug("UserLogin!", extra=extra_dict)
```
这种方法的优点是直观，但缺点是每次调用日志记录方法都需要显式地提供`extra`，且如果formatter格式中未包含这些键，会引发错误。
2. 使用`LoggerAdapter`：
`LoggerAdapter`是Python logging模块提供的一种高级功能，它允许你在不改变现有logger的情况下，动态地修改或添加额外的上下文信息。这通过继承自`logging.LoggerAdapter`类并覆盖其`process`方法来实现。这种方式更灵活，但代码可能会稍微复杂一些。
3. 使用`Filters`：
`Filters`允许你根据某些条件过滤日志记录。虽然它们主要用于基于日志级别、线程、模块名等条件过滤，但理论上也可以用于添加额外上下文。不过，这通常不是最直接的方法，因为它们主要关注的是过滤而不是提供额外数据。
综合来看，如果你需要频繁地添加上下文信息并且希望代码简洁，建议使用`extra`参数传递。而当需要在多个上下文中切换或进行更复杂的逻辑操作时，`LoggerAdapter`可能更适合。使用`Filters`的情况较少见，通常适用于特定的过滤需求。选择哪种方法取决于具体的应用场景和需求。
Python向日志输出中添加上下文信息向日志输出中添加上下文信息
除了传递给日志记录函数的参数（如msg）外，有时候我们还想在日志输出中包含一些额外的上下文信息。比如，在一个网络
应用中，可能希望在日志中记录客户端的特定信息，如：远程客户端的IP地址和用户名。这里我们来介绍以下几种实现方式：
通过向日志记录函数传递一个extra参数引入上下文信息
使用LoggerAdapters引入上下文信息
使用Filters引入上下文信息
一、通过向日志记录函数传递一个一、通过向日志记录函数传递一个extra参数引入上下文信息参数引入上下文信息
前面我们提到过，可以通过向日志记录函数传递一个extra参数来实现向日志输出中添加额外的上下文信息，如：
import logging
import sys
fmt = logging.Formatter("%(asctime)s - %(name)s - %(ip)s - %(username)s - %(message)s")
h_console = logging.StreamHandler(sys.stdout)
h_console.setFormatter(fmt)
logger = logging.getLogger("myPro")
logger.setLevel(logging.DEBUG)
logger.addHandler(h_console)
extra_dict = {"ip": "113.208.78.29", "username": "Petter"}
logger.debug("User Login!", extra=extra_dict)
extra_dict = {"ip": "223.190.65.139", "username": "Jerry"}
logger.info("User Access!", extra=extra_dict)
输出：
2017-05-14 15:47:25,562 – myPro – 113.208.78.29 – Petter – User Login!
2017-05-14 15:47:25,562 – myPro – 223.190.65.139 – Jerry – User Access!
但是用这种方式来传递信息并不是那么方便，因为每次调用日志记录方法都要传递一个extra关键词参数。即便没有需要插入
的上下文信息也是如此，因为该logger设置的formatter格式中指定的字段必须要存在。所以，我们推荐使用下面两种方式来实
现上下文信息的引入。
也许可以尝试在每次创建连接时都创建一个Logger实例来解决上面存在的问题，但是这显然不是一个好的解决方案，因为这
些Logger实例并不会进行垃圾回收。尽管这在实践中不是个问题，但是当Logger数量变得不可控将会非常难以管理。
二、使用二、使用LoggerAdapters引入上下文信息引入上下文信息
使用LoggerAdapter类来传递上下文信息到日志事件的信息中是一个非常简单的方式，可以把它看做第一种实现方式的优化
版–因为它为extra提供了一个默认值。这个类设计的类似于Logger，因此我们可以像使用Logger类的实例那样来调用debug(),
info(), warning(),error(), exception(), critical()和log()方法。当创建一个LoggerAdapter的实例时，我们需要传递一个Logger实
例和一个包含上下文信息的类字典对象给该类的实例构建方法。当调用LoggerAdapter实例的一个日志记录方法时，该方法会
在对日志日志消息和字典对象进行处理后，调用构建该实例时传递给该实例的logger对象的同名的日志记录方法。下面是
LoggerAdapter类中几个方法的定义：
class LoggerAdapter(object):
"""
An adapter for loggers which makes it easier to specify contextual
information in logging output.
"""
def __init__(self, logger, extra):
"""
Initialize the adapter with a logger and a dict-like object which
provides contextual information. This constructor signature allows
easy stacking of LoggerAdapters, if so desired.
You can effectively pass keyword arguments as shown in the
following example:
adapter = LoggerAdapter(someLogger, dict(p1=v1, p2="v2"))
"""
self.logger = logger
self.extra = extra
def process(self, msg, kwargs):
"""
Process the logging message and keyword arguments passed in to
a logging call to insert contextual information. You can either
manipulate the message itself, the keyword args or both. Return
the message and kwargs modified (or not) to suit your needs.
Normally, you'll only need to override this one method in a
LoggerAdapter subclass for your specific needs.
"""
kwargs["extra"] = self.extra
return msg, kwargs
下载后可阅读完整内容，剩余3页未读，立即下载
2019-08-10 上传
2019-08-10 上传
点击了解资源详情
2018-12-25 上传
点击了解资源详情
点击了解资源详情
点击了解资源详情
点击了解资源详情
点击了解资源详情
weixin_38545485
- 粉丝: 5
- 资源: 983
我的内容管理
展开
最新资源
- MATLAB新功能：Multi-frame ViewRGB制作彩色图阴影
- XKCD Substitutions 3-crx插件：创新的网页文字替换工具
- Python实现8位等离子效果开源项目plasma.py解读
- 维护商店移动应用：基于PhoneGap的移动API应用
- Laravel-Admin的Redis Manager扩展使用教程
- Jekyll代理主题使用指南及文件结构解析
- cPanel中PHP多版本插件的安装与配置指南
- 深入探讨React和Typescript在Alias kopio游戏中的应用
- node.js OSC服务器实现：Gibber消息转换技术解析
- 体验最新升级版的mdbootstrap pro 6.1.0组件库
- 超市盘点过机系统实现与delphi应用
- Boogle: 探索 Python 编程的 Boggle 仿制品
- C++实现的Physics2D简易2D物理模拟
- 傅里叶级数在分数阶微分积分计算中的应用与实现
- Windows Phone与PhoneGap应用隔离存储文件访问方法
- iso8601-interval-recurrence：掌握ISO8601日期范围与重复间隔检查
