Flask logging 自定义|极客笔记

Flask logging 自定义

1. 简介

Flask 是一个轻量级的 Python web 框架，具有灵活性和易扩展性，它提供了简单易用的 API 来构建 Web 应用程序。在开发 Web 应用程序时，日志记录是至关重要的功能，可以帮助开发人员跟踪应用程序的运行状态，识别错误和问题，并更好地优化代码。

Flask 默认提供了一个基本的日志系统，可以通过调用 app.logger 对象来记录日志。但是，有时候我们需要定制化我们的日志系统，以满足特定的需求。在本文中，我们将探讨如何在 Flask 中自定义日志记录系统。

2. 使用 Flask-Logging 库

Flask-Logging 是一个 Flask 扩展，它提供了更灵活的配置选项和日志记录功能。首先，我们需要安装 Flask-Logging 扩展：

pip install Flask-Logging

然后，我们需要在 Flask 应用程序初始化时配置日志系统。我们可以通过创建一个配置文件或在 Flask 应用程序实例化时传递配置参数来实现：

from flask import Flask
from flask_logging import default_config

app = Flask(__name__)
app.config.from_mapping(default_config)

# 自定义日志级别
app.config['LOG_LEVEL'] = 'DEBUG'
# 自定义日志格式
app.config['LOG_FORMAT'] = '[%(asctime)s] %(levelname)s in %(module)s: %(message)s'
# 自定义日志文件
app.config['LOG_FILE'] = 'app.log'

上面的代码示例中，我们导入了 default_config 方法，并将其传递给 app.config.from_mapping 方法来加载默认配置。然后我们可以对日志级别、格式和文件路径进行自定义设置。

3. 自定义日志记录器

在 Flask 中，我们可以通过继承 logging.Logger 类来创建自定义的日志记录器，并在 Flask 应用程序中使用它：

import logging

class CustomLogger(logging.Logger):
    def __init__(self, name, level=logging.NOTSET):
        super(CustomLogger, self).__init__(name, level)

        self.addHandler(logging.FileHandler('custom.log'))

app.logger = CustomLogger(__name__)

在这个示例中，我们创建了一个名为 CustomLogger 的自定义日志记录器，它继承自 logging.Logger 类。我们通过重写 __init__ 方法来添加一个文件处理器，用于将日志记录到 custom.log 文件中。

4. 自定义处理器和格式化器

除了自定义日志记录器外，我们还可以自定义处理器和格式化器来满足不同的需求。处理器可以决定将日志记录发送到哪里，格式化器可以定义日志的格式。

class CustomHandler(logging.Handler):
    def emit(self, record):
        log_entry = self.format(record)
        # 自定义处理逻辑
        print(log_entry)

class CustomFormatter(logging.Formatter):
    def format(self, record):
        formatted_message = super(CustomFormatter, self).format(record)
        return f'[CUSTOM] {formatted_message}'

handler = CustomHandler()
handler.setFormatter(CustomFormatter())
app.logger.addHandler(handler)

在上面的示例中，我们创建了一个名为 CustomHandler 的自定义处理器，它继承自 logging.Handler 类，并重写了 emit 方法来处理日志记录。我们还创建了一个名为 CustomFormatter 的自定义格式化器，它继承自 logging.Formatter 类，并重写了 format 方法来自定义格式。

最后，我们将自定义处理器添加到 Flask 应用程序的日志记录器中。

5. 测试日志系统

现在我们已经自定义了日志记录器、处理器和格式化器，让我们看看它们在实际应用中的表现。

@app.route('/')
def index():
    app.logger.debug('Debug message')
    app.logger.info('Info message')
    app.logger.warning('Warning message')
    app.logger.error('Error message')
    app.logger.critical('Critical message')

    return 'Hello, World!'

在上面的示例中，我们定义了一个简单的 Flask 路由，每次请求都会记录不同级别的日志消息。启动应用程序并访问路由后，你可以查看日志文件或控制台输出，查看不同级别的日志消息。