Ведение журнала

Flask использует стандартный Python logging. Сообщения о вашем приложении Flask записываются с помощью app.logger, который принимает то же имя, что и app.name. Этот логгер также может использоваться для записи собственных сообщений.

@app.route('/login', methods=['POST'])
def login():
    user = get_user(request.form['username'])

    if user.check_password(request.form['password']):
        login_user(user)
        app.logger.info('%s logged in successfully', user.username)
        return redirect(url_for('index'))
    else:
        app.logger.info('%s failed to log in', user.username)
        abort(401)

Основная настройка

При желании настроить ведение журнала для вашего проекта, сделайте это как можно скорее при запуске программы. Если app.logger используется до настройки ведения журнала, он добавит обработчик по умолчанию. Если возможно, настройте ведение журнала до создания объекта приложения.

В этом примере используется dictConfig() для создания конфигурации ведения журнала, аналогичной по умолчанию для Flask, за исключением всех журналов:

from logging.config import dictConfig

dictConfig({
    'version': 1,
    'formatters': {'default': {
        'format': '[%(asctime)s] %(levelname)s in %(module)s: %(message)s',
    }},
    'handlers': {'wsgi': {
        'class': 'logging.StreamHandler',
        'stream': 'ext://flask.logging.wsgi_errors_stream',
        'formatter': 'default'
    }},
    'root': {
        'level': 'INFO',
        'handlers': ['wsgi']
    }
})

app = Flask(__name__)

Настройка по умолчанию

Если вы не настраиваете ведение журнала самостоятельно, Flask автоматически добавит StreamHandler в app.logger. Во время запросов он будет записывать в поток, указанный сервером WSGI в environ['wsgi.errors'] (который обычно является sys.stderr). Вне запроса он будет записывать в sys.stderr.

Удаление обработчика по умолчанию

Если вы настроили ведение журнала после обращения к app.logger и вам нужно удалить обработчик по умолчанию, вы можете импортировать и удалить его:

from flask.logging import default_handler

app.logger.removeHandler(default_handler)

Отправка ошибок по электронной почте администраторам

При запуске приложения на удаленном сервере в рабочей среде, вы, вероятно, не будете часто просматривать сообщения журнала. Сервер WSGI, вероятно, отправит сообщения журнала в файл, и вы будете проверять этот файл только в случае, если пользователь сообщит вам о возникшей проблеме.

Чтобы активно обнаруживать и исправлять ошибки, вы можете настроить logging.handlers.SMTPHandler для отправки электронного письма при записи ошибок и более серьезных сообщений.

import logging
from logging.handlers import SMTPHandler

mail_handler = SMTPHandler(
    mailhost='127.0.0.1',
    fromaddr='server-error@example.com',
    toaddrs=['admin@example.com'],
    subject='Application Error'
)
mail_handler.setLevel(logging.ERROR)
mail_handler.setFormatter(logging.Formatter(
    '[%(asctime)s] %(levelname)s in %(module)s: %(message)s'
))

if not app.debug:
    app.logger.addHandler(mail_handler)

Для этого необходимо, чтобы на том же сервере был настроен SMTP-сервер. Более подробную информацию о настройке обработчика см. в документации Python.

Вставка информации о запросе

Дополнительная информация о запросе, например, IP-адрес, может помочь в отладке некоторых ошибок. Вы можете унаследовать от logging.Formatter, чтобы вставить свои собственные поля, которые можно использовать в сообщениях. Вы можете изменить форматер для обработчика по умолчанию Flask, обработчика электронной почты, определенного выше, или любого другого обработчика.

from flask import has_request_context, request
from flask.logging import default_handler

class RequestFormatter(logging.Formatter):
    def format(self, record):
        if has_request_context():
            record.url = request.url
            record.remote_addr = request.remote_addr
        else:
            record.url = None
            record.remote_addr = None

        return super().format(record)

formatter = RequestFormatter(
    '[%(asctime)s] %(remote_addr)s requested %(url)s\n'
    '%(levelname)s in %(module)s: %(message)s'
)
default_handler.setFormatter(formatter)
mail_handler.setFormatter(formatter)

Другие библиотеки

Другие библиотеки могут активно использовать ведение журнала, и вам также нужно видеть соответствующие сообщения из этих журналов. Самый простой способ сделать это — добавить обработчики в корневой логгер, а не только в логгер приложения.

from flask.logging import default_handler

root = logging.getLogger()
root.addHandler(default_handler)
root.addHandler(mail_handler)

В зависимости от вашего проекта, может быть полезнее настроить каждый логгер, который вас интересует, отдельно, а не только корневой логгер.

for logger in (
    app.logger,
    logging.getLogger('sqlalchemy'),
    logging.getLogger('other_package'),
):
    logger.addHandler(default_handler)
    logger.addHandler(mail_handler)

Werkzeug

Werkzeug записывает основную информацию о запросе/ответе в логгер 'werkzeug'. Если у корневого логгера нет настроенных обработчиков, Werkzeug добавляет StreamHandler в свой логгер.

Расширения Flask

В зависимости от ситуации, расширение может выбрать запись в app.logger или в собственный логгер с именем. Обратитесь к документации каждого расширения для получения подробностей.