日志

Flask 使用标准 Python logging 。所有与 Flask 相关的消息都用 app.logger 来记录,其名称与 app.name 相同。这个日志记录器也可用于你自己的 的日志记录。

  1. @app.route('/login', methods=['POST'])
  2. def login():
  3. user = get_user(request.form['username'])
  4. if user.check_password(request.form['password']):
  5. login_user(user)
  6. app.logger.info('%s logged in successfully', user.username)
  7. return redirect(url_for('index'))
  8. else:
  9. app.logger.info('%s failed to log in', user.username)
  10. abort(401)

如果您没有配置日志, Python 的默认日志级别一般是“ warning ”。低于配置 的日志级别的日志是不可见的。

基本配置

当想要为项目配置日志时,应当在程序启动时尽早进行配置。如果晚了,那么 app.logger 就会成为缺省记录器。如果有可能 的话,应当在创建应用对象之前配置日志。

这个例子使用 dictConfig() 来创建一个类似于 Flask 缺省配置的日志记录配置:

  1. from logging.config import dictConfig
  2. dictConfig({
  3. 'version': 1,
  4. 'formatters': {'default': {
  5. 'format': '[%(asctime)s] %(levelname)s in %(module)s: %(message)s',
  6. }},
  7. 'handlers': {'wsgi': {
  8. 'class': 'logging.StreamHandler',
  9. 'stream': 'ext://flask.logging.wsgi_errors_stream',
  10. 'formatter': 'default'
  11. }},
  12. 'root': {
  13. 'level': 'INFO',
  14. 'handlers': ['wsgi']
  15. }
  16. })
  17. app = Flask(__name__)

缺省配置

如果没有自己配置日志, Flask 会自动添加一个 StreamHandlerapp.logger 。 在请求过程中,它会写到由 WSGI 服务器指定的,保存在 environ['wsgi.errors'] 变量中的日志流(通常是 sys.stderr ) 中。在请求之外,则会记录到 sys.stderr

移除缺省配置

如果在操作 app.logger 之后配置日志,并且需要 移除缺省的日志记录器,可以导入并移除它:

  1. from flask.logging import default_handler
  2. app.logger.removeHandler(default_handler)

把出错信息通过电子邮件发送给管理者

当产品运行在一个远程服务器上时,可能不会经常查看日志信息。 WSGI 服务器可能 会在一个文件中记录日志消息,而你只会在当用户告诉你出错的时候才会查看日志文 件。

为了主动发现并修复错误,可以配置一个 logging.handlers.SMTPHandler ,用于在一般错误或者更高级别错误发生 时发送一封电子邮件:

  1. import logging
  2. from logging.handlers import SMTPHandler
  3. mail_handler = SMTPHandler(
  4. mailhost='127.0.0.1',
  5. fromaddr='server-error@example.com',
  6. toaddrs=['admin@example.com'],
  7. subject='Application Error'
  8. )
  9. mail_handler.setLevel(logging.ERROR)
  10. mail_handler.setFormatter(logging.Formatter(
  11. '[%(asctime)s] %(levelname)s in %(module)s: %(message)s'
  12. ))
  13. if not app.debug:
  14. app.logger.addHandler(mail_handler)

这需要在同一台服务器上拥有一个 SMTP 服务器。关于配置日志的更多内容请参阅 Python 文档。

注入请求信息

看到更多请求信息,如 IP 地址,有助调试某些错误。可以继承 logging.Formatter 来注入自己的内容,以显示在日志消息中。然后,可 以修改 Flask 缺省的日志记录器、上文所述的电子邮件日志记录器或者其他日志记 录器的格式器。:

  1. from flask import has_request_context, request
  2. from flask.logging import default_handler
  3. class RequestFormatter(logging.Formatter):
  4. def format(self, record):
  5. if has_request_context():
  6. record.url = request.url
  7. record.remote_addr = request.remote_addr
  8. else:
  9. record.url = None
  10. record.remote_addr = None
  11. return super().format(record)
  12. formatter = RequestFormatter(
  13. '[%(asctime)s] %(remote_addr)s requested %(url)s\n'
  14. '%(levelname)s in %(module)s: %(message)s'
  15. )
  16. default_handler.setFormatter(formatter)
  17. mail_handler.setFormatter(formatter)

其他库

其他库可能也会产生大量日志,而你也正好需要查看这些日志。最简单的方法是向根 记录器中添加记录器。:

  1. from flask.logging import default_handler
  2. root = logging.getLogger()
  3. root.addHandler(default_handler)
  4. root.addHandler(mail_handler)

单独配置每个记录器更好还是只配置一个根记录器更好,取决你的项目。:

  1. for logger in (
  2. app.logger,
  3. logging.getLogger('sqlalchemy'),
  4. logging.getLogger('other_package'),
  5. ):
  6. logger.addHandler(default_handler)
  7. logger.addHandler(mail_handler)

Werkzeug

Werkzeug 记录基本的请求/响应信息到 'werkzeug' 日志记录器。如果根记录器 没有配置,那么 Werkzeug 会向记录器添加一个 StreamHandler

Flask 扩展

根据情况不同,一个扩展可能会选择记录到 app.logger 或者其自己的日志记录器。具体请查阅 扩展的文档。