有没有办法将用户代理包含在错误日志中？

Question

我设置了 Flask 以在发生错误时向我发送电子邮件，但我想在该电子邮件中包含 UserAgent。那可能吗？我在The docs 中没有看到它。

编辑：链接说可以在官方文档中找到更多内容，但这不是官方文档吗？ （flask.readthedocs.org 说同样的话）

Answer 1

我在this article 深处发现了如何做到这一点。您需要设置一个新过滤器以将用户代理添加到记录中。似乎在过滤阶段，您可以使用请求对象来获取您要查找的内容。因此，您实际上并没有过滤掉任何内容，而是在日志记录中添加了更多内容。功能示例：

from flask import Flask, request

app = Flask(__name__)

if not app.debug:
    import logging
    from logging.handlers import SMTPHandler

    class ContextualFilter(logging.Filter):
        def filter(self, log_record):
            log_record.user_agent = request.user_agent
            return True

    context_provider = ContextualFilter()
    app.logger.addFilter(context_provider)
    mail_handler = SMTPHandler('127.0.0.1', 'apperror@example.com',
                    app.config['ADMINS'], 'Application failed')
    mail_handler.setFormatter(logging.Formatter("""
Message type:       %(levelname)s
Location:           %(pathname)s:%(lineno)d
Module:             %(module)s
Function:           %(funcName)s
Time:               %(asctime)s
User-Agent:         %(user_agent)s

Message:

%(message)s
"""))
    mail_handler.setLevel(logging.ERROR)
    app.logger.addHandler(mail_handler)

使用它，我能够收到发送给自己的电子邮件以获取错误日志。

Answer 2

我认为您的答案只需点击一下文档即可。查看this entry 自定义电子邮件格式。使用截取的示例代码，添加 Flask request 对象的导入。使用来自this question 的方法获取字符串本身。

from logging import Formatter
from flask import request
mail_handler.setFormatter(Formatter('''
Message type:       %(levelname)s
Location:           %(pathname)s:%(lineno)d
Module:             %(module)s
Function:           %(funcName)s
Time:               %(asctime)s
UserAgent:          %s

Message:

%(message)s
''' % flask.request.user_agent.string))

这可能并不完美（尤其是我的字符串格式化代码），但希望这篇文章能够为您指明正确的方向。