Flask使用自定义logging格式时报Formatting field not found in record错误

Flask 在执行 app = Flask(__name__) 实例化应用时，就会提前完成 app.logger 的初始化，绑定默认日志处理器并使用默认日志格式。logging.basicConfig() 仅对配置调用之后新创建的日志实例生效，不会修改已经存在的 app.logger 配置。你定义的带 endpt 字段的自定义格式没有覆盖到 app.logger 的默认处理器，当日志输出时，默认处理器尝试解析不存在的 endpt 字段，就会抛出对应异常。
纯Python代码可以正常运行，是因为你在创建任何日志实例前就调用了 logging.basicConfig()，所有日志实例都会继承自定义格式，不存在字段缺失问题。

以下三种方案任选其一即可：

方案1：先配置日志，再实例化Flask #

确保在 Flask 实例化前完成日志基础配置，让 app.logger 初始化时直接继承你的自定义配置：

import logging
from flask import Flask

# 先配置日志
FORMAT = '%(asctime)s, %(endpt)s, %(message)s'
LOG_ENDPT = 'endpoint was reached'
logging.basicConfig(filename="app.log", format=FORMAT, level=logging.DEBUG)

# 再实例化Flask应用
app = Flask(__name__)

@app.route("/status")
def status():
  app.logger.debug(LOG_ENDPT, extra={'endpt':'status'})
  return "ok"

if __name__ == "__main__":
  app.run()

方案2：清空Flask默认日志处理器后再配置 #

如果需要先实例化Flask，可以先清空默认绑定的处理器，再调用日志配置：

from flask import Flask
import logging

app = Flask(__name__)
# 清空Flask默认添加的日志处理器
app.logger.handlers.clear()

FORMAT = '%(asctime)s, %(endpt)s, %(message)s'
LOG_ENDPT = 'endpoint was reached'
logging.basicConfig(filename="app.log", format=FORMAT, level=logging.DEBUG)

@app.route("/status")
def status():
  app.logger.debug(LOG_ENDPT, extra={'endpt':'status'})
  return "ok"

if __name__ == "__main__":
  app.run()

方案3：直接修改默认处理器的格式 #

如果你需要保留Flask默认的日志输出规则，仅修改日志格式，可以直接更新已有处理器的格式化配置：

from flask import Flask
import logging

app = Flask(__name__)
FORMAT = '%(asctime)s, %(endpt)s, %(message)s'
LOG_ENDPT = 'endpoint was reached'

# 遍历修改所有已有处理器的格式
for handler in app.logger.handlers:
    handler.setFormatter(logging.Formatter(FORMAT))
# 设置日志级别
app.logger.setLevel(logging.DEBUG)

@app.route("/status")
def status():
  app.logger.debug(LOG_ENDPT, extra={'endpt':'status'})
  return "ok"

if __name__ == "__main__":
  app.run()

内容的提问来源于stack exchange，提问作者Christopher Biessener