脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → python → Flask日志操作

Flask学习笔记之日志操作配置实例讲解

 更新时间：2023年11月22日 11:16:42   作者：Hunter  
这篇文章主要为大家介绍了Flask学习笔记之日志操作配置实例讲解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

引言

之前在 Django 笔记里详细介绍了 logging 模块关于 formatters，handlers，loggers 等基础介绍，这里就不做多的介绍了，详情可以直接跳转查看相应文章：Django笔记三十之log日志的记录详解

这里直接介绍如何在 Flask 中配置日志信息。

本篇笔记的代码都已经提交到 github 上，可使用下面的操作获取代码：

git clone https://github.com/x1204604036/flask_backend.git

1、日志配置

首先，我们创建一些日志输出的文件地址变量，在 config/config.py 中记录，根据环境判断来源于测试环境变量文件或者生产环境变量文件，我这里是在 development.py 中，内容如下：

LOGGING_PATH = "e:/code/log_file/flask_backend/flask.log"
LOGGING_ERROR_PATH = "e:/code/log_file/flask_backend/flask_error.log"

接着在 app/config/ 文件夹下创建一个文件 logging_config.py，内容如下：

# app/config/logging_config.py
from app.config import config
LoggingConfig = {
    "version": 1,
    "formatters": {
        "verbose": {
            "format": "%(levelname)s %(asctime)s %(filename)s %(lineno)s %(message)s",
        }
    },
    "handlers": {
        "file": {
            "level": "INFO",
            "filename": config.LOGGING_PATH,
            "formatter": "verbose",
            "class": "logging.handlers.RotatingFileHandler",
            'maxBytes': 5 * 1024 * 1024,
            'backupCount': 20,
        },
        "error_handler": {
            "level": "INFO",
            "filename": config.LOGGING_ERROR_PATH,
            "formatter": "verbose",
            "class": "logging.handlers.RotatingFileHandler",
            'maxBytes': 5 * 1024 * 1024,
            'backupCount': 20,
        },
        "email_handler": {
            "level": "WARNING",
            "class": "logging.handlers.SMTPHandler",
            "mailhost": ("smtp.163.com", 25),
            "fromaddr": "hunterxxxxx@163.com",
            "toaddrs": "120xxxx@qq.com",
            "subject": "系统error",
            "credentials": ("hunterxxxx@163.com", "JBDMVIxxxxx"),
            "timeout": 20,
        },
    },
    "root": {
        "handlers": ["file"],
        "level": "INFO",
        "propagate": True,
    },
    "loggers": {
        "error_log": {
            "handlers": ["error_handler", "email_handler"],
            "level": "INFO",
        }
    }
}

这里创建了三个 handler，两个 FileHandler 将日志以文件形式存储，一个用于发送邮件

其下，root 表示用于记录 Flask 全部信息的输出，其他的 logger 都在 loggers 下记录，在这里一个记录 error 的 logger 对应有两个 handler，一个记录日志到文件，一个发送邮件。

在 app/__init__.py 中引入日志配置：

# app/__init__.py
import logging.config
from app.config import looging_config
def create_app():
    app = Flask(__name__)
    logging.config.dictConfig(looging_config.LoggingConfig)
    return app

2、日志打印示例

这里，我们以上一节中的异常处理为例进行日志记录，将日志输出的代码都放到异常处理中，exception_handler.py 内容如下：

from werkzeug.exceptions import HTTPException
from flask import jsonify, request
import logging
import traceback
logger = logging.getLogger("error_log")
ERROR_HTTP_CODE = 417
class UserException(Exception):
    def __init__(self, code=-1, msg="error", http_code=417):
        self.code = code
        self.msg = msg
        self.http_code = http_code
def init_error_exception(app):
    @app.errorhandler(HTTPException)
    def handler_http_exception(exception):
        trace_info = traceback.format_exc()
        log_msg = "request path: %s, traceback info: %s, description: %s" % (
            request.path, trace_info, exception.description
        )
        logger.info(log_msg)
        return jsonify({"code": -1, "msg": exception.description}), exception.code
    @app.errorhandler(Exception)
    def server_exception(exception):
        logger.info("request_path: " + request.path)
        trace_info = traceback.format_exc()
        log_msg = "request path: %s, traceback info: %s" % (request.path, trace_info)
        logger.info(log_msg)
        logger.error("系统报错信息：%s" % log_msg)
        return jsonify({"code": -1, "msg": "内部错误"}), ERROR_HTTP_CODE
    @app.errorhandler(UserException)
    def user_exception(exception):
        trace_info = traceback.format_exc()
        log_msg = "request path: %s, traceback info: %s, exception msg: %s" % (
            request.path, trace_info, exception.msg
        )
        logger.info(log_msg)
        return jsonify({"code": exception.code, "msg": exception.msg}), exception.http_code

这里，我们将请求路径，报错信息等放到 log_msg 中，然后通过 logger.info() 输出，另外，这里我们还尝试对系统异常的处理发送邮件到指定邮箱。

注意：日志配置中的邮箱信息记得改成自己实际的，这里我对我的信息做了模糊处理。

重新运行系统后，尝试触发这三种报错，就可以在对应的日志文件里看到错误信息的输出了，触发了 error 的第二种 exception 异常处理还会发送邮件。

以上就是Flask学习笔记之日志操作实例讲解的详细内容，更多关于Flask日志操作配置的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • django数据关系一对多、多对多模型、自关联的建立

    django数据关系一对多、多对多模型、自关联的建立

    这篇文章主要介绍了django数据关系一对多、多对多模型、自关联的建立
    2019-07-07
  • 详解python-docx处理Word必备工具

    详解python-docx处理Word必备工具

    这篇文章主要介绍了python-docx处理Word必备工具,我主要讲讲自己用到的几个内容是怎么设置的，对python-docx处理Word的相关知识感兴趣的朋友一起看看吧
    2021-10-10
  • python读出当前时间精度到秒的代码

    python读出当前时间精度到秒的代码

    在本文里小编给各位分享了一篇关于python怎么读出当前时间精度到秒的内容，对此有需要的朋友们可以学习参考下。
    2019-07-07
  • Python2与Python3关于字符串编码处理的差别总结

    Python2与Python3关于字符串编码处理的差别总结

    这篇文章主要给大家介绍了Python2与Python3关于字符串编码处理差别的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 利用python实现后端写网页（flask框架）

    利用python实现后端写网页（flask框架）

    这篇文章主要给大家介绍了关于如何利用python实现后端写网页（flask框架）的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-02-02
  • Python减肥小工具轻松帮你瘦

    Python减肥小工具轻松帮你瘦

    今天小编就为大家分享一篇使用Python弹窗时刻提醒你减肥的小程序代码，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2021-09-09
  • Conda虚拟环境的复制和迁移的四种方法实现

    Conda虚拟环境的复制和迁移的四种方法实现

    本文主要介绍了Conda虚拟环境的复制和迁移的四种方法实现,包括requirements.txt,environment.yml,conda-pack,直接复制envs目录,各方法适用于不同场景,需根据需求选择
    2025-06-06
  • Python+OpenCV实现图像基本操作的示例详解

    Python+OpenCV实现图像基本操作的示例详解

    这篇文章主要为大家详细介绍了Python通过OpenCV实现图像的一些基本处理操作的方法，文中的示例代码简洁易懂，具有一定的参考价值，感兴趣的可以学习一下
    2023-04-04
  • python实现交并比IOU教程

    python实现交并比IOU教程

    这篇文章主要介绍了python实现交并比IOU教程，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-04-04
  • Python功能键的读取方法

    Python功能键的读取方法

    这篇文章主要介绍了Python功能键的读取方法,涉及Python键盘事件的相关操作技巧,需要的朋友可以参考下
    2015-05-05

最新评论