Сборник рецептов по журналированию

Использование журналирования в нескольких модулях

Несколько вызовов logging.getLogger('someLogger') возвращают ссылку на один и тот же объект регистратора. Это верно не только в пределах одного модуля, но и для разных модулей, если они выполняются в одном процессе интерпретатора Python. Речь идёт о ссылках на один и тот же объект; кроме того, код приложения может определить и настроить родительский регистратор в одном модуле, а в другом создать дочерний регистратор (не настраивая его), и все вызовы регистратора для дочернего будут передаваться родительскому. Вот основной модуль:

import logging
import auxiliary_module

# create logger with 'spam_application'
logger = logging.getLogger('spam_application')
logger.setLevel(logging.DEBUG)
# create file handler which logs even debug messages
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# create console handler with a higher log level
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# create formatter and add it to the handlers
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)
# add the handlers to the logger
logger.addHandler(fh)
logger.addHandler(ch)

logger.info('creating an instance of auxiliary_module.Auxiliary')
a = auxiliary_module.Auxiliary()
logger.info('created an instance of auxiliary_module.Auxiliary')
logger.info('calling auxiliary_module.Auxiliary.do_something')
a.do_something()
logger.info('finished auxiliary_module.Auxiliary.do_something')
logger.info('calling auxiliary_module.some_function()')
auxiliary_module.some_function()
logger.info('done with auxiliary_module.some_function()')

А вот вспомогательный модуль:

import logging

# create logger
module_logger = logging.getLogger('spam_application.auxiliary')

class Auxiliary:
    def __init__(self):
        self.logger = logging.getLogger('spam_application.auxiliary.Auxiliary')
        self.logger.info('creating an instance of Auxiliary')

    def do_something(self):
        self.logger.info('doing something')
        a = 1 + 1
        self.logger.info('done doing something')

def some_function():
    module_logger.info('received a call to "some_function"')

Результат будет выглядеть так:

2005-03-23 23:47:11,663 - spam_application - INFO -
   creating an instance of auxiliary_module.Auxiliary
2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO -
   creating an instance of Auxiliary
2005-03-23 23:47:11,665 - spam_application - INFO -
   created an instance of auxiliary_module.Auxiliary
2005-03-23 23:47:11,668 - spam_application - INFO -
   calling auxiliary_module.Auxiliary.do_something
2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO -
   doing something
2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO -
   done doing something
2005-03-23 23:47:11,670 - spam_application - INFO -
   finished auxiliary_module.Auxiliary.do_something
2005-03-23 23:47:11,671 - spam_application - INFO -
   calling auxiliary_module.some_function()
2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO -
   received a call to 'some_function'
2005-03-23 23:47:11,673 - spam_application - INFO -
   done with auxiliary_module.some_function()

Журналирование из нескольких потоков

Для журналирования из нескольких потоков не требуется никаких специальных действий. В следующем примере показано журналирование из главного (начального) и другого потока:

import logging
import threading
import time

def worker(arg):
    while not arg['stop']:
        logging.debug('Hi from myfunc')
        time.sleep(0.5)

def main():
    logging.basicConfig(level=logging.DEBUG, format='%(relativeCreated)6d %(threadName)s %(message)s')
    info = {'stop': False}
    thread = threading.Thread(target=worker, args=(info,))
    thread.start()
    while True:
        try:
            logging.debug('Hello from main')
            time.sleep(0.75)
        except KeyboardInterrupt:
            info['stop'] = True
            break
    thread.join()

if __name__ == '__main__':
    main()

При запуске скрипт должен вывести нечто подобное:

   0 Thread-1 Hi from myfunc
   3 MainThread Hello from main
 505 Thread-1 Hi from myfunc
 755 MainThread Hello from main
1007 Thread-1 Hi from myfunc
1507 MainThread Hello from main
1508 Thread-1 Hi from myfunc
2010 Thread-1 Hi from myfunc
2258 MainThread Hello from main
2512 Thread-1 Hi from myfunc
3009 MainThread Hello from main
3013 Thread-1 Hi from myfunc
3515 Thread-1 Hi from myfunc
3761 MainThread Hello from main
4017 Thread-1 Hi from myfunc
4513 MainThread Hello from main
4518 Thread-1 Hi from myfunc

Как видно, вывод журнала перемежается ожидаемым образом. Этот подход, разумеется, работает и с большим числом потоков.

Несколько обработчиков и форматировщиков

Регистраторы — это обычные объекты Python. Метод addHandler() не устанавливает минимального или максимального ограничения на число добавляемых обработчиков. Иногда приложению полезно записывать все сообщения любого уровня серьёзности в текстовый файл, одновременно выводя ошибки и сообщения более высокого уровня в консоль. Для этого достаточно настроить соответствующие обработчики. Вызовы журналирования в коде приложения при этом останутся без изменений. Вот немного изменённый пример настройки на основе модулей:

import logging

logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)
# create file handler which logs even debug messages
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# create console handler with a higher log level
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# create formatter and add it to the handlers
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# add the handlers to logger
logger.addHandler(ch)
logger.addHandler(fh)

# 'application' code
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')

Обратите внимание: коду «приложения» не нужно учитывать наличие нескольких обработчиков. Изменилось лишь то, что был добавлен и настроен новый обработчик с именем fh.

Возможность создавать новые обработчики с фильтрами более высокого или низкого уровня серьёзности может быть очень полезна при написании и тестировании приложения. Вместо использования множества инструкций print для отладки применяйте logger.debug: в отличие от инструкций print, которые впоследствии придётся удалить или закомментировать, инструкции logger.debug могут оставаться в исходном коде и не выполнять никаких действий, пока они снова не понадобятся. Тогда для активации отладки достаточно будет изменить уровень серьёзности регистратора и/или обработчика.

Журналирование в несколько мест назначения

Предположим, вы хотите записывать сообщения в консоль и файл, используя разные форматы и условия. Например, сообщения уровня DEBUG и выше должны записываться в файл, а сообщения уровня INFO и выше — выводиться в консоль. Кроме того, в файле должны быть временные метки, а в консольных сообщениях их быть не должно. Вот как этого добиться:

import logging

# set up logging to file - see previous section for more details
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
                    datefmt='%m-%d %H:%M',
                    filename='/tmp/myapp.log',
                    filemode='w')
# define a Handler which writes INFO messages or higher to the sys.stderr
console = logging.StreamHandler()
console.setLevel(logging.INFO)
# set a format which is simpler for console use
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
# tell the handler to use this format
console.setFormatter(formatter)
# add the handler to the root logger
logging.getLogger('').addHandler(console)

# Now, we can log to the root logger, or any other logger. First the root...
logging.info('Jackdaws love my big sphinx of quartz.')

# Now, define a couple of other loggers which might represent areas in your
# application:

logger1 = logging.getLogger('myapp.area1')
logger2 = logging.getLogger('myapp.area2')

logger1.debug('Quick zephyrs blow, vexing daft Jim.')
logger1.info('How quickly daft jumping zebras vex.')
logger2.warning('Jail zesty vixen who grabbed pay from quack.')
logger2.error('The five boxing wizards jump quickly.')

После запуска в консоли вы увидите

root        : INFO     Jackdaws love my big sphinx of quartz.
myapp.area1 : INFO     How quickly daft jumping zebras vex.
myapp.area2 : WARNING  Jail zesty vixen who grabbed pay from quack.
myapp.area2 : ERROR    The five boxing wizards jump quickly.

а в файле будет примерно следующее

10-22 22:19 root         INFO     Jackdaws love my big sphinx of quartz.
10-22 22:19 myapp.area1  DEBUG    Quick zephyrs blow, vexing daft Jim.
10-22 22:19 myapp.area1  INFO     How quickly daft jumping zebras vex.
10-22 22:19 myapp.area2  WARNING  Jail zesty vixen who grabbed pay from quack.
10-22 22:19 myapp.area2  ERROR    The five boxing wizards jump quickly.

Как видно, сообщение DEBUG появляется только в файле. Остальные сообщения отправляются в оба места назначения.

В этом примере используются обработчики консоли и файла, но вы можете использовать любое число обработчиков и любые их сочетания.

Обратите внимание: выбранное выше имя файла журнала /tmp/myapp.log предполагает использование стандартного расположения временных файлов в POSIX-системах. В Windows может потребоваться выбрать для журнала другой каталог — убедитесь, что он существует и у вас есть разрешение на создание и изменение файлов в нём.

Пользовательская обработка уровней

Иногда может потребоваться обработка уровней, немного отличающаяся от стандартной: обычно обработчик обрабатывает все уровни выше заданного порога. Для этого нужно использовать фильтры. Рассмотрим сценарий, в котором требуется организовать работу следующим образом:

• Отправлять сообщения уровней серьёзности INFO и WARNING в sys.stdout
• Отправлять сообщения уровня серьёзности ERROR и выше в sys.stderr
• Отправлять сообщения уровня серьёзности DEBUG и выше в файл app.log

Предположим, вы настроили журналирование с помощью следующего JSON:

{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": {
        "simple": {
            "format": "%(levelname)-8s - %(message)s"
        }
    },
    "handlers": {
        "stdout": {
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
            "stream": "ext://sys.stdout"
        },
        "stderr": {
            "class": "logging.StreamHandler",
            "level": "ERROR",
            "formatter": "simple",
            "stream": "ext://sys.stderr"
        },
        "file": {
            "class": "logging.FileHandler",
            "formatter": "simple",
            "filename": "app.log",
            "mode": "w"
        }
    },
    "root": {
        "level": "DEBUG",
        "handlers": [
            "stderr",
            "stdout",
            "file"
        ]
    }
}

Эта конфигурация делает почти то, что нам нужно, за исключением того, что sys.stdout также будет показывать сообщения уровня серьёзности ERROR и выше, а также сообщения INFO и WARNING. Чтобы этого избежать, можно настроить фильтр, исключающий такие сообщения, и добавить его к соответствующему обработчику. Это можно сделать, добавив раздел filters на одном уровне с formatters и handlers:

{
    "filters": {
        "warnings_and_below": {
            "()" : "__main__.filter_maker",
            "level": "WARNING"
        }
    }
}

а затем изменив раздел обработчика stdout, чтобы добавить фильтр:

{
    "stdout": {
        "class": "logging.StreamHandler",
        "level": "INFO",
        "formatter": "simple",
        "stream": "ext://sys.stdout",
        "filters": ["warnings_and_below"]
    }
}

Фильтр — это всего лишь функция, поэтому можно определить filter_maker (фабричную функцию) следующим образом:

def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter

Эта функция преобразует строковый аргумент в числовой уровень и возвращает функцию, которая возвращает True, только если уровень переданной записи не выше указанного. Обратите внимание: в этом примере я определил filter_maker в тестовом скрипте main.py, который запускаю из командной строки, поэтому его модуль будет называться __main__ — отсюда и __main__.filter_maker в конфигурации фильтра. Если вы определите функцию в другом модуле, это значение нужно будет изменить.

Добавив фильтр, можно запустить main.py, полный код которого выглядит так:

import json
import logging
import logging.config

CONFIG = '''
{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": {
        "simple": {
            "format": "%(levelname)-8s - %(message)s"
        }
    },
    "filters": {
        "warnings_and_below": {
            "()" : "__main__.filter_maker",
            "level": "WARNING"
        }
    },
    "handlers": {
        "stdout": {
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
            "stream": "ext://sys.stdout",
            "filters": ["warnings_and_below"]
        },
        "stderr": {
            "class": "logging.StreamHandler",
            "level": "ERROR",
            "formatter": "simple",
            "stream": "ext://sys.stderr"
        },
        "file": {
            "class": "logging.FileHandler",
            "formatter": "simple",
            "filename": "app.log",
            "mode": "w"
        }
    },
    "root": {
        "level": "DEBUG",
        "handlers": [
            "stderr",
            "stdout",
            "file"
        ]
    }
}
'''

def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter

logging.config.dictConfig(json.loads(CONFIG))
logging.debug('A DEBUG message')
logging.info('An INFO message')
logging.warning('A WARNING message')
logging.error('An ERROR message')
logging.critical('A CRITICAL message')

После запуска таким образом:

python main.py 2>stderr.log >stdout.log

видно, что результаты соответствуют ожиданиям:

$ more *.log
::::::::::::::
app.log
::::::::::::::
DEBUG    - A DEBUG message
INFO     - An INFO message
WARNING  - A WARNING message
ERROR    - An ERROR message
CRITICAL - A CRITICAL message
::::::::::::::
stderr.log
::::::::::::::
ERROR    - An ERROR message
CRITICAL - A CRITICAL message
::::::::::::::
stdout.log
::::::::::::::
INFO     - An INFO message
WARNING  - A WARNING message

Пример сервера конфигурации

Вот пример модуля, использующего сервер конфигурации журналирования:

import logging
import logging.config
import time
import os

# read initial config file
logging.config.fileConfig('logging.conf')

# create and start listener on port 9999
t = logging.config.listen(9999)
t.start()

logger = logging.getLogger('simpleExample')

try:
    # loop through logging calls to see the difference
    # new configurations make, until Ctrl+C is pressed
    while True:
        logger.debug('debug message')
        logger.info('info message')
        logger.warning('warn message')
        logger.error('error message')
        logger.critical('critical message')
        time.sleep(5)
except KeyboardInterrupt:
    # cleanup
    logging.config.stopListening()
    t.join()

А вот скрипт, который принимает имя файла и отправляет этот файл серверу в качестве новой конфигурации журналирования, предварительно добавив его длину в двоичном формате:

#!/usr/bin/env python
import socket, sys, struct

with open(sys.argv[1], 'rb') as f:
    data_to_send = f.read()

HOST = 'localhost'
PORT = 9999
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print('connecting...')
s.connect((HOST, PORT))
print('sending config...')
s.send(struct.pack('>L', len(data_to_send)))
s.send(data_to_send)
s.close()
print('complete')

Работа с блокирующими обработчиками

Иногда необходимо, чтобы обработчики журналирования выполняли свою работу, не блокируя поток, из которого ведётся журналирование. Такое часто встречается в веб-приложениях, хотя, конечно, бывает и в других ситуациях.

Распространённый источник задержек — SMTPHandler: отправка электронной почты может занимать много времени по причинам, не зависящим от разработчика (например, из-за плохо работающей почтовой системы или сети). Однако блокировать может почти любой обработчик, использующий сеть: даже операция SocketHandler может незаметно выполнять слишком медленный запрос DNS (этот запрос может выполняться глубоко внутри библиотеки сокетов, ниже уровня Python, и вне вашего контроля).

Одно из решений — использовать подход из двух частей. В первой части к регистраторам, к которым обращаются из критичных к производительности потоков, подключается только QueueHandler. Они просто записывают сообщения в очередь, размер которой можно сделать достаточно большим или не ограничивать вовсе. Запись в очередь обычно выполняется быстро, однако на всякий случай в коде, вероятно, следует обработать исключение queue.Full. Если вы разрабатываете библиотеку, в которой есть критичные к производительности потоки, обязательно задокументируйте это (и предложите подключать к регистраторам только QueueHandlers), чтобы предупредить других разработчиков, использующих ваш код.

Вторая часть решения — это QueueListener, созданный как парный компонент к QueueHandler. Работа QueueListener очень проста: ему передаются очередь и несколько обработчиков, после чего он запускает внутренний поток, который отслеживает очередь и получает из неё записи LogRecord, отправленные через QueueHandlers (или любой другой источник LogRecords). Записи LogRecords извлекаются из очереди и передаются обработчикам для обработки.

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

Пример использования этих двух классов (импорты опущены):

que = queue.Queue(-1)  # no limit on size
queue_handler = QueueHandler(que)
handler = logging.StreamHandler()
listener = QueueListener(que, handler)
root = logging.getLogger()
root.addHandler(queue_handler)
formatter = logging.Formatter('%(threadName)s: %(message)s')
handler.setFormatter(formatter)
listener.start()
# The log output will display the thread which generated
# the event (the main thread) rather than the internal
# thread which monitors the internal queue. This is what
# you want to happen.
root.warning('Look out!')
listener.stop()

При запуске будет выведено:

MainThread: Look out!

Отправка и получение событий журналирования по сети

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

import logging, logging.handlers

rootLogger = logging.getLogger('')
rootLogger.setLevel(logging.DEBUG)
socketHandler = logging.handlers.SocketHandler('localhost',
                    logging.handlers.DEFAULT_TCP_LOGGING_PORT)
# don't bother with a formatter, since a socket handler sends the event as
# an unformatted pickle
rootLogger.addHandler(socketHandler)

# Now, we can log to the root logger, or any other logger. First the root...
logging.info('Jackdaws love my big sphinx of quartz.')

# Now, define a couple of other loggers which might represent areas in your
# application:

logger1 = logging.getLogger('myapp.area1')
logger2 = logging.getLogger('myapp.area2')

logger1.debug('Quick zephyrs blow, vexing daft Jim.')
logger1.info('How quickly daft jumping zebras vex.')
logger2.warning('Jail zesty vixen who grabbed pay from quack.')
logger2.error('The five boxing wizards jump quickly.')

На принимающей стороне можно настроить получатель с помощью модуля socketserver. Вот простой рабочий пример:

import pickle
import logging
import logging.handlers
import socketserver
import struct


class LogRecordStreamHandler(socketserver.StreamRequestHandler):
    """Handler for a streaming logging request.

    This basically logs the record using whatever logging policy is
    configured locally.
    """

    def handle(self):
        """
        Handle multiple requests - each expected to be a 4-byte length,
        followed by the LogRecord in pickle format. Logs the record
        according to whatever policy is configured locally.
        """
        while True:
            chunk = self.connection.recv(4)
            if len(chunk) < 4:
                break
            slen = struct.unpack('>L', chunk)[0]
            chunk = self.connection.recv(slen)
            while len(chunk) < slen:
                chunk = chunk + self.connection.recv(slen - len(chunk))
            obj = self.unPickle(chunk)
            record = logging.makeLogRecord(obj)
            self.handleLogRecord(record)

    def unPickle(self, data):
        return pickle.loads(data)

    def handleLogRecord(self, record):
        # if a name is specified, we use the named logger rather than the one
        # implied by the record.
        if self.server.logname is not None:
            name = self.server.logname
        else:
            name = record.name
        logger = logging.getLogger(name)
        # N.B. EVERY record gets logged. This is because Logger.handle
        # is normally called AFTER logger-level filtering. If you want
        # to do filtering, do it at the client end to save wasting
        # cycles and network bandwidth!
        logger.handle(record)

class LogRecordSocketReceiver(socketserver.ThreadingTCPServer):
    """
    Simple TCP socket-based logging receiver suitable for testing.
    """

    allow_reuse_address = True

    def __init__(self, host='localhost',
                 port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,
                 handler=LogRecordStreamHandler):
        socketserver.ThreadingTCPServer.__init__(self, (host, port), handler)
        self.abort = 0
        self.timeout = 1
        self.logname = None

    def serve_until_stopped(self):
        import select
        abort = 0
        while not abort:
            rd, wr, ex = select.select([self.socket.fileno()],
                                       [], [],
                                       self.timeout)
            if rd:
                self.handle_request()
            abort = self.abort

def main():
    logging.basicConfig(
        format='%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s')
    tcpserver = LogRecordSocketReceiver()
    print('About to start TCP server...')
    tcpserver.serve_until_stopped()

if __name__ == '__main__':
    main()

Сначала запустите сервер, а затем клиент. На стороне клиента в консоль ничего не выводится; на стороне сервера вы должны увидеть примерно следующее:

About to start TCP server...
   59 root            INFO     Jackdaws love my big sphinx of quartz.
   59 myapp.area1     DEBUG    Quick zephyrs blow, vexing daft Jim.
   69 myapp.area1     INFO     How quickly daft jumping zebras vex.
   69 myapp.area2     WARNING  Jail zesty vixen who grabbed pay from quack.
   69 myapp.area2     ERROR    The five boxing wizards jump quickly.

Обратите внимание: в некоторых сценариях использование pickle сопряжено с проблемами безопасности. Если это относится к вашему случаю, можно использовать альтернативную схему сериализации, переопределив метод makePickle() и реализовав альтернативный вариант в нём, а также адаптировав приведённый выше скрипт для использования этой схемы.

Добавление контекстной информации в вывод журнала

Иногда в вывод журнала нужно включить контекстную информацию помимо параметров, передаваемых вызову журналирования. Например, в сетевом приложении может быть полезно записывать сведения о клиенте (например, имя удалённого пользователя или IP-адрес). Для этого можно использовать параметр extra, но передавать информацию таким способом не всегда удобно. Может возникнуть соблазн создавать экземпляры Logger для каждого подключения, однако это плохая идея, поскольку такие экземпляры не удаляются сборщиком мусора. На практике это обычно не проблема, но если число экземпляров Logger зависит от требуемой детализации журналирования приложения, управлять ими может быть трудно, если число экземпляров Logger фактически не ограничено.

def debug(self, msg, /, *args, **kwargs):
    """
    Delegate a debug call to the underlying logger, after adding
    contextual information from this adapter instance.
    """
    msg, kwargs = self.process(msg, kwargs)
    self.logger.debug(msg, *args, **kwargs)

class CustomAdapter(logging.LoggerAdapter):
    """
    This example adapter expects the passed in dict-like object to have a
    'connid' key, whose value in brackets is prepended to the log message.
    """
    def process(self, msg, kwargs):
        return '[%s] %s' % (self.extra['connid'], msg), kwargs

logger = logging.getLogger(__name__)
adapter = CustomAdapter(logger, {'connid': some_conn_id})

import logging
from random import choice

class ContextFilter(logging.Filter):
    """
    This is a filter which injects contextual information into the log.

    Rather than use actual contextual information, we just use random
    data in this demo.
    """

    USERS = ['jim', 'fred', 'sheila']
    IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1']

    def filter(self, record):

        record.ip = choice(ContextFilter.IPS)
        record.user = choice(ContextFilter.USERS)
        return True

if __name__ == '__main__':
    levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)
    logging.basicConfig(level=logging.DEBUG,
                        format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s')
    a1 = logging.getLogger('a.b.c')
    a2 = logging.getLogger('d.e.f')

    f = ContextFilter()
    a1.addFilter(f)
    a2.addFilter(f)
    a1.debug('A debug message')
    a1.info('An info message with %s', 'some parameters')
    for x in range(10):
        lvl = choice(levels)
        lvlname = logging.getLevelName(lvl)
        a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters')

2010-09-06 22:38:15,292 a.b.c DEBUG    IP: 123.231.231.123 User: fred     A debug message
2010-09-06 22:38:15,300 a.b.c INFO     IP: 192.168.0.1     User: sheila   An info message with some parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f ERROR    IP: 127.0.0.1       User: jim      A message at ERROR level with 2 parameters
2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 127.0.0.1       User: sheila   A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,300 d.e.f ERROR    IP: 123.231.231.123 User: fred     A message at ERROR level with 2 parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 192.168.0.1     User: jim      A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 192.168.0.1     User: jim      A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,301 d.e.f ERROR    IP: 127.0.0.1       User: sheila   A message at ERROR level with 2 parameters
2010-09-06 22:38:15,301 d.e.f DEBUG    IP: 123.231.231.123 User: fred     A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,301 d.e.f INFO     IP: 123.231.231.123 User: fred     A message at INFO level with 2 parameters

Использование contextvars

Начиная с Python 3.7 модуль contextvars предоставляет локальное для контекста хранилище, подходящее как для обработки с помощью threading, так и для asyncio. Поэтому такое хранилище в целом может быть предпочтительнее локальных переменных потоков. В следующем примере показано, как в многопоточной среде добавлять в журналы контекстную информацию, например атрибуты запросов, обрабатываемых веб-приложениями.

Для наглядности предположим, что есть несколько веб-приложений, независимых друг от друга, но работающих в одном процессе Python и использующих общую библиотеку. Как сделать так, чтобы у каждого приложения был собственный журнал, в который направляются все сообщения журнала из библиотеки (и другого кода обработки запросов), и при этом в журнал добавлялась контекстная информация, например IP-адрес клиента, метод HTTP-запроса и имя пользователя?

Предположим, что работу библиотеки можно смоделировать следующим кодом:

# webapplib.py
import logging
import time

logger = logging.getLogger(__name__)

def useful():
    # Just a representative event logged from the library
    logger.debug('Hello from webapplib!')
    # Just sleep for a bit so other threads get to run
    time.sleep(0.01)

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

# main.py
import argparse
from contextvars import ContextVar
import logging
import os
from random import choice
import threading
import webapplib

logger = logging.getLogger(__name__)
root = logging.getLogger()
root.setLevel(logging.DEBUG)

class Request:
    """
    A simple dummy request class which just holds dummy HTTP request method,
    client IP address and client username
    """
    def __init__(self, method, ip, user):
        self.method = method
        self.ip = ip
        self.user = user

# A dummy set of requests which will be used in the simulation - we'll just pick
# from this list randomly. Note that all GET requests are from 192.168.2.XXX
# addresses, whereas POST requests are from 192.16.3.XXX addresses. Three users
# are represented in the sample requests.

REQUESTS = [
    Request('GET', '192.168.2.20', 'jim'),
    Request('POST', '192.168.3.20', 'fred'),
    Request('GET', '192.168.2.21', 'sheila'),
    Request('POST', '192.168.3.21', 'jim'),
    Request('GET', '192.168.2.22', 'fred'),
    Request('POST', '192.168.3.22', 'sheila'),
]

# Note that the format string includes references to request context information
# such as HTTP method, client IP and username

formatter = logging.Formatter('%(threadName)-11s %(appName)s %(name)-9s %(user)-6s %(ip)s %(method)-4s %(message)s')

# Create our context variables. These will be filled at the start of request
# processing, and used in the logging that happens during that processing

ctx_request = ContextVar('request')
ctx_appname = ContextVar('appname')

class InjectingFilter(logging.Filter):
    """
    A filter which injects context-specific information into logs and ensures
    that only information for a specific webapp is included in its log
    """
    def __init__(self, app):
        self.app = app

    def filter(self, record):
        request = ctx_request.get()
        record.method = request.method
        record.ip = request.ip
        record.user = request.user
        record.appName = appName = ctx_appname.get()
        return appName == self.app.name

class WebApp:
    """
    A dummy web application class which has its own handler and filter for a
    webapp-specific log.
    """
    def __init__(self, name):
        self.name = name
        handler = logging.FileHandler(name + '.log', 'w')
        f = InjectingFilter(self)
        handler.setFormatter(formatter)
        handler.addFilter(f)
        root.addHandler(handler)
        self.num_requests = 0

    def process_request(self, request):
        """
        This is the dummy method for processing a request. It's called on a
        different thread for every request. We store the context information into
        the context vars before doing anything else.
        """
        ctx_request.set(request)
        ctx_appname.set(self.name)
        self.num_requests += 1
        logger.debug('Request processing started')
        webapplib.useful()
        logger.debug('Request processing finished')

def main():
    fn = os.path.splitext(os.path.basename(__file__))[0]
    adhf = argparse.ArgumentDefaultsHelpFormatter
    ap = argparse.ArgumentParser(formatter_class=adhf, prog=fn,
                                 description='Simulate a couple of web '
                                             'applications handling some '
                                             'requests, showing how request '
                                             'context can be used to '
                                             'populate logs')
    aa = ap.add_argument
    aa('--count', '-c', type=int, default=100, help='How many requests to simulate')
    options = ap.parse_args()

    # Create the dummy webapps and put them in a list which we can use to select
    # from randomly
    app1 = WebApp('app1')
    app2 = WebApp('app2')
    apps = [app1, app2]
    threads = []
    # Add a common handler which will capture all events
    handler = logging.FileHandler('app.log', 'w')
    handler.setFormatter(formatter)
    root.addHandler(handler)

    # Generate calls to process requests
    for i in range(options.count):
        try:
            # Pick an app at random and a request for it to process
            app = choice(apps)
            request = choice(REQUESTS)
            # Process the request in its own thread
            t = threading.Thread(target=app.process_request, args=(request,))
            threads.append(t)
            t.start()
        except KeyboardInterrupt:
            break

    # Wait for the threads to terminate
    for t in threads:
        t.join()

    for app in apps:
        print('%s processed %s requests' % (app.name, app.num_requests))

if __name__ == '__main__':
    main()

Если запустить приведённый выше код, примерно половина запросов должна попасть в app1.log, а остальные — в app2.log, при этом все запросы будут записаны в app.log. В журнале каждого веб-приложения будут только записи, относящиеся к этому приложению, а информация о запросах будет отображаться согласованно (то есть сведения о каждом тестовом запросе всегда будут вместе в одной строке журнала). Это показано в следующем выводе оболочки:

~/logging-contextual-webapp$ python main.py
app1 processed 51 requests
app2 processed 49 requests
~/logging-contextual-webapp$ wc -l *.log
  153 app1.log
  147 app2.log
  300 app.log
  600 total
~/logging-contextual-webapp$ head -3 app1.log
Thread-3 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-3 (process_request) app1 webapplib jim    192.168.3.21 POST Hello from webapplib!
Thread-5 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
~/logging-contextual-webapp$ head -3 app2.log
Thread-1 (process_request) app2 __main__  sheila 192.168.2.21 GET  Request processing started
Thread-1 (process_request) app2 webapplib sheila 192.168.2.21 GET  Hello from webapplib!
Thread-2 (process_request) app2 __main__  jim    192.168.2.20 GET  Request processing started
~/logging-contextual-webapp$ head app.log
Thread-1 (process_request) app2 __main__  sheila 192.168.2.21 GET  Request processing started
Thread-1 (process_request) app2 webapplib sheila 192.168.2.21 GET  Hello from webapplib!
Thread-2 (process_request) app2 __main__  jim    192.168.2.20 GET  Request processing started
Thread-3 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-2 (process_request) app2 webapplib jim    192.168.2.20 GET  Hello from webapplib!
Thread-3 (process_request) app1 webapplib jim    192.168.3.21 POST Hello from webapplib!
Thread-4 (process_request) app2 __main__  fred   192.168.2.22 GET  Request processing started
Thread-5 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-4 (process_request) app2 webapplib fred   192.168.2.22 GET  Hello from webapplib!
Thread-6 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
~/logging-contextual-webapp$ grep app1 app1.log | wc -l
153
~/logging-contextual-webapp$ grep app2 app2.log | wc -l
147
~/logging-contextual-webapp$ grep app1 app.log | wc -l
153
~/logging-contextual-webapp$ grep app2 app.log | wc -l
147

Передача контекстной информации в обработчиках

У каждого Handler есть собственная цепочка фильтров. Если нужно добавить контекстную информацию в LogRecord, не передавая её другим обработчикам, можно использовать фильтр, который возвращает новый LogRecord, а не изменяет исходный объект на месте, как показано в следующем скрипте:

import copy
import logging

def filter(record: logging.LogRecord):
    record = copy.copy(record)
    record.user = 'jim'
    return record

if __name__ == '__main__':
    logger = logging.getLogger()
    logger.setLevel(logging.INFO)
    handler = logging.StreamHandler()
    formatter = logging.Formatter('%(message)s from %(user)-8s')
    handler.setFormatter(formatter)
    handler.addFilter(filter)
    logger.addHandler(handler)

    logger.info('A log message')

Запись в один файл из нескольких процессов

Хотя ведение журнала потокобезопасно и запись в один файл из нескольких потоков одного процесса поддерживается, запись в один файл из нескольких процессов не поддерживается, поскольку в Python нет стандартного способа сериализовать доступ к одному файлу из нескольких процессов. Если вам нужно вести запись в один файл из нескольких процессов, можно направить журналы всех процессов в SocketHandler, а в отдельном процессе запустить сервер сокетов, который будет считывать данные из сокета и записывать их в файл. (При желании для этой задачи можно выделить один поток в одном из существующих процессов.) В этом разделе этот подход описан подробнее, а также приведён работоспособный приёмник сокетов, который можно использовать как основу для адаптации в собственных приложениях.

Также можно написать собственный обработчик, который использует класс Lock из модуля multiprocessing для сериализации доступа процессов к файлу. Существующие FileHandler и его подклассы в настоящее время не используют multiprocessing, хотя в будущем это может измениться. Обратите внимание, что в настоящее время модуль multiprocessing не обеспечивает работоспособность блокировок на всех платформах (см. https://bugs.python.org/issue3770).

В качестве альтернативы можно использовать Queue и QueueHandler, чтобы отправлять все события журнала одному из процессов многопроцессного приложения. Следующий пример скрипта показывает, как это сделать: в примере отдельный процесс-приёмник ожидает события от других процессов и записывает их в соответствии с собственной конфигурацией ведения журнала. Пример демонстрирует только один из возможных способов (например, вместо отдельного процесса-приёмника можно использовать поток-приёмник — реализация будет аналогичной), но позволяет полностью независимо настраивать ведение журнала для приёмника и остальных процессов приложения. Его можно использовать как основу для кода, отвечающего вашим конкретным требованиям:

# You'll need these imports in your own code
import logging
import logging.handlers
import multiprocessing

# Next two import lines for this demo only
from random import choice, random
import time

#
# Because you'll want to define the logging configurations for listener and workers, the
# listener and worker process functions take a configurer parameter which is a callable
# for configuring logging for that process. These functions are also passed the queue,
# which they use for communication.
#
# In practice, you can configure the listener however you want, but note that in this
# simple example, the listener does not apply level or filter logic to received records.
# In practice, you would probably want to do this logic in the worker processes, to avoid
# sending events which would be filtered out between processes.
#
# The size of the rotated files is made small so you can see the results easily.
def listener_configurer():
    root = logging.getLogger()
    h = logging.handlers.RotatingFileHandler('mptest.log', 'a', 300, 10)
    f = logging.Formatter('%(asctime)s %(processName)-10s %(name)s %(levelname)-8s %(message)s')
    h.setFormatter(f)
    root.addHandler(h)

# This is the listener process top-level loop: wait for logging events
# (LogRecords)on the queue and handle them, quit when you get a None for a
# LogRecord.
def listener_process(queue, configurer):
    configurer()
    while True:
        try:
            record = queue.get()
            if record is None:  # We send this as a sentinel to tell the listener to quit.
                break
            logger = logging.getLogger(record.name)
            logger.handle(record)  # No level or filter logic applied - just do it!
        except Exception:
            import sys, traceback
            print('Whoops! Problem:', file=sys.stderr)
            traceback.print_exc(file=sys.stderr)

# Arrays used for random selections in this demo

LEVELS = [logging.DEBUG, logging.INFO, logging.WARNING,
          logging.ERROR, logging.CRITICAL]

LOGGERS = ['a.b.c', 'd.e.f']

MESSAGES = [
    'Random message #1',
    'Random message #2',
    'Random message #3',
]

# The worker configuration is done at the start of the worker process run.
# Note that on Windows you can't rely on fork semantics, so each process
# will run the logging configuration code when it starts.
def worker_configurer(queue):
    h = logging.handlers.QueueHandler(queue)  # Just the one handler needed
    root = logging.getLogger()
    root.addHandler(h)
    # send all messages, for demo; no other level or filter logic applied.
    root.setLevel(logging.DEBUG)

# This is the worker process top-level loop, which just logs ten events with
# random intervening delays before terminating.
# The print messages are just so you know it's doing something!
def worker_process(queue, configurer):
    configurer(queue)
    name = multiprocessing.current_process().name
    print('Worker started: %s' % name)
    for i in range(10):
        time.sleep(random())
        logger = logging.getLogger(choice(LOGGERS))
        level = choice(LEVELS)
        message = choice(MESSAGES)
        logger.log(level, message)
    print('Worker finished: %s' % name)

# Here's where the demo gets orchestrated. Create the queue, create and start
# the listener, create ten workers and start them, wait for them to finish,
# then send a None to the queue to tell the listener to finish.
def main():
    queue = multiprocessing.Queue(-1)
    listener = multiprocessing.Process(target=listener_process,
                                       args=(queue, listener_configurer))
    listener.start()
    workers = []
    for i in range(10):
        worker = multiprocessing.Process(target=worker_process,
                                         args=(queue, worker_configurer))
        workers.append(worker)
        worker.start()
    for w in workers:
        w.join()
    queue.put_nowait(None)
    listener.join()

if __name__ == '__main__':
    main()

В варианте приведённого выше скрипта ведение журнала остаётся в главном процессе, но выполняется в отдельном потоке:

import logging
import logging.config
import logging.handlers
from multiprocessing import Process, Queue
import random
import threading
import time

def logger_thread(q):
    while True:
        record = q.get()
        if record is None:
            break
        logger = logging.getLogger(record.name)
        logger.handle(record)


def worker_process(q):
    qh = logging.handlers.QueueHandler(q)
    root = logging.getLogger()
    root.setLevel(logging.DEBUG)
    root.addHandler(qh)
    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
              logging.CRITICAL]
    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
               'spam', 'spam.ham', 'spam.ham.eggs']
    for i in range(100):
        lvl = random.choice(levels)
        logger = logging.getLogger(random.choice(loggers))
        logger.log(lvl, 'Message no. %d', i)

if __name__ == '__main__':
    q = Queue()
    d = {
        'version': 1,
        'formatters': {
            'detailed': {
                'class': 'logging.Formatter',
                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            }
        },
        'handlers': {
            'console': {
                'class': 'logging.StreamHandler',
                'level': 'INFO',
            },
            'file': {
                'class': 'logging.FileHandler',
                'filename': 'mplog.log',
                'mode': 'w',
                'formatter': 'detailed',
            },
            'foofile': {
                'class': 'logging.FileHandler',
                'filename': 'mplog-foo.log',
                'mode': 'w',
                'formatter': 'detailed',
            },
            'errors': {
                'class': 'logging.FileHandler',
                'filename': 'mplog-errors.log',
                'mode': 'w',
                'level': 'ERROR',
                'formatter': 'detailed',
            },
        },
        'loggers': {
            'foo': {
                'handlers': ['foofile']
            }
        },
        'root': {
            'level': 'DEBUG',
            'handlers': ['console', 'file', 'errors']
        },
    }
    workers = []
    for i in range(5):
        wp = Process(target=worker_process, name='worker %d' % (i + 1), args=(q,))
        workers.append(wp)
        wp.start()
    logging.config.dictConfig(d)
    lp = threading.Thread(target=logger_thread, args=(q,))
    lp.start()
    # At this point, the main process could do some useful work of its own
    # Once it's done that, it can wait for the workers to terminate...
    for wp in workers:
        wp.join()
    # And now tell the logging thread to finish up, too
    q.put(None)
    lp.join()

Этот вариант показывает, как, например, применить конфигурацию к определённым регистраторам: у регистратора foo есть специальный обработчик, который сохраняет все события подсистемы foo в файл mplog-foo.log. Механизм ведения журнала главного процесса будет использовать эту конфигурацию (хотя события журнала создаются в рабочих процессах), чтобы направлять сообщения в соответствующие места назначения.

queue = multiprocessing.Queue(-1)

queue = multiprocessing.Manager().Queue(-1)  # also works with the examples above

workers = []
for i in range(10):
    worker = multiprocessing.Process(target=worker_process,
                                     args=(queue, worker_configurer))
    workers.append(worker)
    worker.start()
for w in workers:
    w.join()

with concurrent.futures.ProcessPoolExecutor(max_workers=10) as executor:
    for i in range(10):
        executor.submit(worker_process, queue, worker_configurer)

Ротация файлов

Иногда нужно позволить файлу журнала вырасти до определённого размера, затем открыть новый файл и продолжить запись в него. Может потребоваться хранить определённое количество таких файлов, а после создания этого количества ротировать файлы, чтобы ограничить и их число, и размер. Для этого сценария пакет logging предоставляет RotatingFileHandler:

import glob
import logging
import logging.handlers

LOG_FILENAME = 'logging_rotatingfile_example.out'

# Set up a specific logger with our desired output level
my_logger = logging.getLogger('MyLogger')
my_logger.setLevel(logging.DEBUG)

# Add the log message handler to the logger
handler = logging.handlers.RotatingFileHandler(
              LOG_FILENAME, maxBytes=20, backupCount=5)

my_logger.addHandler(handler)

# Log some messages
for i in range(20):
    my_logger.debug('i = %d' % i)

# See what files are created
logfiles = glob.glob('%s*' % LOG_FILENAME)

for filename in logfiles:
    print(filename)

В результате должны появиться 6 отдельных файлов, каждый из которых содержит часть истории журнала приложения:

logging_rotatingfile_example.out
logging_rotatingfile_example.out.1
logging_rotatingfile_example.out.2
logging_rotatingfile_example.out.3
logging_rotatingfile_example.out.4
logging_rotatingfile_example.out.5

Самый актуальный файл всегда называется logging_rotatingfile_example.out. Каждый раз, когда он достигает предельного размера, ему присваивается имя с суффиксом .1. Имена всех существующих резервных файлов меняются так, чтобы суффикс увеличился (.1 становится .2 и т. д.), а файл .6 удаляется.

Очевидно, в этом примере длина журнала для наглядности задана чрезмерно маленькой. Вам следует установить подходящее значение maxBytes.

Использование альтернативных стилей форматирования

Когда ведение журнала было добавлено в стандартную библиотеку Python, единственным способом форматировать сообщения с переменным содержимым был метод %-форматирования. С тех пор в Python появились два новых способа форматирования: string.Template (добавлен в Python 2.4) и str.format() (добавлен в Python 2.6).

Начиная с версии 3.2, ведение журнала лучше поддерживает эти два дополнительных стиля форматирования. Класс Formatter был расширен дополнительным необязательным именованным параметром style. По умолчанию он равен '%', но возможны и другие значения — '{' и '$', соответствующие двум другим стилям форматирования. Обратная совместимость сохраняется по умолчанию, как и следовало ожидать, но явное указание параметра style позволяет задавать строки формата, работающие с синтаксисом str.format() или string.Template. Возможности показаны в следующем примере сеанса консоли:

>>> import logging
>>> root = logging.getLogger()
>>> root.setLevel(logging.DEBUG)
>>> handler = logging.StreamHandler()
>>> bf = logging.Formatter('{asctime} {name} {levelname:8s} {message}',
...                        style='{')
>>> handler.setFormatter(bf)
>>> root.addHandler(handler)
>>> logger = logging.getLogger('foo.bar')
>>> logger.debug('This is a DEBUG message')
2010-10-28 15:11:55,341 foo.bar DEBUG    This is a DEBUG message
>>> logger.critical('This is a CRITICAL message')
2010-10-28 15:12:11,526 foo.bar CRITICAL This is a CRITICAL message
>>> df = logging.Formatter('$asctime $name ${levelname} $message',
...                        style='$')
>>> handler.setFormatter(df)
>>> logger.debug('This is a DEBUG message')
2010-10-28 15:13:06,924 foo.bar DEBUG This is a DEBUG message
>>> logger.critical('This is a CRITICAL message')
2010-10-28 15:13:11,494 foo.bar CRITICAL This is a CRITICAL message
>>>

Обратите внимание, что форматирование сообщений журнала для итогового вывода в журнал полностью не зависит от способа формирования отдельного сообщения. Для этого по-прежнему можно использовать %-форматирование, как показано здесь:

>>> logger.error('This is an%s %s %s', 'other,', 'ERROR,', 'message')
2010-10-28 15:19:29,833 foo.bar ERROR This is another, ERROR, message
>>>

Вызовы ведения журнала (logger.debug(), logger.info() и т. д.) принимают позиционные параметры только для самого сообщения, а именованные параметры используются лишь для задания параметров обработки вызова (например, параметр exc_info указывает, что следует записать информацию об обратной трассировке, а параметр extra — что в журнал нужно добавить дополнительную контекстную информацию). Поэтому нельзя напрямую вызывать функции ведения журнала с синтаксисом str.format() или string.Template: внутри пакет logging использует %-форматирование для объединения строки формата и переменных аргументов. Изменить это, сохранив обратную совместимость, невозможно, поскольку во всём уже существующем коде вызовы ведения журнала используют строки формата с %-форматированием.

Однако есть способ использовать форматирование {} и $ для формирования отдельных сообщений журнала. Вспомните, что в качестве строки формата сообщения можно использовать произвольный объект, а пакет logging вызовет для этого объекта str(), чтобы получить фактическую строку формата. Рассмотрим следующие два класса:

class BraceMessage:
    def __init__(self, fmt, /, *args, **kwargs):
        self.fmt = fmt
        self.args = args
        self.kwargs = kwargs

    def __str__(self):
        return self.fmt.format(*self.args, **self.kwargs)

class DollarMessage:
    def __init__(self, fmt, /, **kwargs):
        self.fmt = fmt
        self.kwargs = kwargs

    def __str__(self):
        from string import Template
        return Template(self.fmt).substitute(**self.kwargs)

Любой из этих классов можно использовать вместо строки формата, чтобы применять форматирование {} или $ для формирования части «сообщение», которая в отформатированном выводе журнала заменяет «%(message)s», «{message}» или «$message». Использовать имена классов каждый раз, когда нужно что-то записать в журнал, немного неудобно, но это вполне приемлемо, если задать псевдоним, например __ (двойное подчёркивание — не путайте его с _, одиночным подчёркиванием, которое используют как синоним/псевдоним для gettext.gettext() и родственных функций).

Приведённые выше классы не входят в состав Python, но их достаточно легко скопировать и вставить в собственный код. Их можно использовать следующим образом (предполагается, что они объявлены в модуле wherever):

>>> from wherever import BraceMessage as __
>>> print(__('Message with {0} {name}', 2, name='placeholders'))
Message with 2 placeholders
>>> class Point: pass
...
>>> p = Point()
>>> p.x = 0.5
>>> p.y = 0.5
>>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})',
...       point=p))
Message with coordinates: (0.50, 0.50)
>>> from wherever import DollarMessage as __
>>> print(__('Message with $num $what', num=2, what='placeholders'))
Message with 2 placeholders
>>>

В приведённых выше примерах для демонстрации работы форматирования используется print(), но, конечно, для фактической записи в журнал таким способом следует использовать logger.debug() или аналогичную функцию.

Следует отметить, что этот подход не приводит к существенным потерям производительности: фактическое форматирование выполняется не при вызове функции ведения журнала, а только тогда, когда (и если) обработчик собирается вывести сообщение в журнал. Единственная необычная деталь, которая может сбить с толку: круглые скобки охватывают строку формата и аргументы, а не только строку формата. Это связано с тем, что запись __ — всего лишь синтаксический сахар для вызова конструктора одного из классов XXXMessage.

При желании можно использовать LoggerAdapter, чтобы добиться результата, аналогичного описанному выше, как в следующем примере:

import logging

class Message:
    def __init__(self, fmt, args):
        self.fmt = fmt
        self.args = args

    def __str__(self):
        return self.fmt.format(*self.args)

class StyleAdapter(logging.LoggerAdapter):
    def log(self, level, msg, /, *args, stacklevel=1, **kwargs):
        if self.isEnabledFor(level):
            msg, kwargs = self.process(msg, kwargs)
            self.logger.log(level, Message(msg, args), **kwargs,
                            stacklevel=stacklevel+1)

logger = StyleAdapter(logging.getLogger(__name__))

def main():
    logger.debug('Hello, {}', 'world!')

if __name__ == '__main__':
    logging.basicConfig(level=logging.DEBUG)
    main()

При запуске в Python 3.8 или более поздней версии приведённый выше скрипт должен записать сообщение Hello, world!.

Настройка LogRecord

Каждое событие журнала представлено экземпляром LogRecord. Когда событие записывается в журнал и не отфильтровывается уровнем регистратора, создаётся LogRecord, заполняется информацией о событии, а затем передаётся обработчикам этого регистратора (и его предков — вплоть до регистратора, на котором дальнейшая передача вверх по иерархии отключена). До Python 3.2 создание происходило только в двух местах:

• Logger.makeRecord(), который вызывается при обычной записи события в журнал. Он напрямую вызывал LogRecord для создания экземпляра.
• makeLogRecord(), которому передаётся словарь с атрибутами для добавления в LogRecord. Обычно он вызывается, когда по сети получен подходящий словарь (например, в формате pickle через SocketHandler или в формате JSON через HTTPHandler).

Обычно это означало, что для выполнения особых операций с LogRecord приходилось делать одно из следующего:

• Создать собственный подкласс Logger, переопределить в нём Logger.makeRecord() и установить его с помощью setLoggerClass() до создания нужных регистраторов.
• Добавить к регистратору или обработчику Filter, который выполняет необходимые специальные действия при вызове его метода filter().

Первый подход был бы неудобен в ситуации, когда, например, несколько разных библиотек хотят выполнять разные действия. Каждая попыталась бы установить собственный подкласс Logger, и в итоге использовался бы подкласс, установленный последним.

Второй подход вполне подходит для многих случаев, но не позволяет, например, использовать специализированный подкласс LogRecord. Разработчики библиотек могут установить подходящий фильтр для своих регистраторов, но им придётся не забывать делать это при каждом создании нового регистратора (что происходит при добавлении новых пакетов или модулей и выполнении следующего кода

logger = logging.getLogger(__name__)

на уровне модуля). Вероятно, это ещё одна лишняя вещь, о которой нужно помнить. Разработчики также могут добавить фильтр к NullHandler, присоединённому к регистратору верхнего уровня, но он не будет вызван, если разработчик приложения присоединит обработчик к регистратору библиотеки более низкого уровня — поэтому вывод этого обработчика не будет учитывать намерения разработчика библиотеки.

В Python 3.2 и более поздних версиях создание LogRecord выполняется через фабрику, которую можно указать. Фабрика — это вызываемый объект, который можно задать с помощью setLogRecordFactory() и получить с помощью getLogRecordFactory(). Фабрика вызывается с той же сигнатурой, что и конструктор LogRecord, поскольку по умолчанию фабрикой служит LogRecord.

Этот подход позволяет пользовательской фабрике управлять всеми аспектами создания LogRecord. Например, можно возвращать подкласс или просто добавлять в созданную запись дополнительные атрибуты, используя шаблон, похожий на следующий:

old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)

Этот шаблон позволяет разным библиотекам объединять фабрики в цепочку. Если они не перезаписывают атрибуты друг друга и случайно не перезаписывают стандартные атрибуты, никаких неожиданностей возникнуть не должно. Однако следует учитывать, что каждое звено цепочки добавляет накладные расходы во время выполнения ко всем операциям ведения журнала, поэтому этот способ следует использовать только в тех случаях, когда нужного результата нельзя добиться с помощью Filter.

Создание подклассов QueueHandler и QueueListener — пример с ZeroMQ

import zmq   # using pyzmq, the Python binding for ZeroMQ
import json  # for serializing records portably

ctx = zmq.Context()
sock = zmq.Socket(ctx, zmq.PUB)  # or zmq.PUSH, or other suitable value
sock.bind('tcp://*:5556')        # or wherever

class ZeroMQSocketHandler(QueueHandler):
    def enqueue(self, record):
        self.queue.send_json(record.__dict__)


handler = ZeroMQSocketHandler(sock)

class ZeroMQSocketHandler(QueueHandler):
    def __init__(self, uri, socktype=zmq.PUB, ctx=None):
        self.ctx = ctx or zmq.Context()
        socket = zmq.Socket(self.ctx, socktype)
        socket.bind(uri)
        super().__init__(socket)

    def enqueue(self, record):
        self.queue.send_json(record.__dict__)

    def close(self):
        self.queue.close()

class ZeroMQSocketListener(QueueListener):
    def __init__(self, uri, /, *handlers, **kwargs):
        self.ctx = kwargs.get('ctx') or zmq.Context()
        socket = zmq.Socket(self.ctx, zmq.SUB)
        socket.setsockopt_string(zmq.SUBSCRIBE, '')  # subscribe to everything
        socket.connect(uri)
        super().__init__(socket, *handlers, **kwargs)

    def dequeue(self):
        msg = self.queue.recv_json()
        return logging.makeLogRecord(msg)

Создание подклассов QueueHandler и QueueListener — пример с pynng

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

# listener.py
import json
import logging
import logging.handlers

import pynng

DEFAULT_ADDR = "tcp://localhost:13232"

interrupted = False

class NNGSocketListener(logging.handlers.QueueListener):

    def __init__(self, uri, /, *handlers, **kwargs):
        # Have a timeout for interruptability, and open a
        # subscriber socket
        socket = pynng.Sub0(listen=uri, recv_timeout=500)
        # The b'' subscription matches all topics
        topics = kwargs.pop('topics', None) or b''
        socket.subscribe(topics)
        # We treat the socket as a queue
        super().__init__(socket, *handlers, **kwargs)

    def dequeue(self, block):
        data = None
        # Keep looping while not interrupted and no data received over the
        # socket
        while not interrupted:
            try:
                data = self.queue.recv(block=block)
                break
            except pynng.Timeout:
                pass
            except pynng.Closed:  # sometimes happens when you hit Ctrl-C
                break
        if data is None:
            return None
        # Get the logging event sent from a publisher
        event = json.loads(data.decode('utf-8'))
        return logging.makeLogRecord(event)

    def enqueue_sentinel(self):
        # Not used in this implementation, as the socket isn't really a
        # queue
        pass

logging.getLogger('pynng').propagate = False
listener = NNGSocketListener(DEFAULT_ADDR, logging.StreamHandler(), topics=b'')
listener.start()
print('Press Ctrl-C to stop.')
try:
    while True:
        pass
except KeyboardInterrupt:
    interrupted = True
finally:
    listener.stop()

# sender.py
import json
import logging
import logging.handlers
import time
import random

import pynng

DEFAULT_ADDR = "tcp://localhost:13232"

class NNGSocketHandler(logging.handlers.QueueHandler):

    def __init__(self, uri):
        socket = pynng.Pub0(dial=uri, send_timeout=500)
        super().__init__(socket)

    def enqueue(self, record):
        # Send the record as UTF-8 encoded JSON
        d = dict(record.__dict__)
        data = json.dumps(d)
        self.queue.send(data.encode('utf-8'))

    def close(self):
        self.queue.close()

logging.getLogger('pynng').propagate = False
handler = NNGSocketHandler(DEFAULT_ADDR)
# Make sure the process ID is in the output
logging.basicConfig(level=logging.DEBUG,
                    handlers=[logging.StreamHandler(), handler],
                    format='%(levelname)-8s %(name)10s %(process)6s %(message)s')
levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
          logging.CRITICAL)
logger_names = ('myapp', 'myapp.lib1', 'myapp.lib2')
msgno = 1
while True:
    # Just randomly select some loggers and levels and log away
    level = random.choice(levels)
    logger = logging.getLogger(random.choice(logger_names))
    logger.log(level, 'Message no. %5d' % msgno)
    msgno += 1
    delay = random.random() * 2 + 0.5
    time.sleep(delay)

$ python sender.py
DEBUG         myapp    613 Message no.     1
WARNING  myapp.lib2    613 Message no.     2
CRITICAL myapp.lib2    613 Message no.     3
WARNING  myapp.lib2    613 Message no.     4
CRITICAL myapp.lib1    613 Message no.     5
DEBUG         myapp    613 Message no.     6
CRITICAL myapp.lib1    613 Message no.     7
INFO     myapp.lib1    613 Message no.     8
(and so on)

$ python sender.py
INFO     myapp.lib2    657 Message no.     1
CRITICAL myapp.lib2    657 Message no.     2
CRITICAL      myapp    657 Message no.     3
CRITICAL myapp.lib1    657 Message no.     4
INFO     myapp.lib1    657 Message no.     5
WARNING  myapp.lib2    657 Message no.     6
CRITICAL      myapp    657 Message no.     7
DEBUG    myapp.lib1    657 Message no.     8
(and so on)

$ python listener.py
Press Ctrl-C to stop.
DEBUG         myapp    613 Message no.     1
WARNING  myapp.lib2    613 Message no.     2
INFO     myapp.lib2    657 Message no.     1
CRITICAL myapp.lib2    613 Message no.     3
CRITICAL myapp.lib2    657 Message no.     2
CRITICAL      myapp    657 Message no.     3
WARNING  myapp.lib2    613 Message no.     4
CRITICAL myapp.lib1    613 Message no.     5
CRITICAL myapp.lib1    657 Message no.     4
INFO     myapp.lib1    657 Message no.     5
DEBUG         myapp    613 Message no.     6
WARNING  myapp.lib2    657 Message no.     6
CRITICAL      myapp    657 Message no.     7
CRITICAL myapp.lib1    613 Message no.     7
INFO     myapp.lib1    613 Message no.     8
DEBUG    myapp.lib1    657 Message no.     8
(and so on)

Пример конфигурации на основе словаря

Ниже приведён пример словаря конфигурации ведения журнала — он взят из документации проекта Django. Этот словарь передаётся в dictConfig(), чтобы применить конфигурацию:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
            'style': '{',
        },
        'simple': {
            'format': '{levelname} {message}',
            'style': '{',
        },
    },
    'filters': {
        'special': {
            '()': 'project.logging.SpecialFilter',
            'foo': 'bar',
        },
    },
    'handlers': {
        'console': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'simple',
        },
        'mail_admins': {
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler',
            'filters': ['special']
        }
    },
    'loggers': {
        'django': {
            'handlers': ['console'],
            'propagate': True,
        },
        'django.request': {
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': False,
        },
        'myproject.custom': {
            'handlers': ['console', 'mail_admins'],
            'level': 'INFO',
            'filters': ['special']
        }
    }
}

Дополнительную информацию об этой конфигурации см. в соответствующем разделе документации Django.

Настройка ротации журналов с помощью rotator и namer

Пример определения namer и rotator приведён в следующем исполняемом скрипте, который показывает сжатие файла журнала с помощью gzip:

import gzip
import logging
import logging.handlers
import os
import shutil

def namer(name):
    return name + ".gz"

def rotator(source, dest):
    with open(source, 'rb') as f_in:
        with gzip.open(dest, 'wb') as f_out:
            shutil.copyfileobj(f_in, f_out)
    os.remove(source)


rh = logging.handlers.RotatingFileHandler('rotated.log', maxBytes=128, backupCount=5)
rh.rotator = rotator
rh.namer = namer

root = logging.getLogger()
root.setLevel(logging.INFO)
root.addHandler(rh)
f = logging.Formatter('%(asctime)s %(message)s')
rh.setFormatter(f)
for i in range(1000):
    root.info(f'Message no. {i + 1}')

После его выполнения появятся шесть новых файлов, пять из которых будут сжаты:

$ ls rotated.log*
rotated.log       rotated.log.2.gz  rotated.log.4.gz
rotated.log.1.gz  rotated.log.3.gz  rotated.log.5.gz
$ zcat rotated.log.1.gz
2023-01-20 02:28:17,767 Message no. 996
2023-01-20 02:28:17,767 Message no. 997
2023-01-20 02:28:17,767 Message no. 998

Более подробный пример многопроцессной обработки

Следующий рабочий пример показывает, как использовать ведение журнала с многопроцессной обработкой и файлами конфигурации. Конфигурации достаточно просты, но иллюстрируют, как можно реализовать более сложные варианты в реальном сценарии многопроцессной обработки.

В примере главный процесс запускает процесс-приёмник и несколько рабочих процессов. Для главного процесса, приёмника и рабочих процессов предусмотрены три отдельные конфигурации (все рабочие процессы используют одну и ту же конфигурацию). Мы увидим, как ведётся журнал в главном процессе, как рабочие процессы отправляют записи в QueueHandler, а приёмник реализует QueueListener и более сложную конфигурацию ведения журнала, направляя полученные через очередь события обработчикам, указанным в конфигурации. Учтите, что эти конфигурации приведены только для иллюстрации, но вы сможете адаптировать пример для собственного сценария.

Ниже приведён скрипт — надеемся, строки документации и комментарии объясняют принцип его работы:

import logging
import logging.config
import logging.handlers
from multiprocessing import Process, Queue, Event, current_process
import os
import random
import time

class MyHandler:
    """
    A simple handler for logging events. It runs in the listener process and
    dispatches events to loggers based on the name in the received record,
    which then get dispatched, by the logging system, to the handlers
    configured for those loggers.
    """

    def handle(self, record):
        if record.name == "root":
            logger = logging.getLogger()
        else:
            logger = logging.getLogger(record.name)

        if logger.isEnabledFor(record.levelno):
            # The process name is transformed just to show that it's the listener
            # doing the logging to files and console
            record.processName = '%s (for %s)' % (current_process().name, record.processName)
            logger.handle(record)

def listener_process(q, stop_event, config):
    """
    This could be done in the main process, but is just done in a separate
    process for illustrative purposes.

    This initialises logging according to the specified configuration,
    starts the listener and waits for the main process to signal completion
    via the event. The listener is then stopped, and the process exits.
    """
    logging.config.dictConfig(config)
    listener = logging.handlers.QueueListener(q, MyHandler())
    listener.start()
    if os.name == 'posix':
        # On POSIX, the setup logger will have been configured in the
        # parent process, but should have been disabled following the
        # dictConfig call.
        # On Windows, since fork isn't used, the setup logger won't
        # exist in the child, so it would be created and the message
        # would appear - hence the "if posix" clause.
        logger = logging.getLogger('setup')
        logger.critical('Should not appear, because of disabled logger ...')
    stop_event.wait()
    listener.stop()

def worker_process(config):
    """
    A number of these are spawned for the purpose of illustration. In
    practice, they could be a heterogeneous bunch of processes rather than
    ones which are identical to each other.

    This initialises logging according to the specified configuration,
    and logs a hundred messages with random levels to randomly selected
    loggers.

    A small sleep is added to allow other processes a chance to run. This
    is not strictly needed, but it mixes the output from the different
    processes a bit more than if it's left out.
    """
    logging.config.dictConfig(config)
    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
              logging.CRITICAL]
    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
               'spam', 'spam.ham', 'spam.ham.eggs']
    if os.name == 'posix':
        # On POSIX, the setup logger will have been configured in the
        # parent process, but should have been disabled following the
        # dictConfig call.
        # On Windows, since fork isn't used, the setup logger won't
        # exist in the child, so it would be created and the message
        # would appear - hence the "if posix" clause.
        logger = logging.getLogger('setup')
        logger.critical('Should not appear, because of disabled logger ...')
    for i in range(100):
        lvl = random.choice(levels)
        logger = logging.getLogger(random.choice(loggers))
        logger.log(lvl, 'Message no. %d', i)
        time.sleep(0.01)

def main():
    q = Queue()
    # The main process gets a simple configuration which prints to the console.
    config_initial = {
        'version': 1,
        'handlers': {
            'console': {
                'class': 'logging.StreamHandler',
                'level': 'INFO'
            }
        },
        'root': {
            'handlers': ['console'],
            'level': 'DEBUG'
        }
    }
    # The worker process configuration is just a QueueHandler attached to the
    # root logger, which allows all messages to be sent to the queue.
    # We disable existing loggers to disable the "setup" logger used in the
    # parent process. This is needed on POSIX because the logger will
    # be there in the child following a fork().
    config_worker = {
        'version': 1,
        'disable_existing_loggers': True,
        'handlers': {
            'queue': {
                'class': 'logging.handlers.QueueHandler',
                'queue': q
            }
        },
        'root': {
            'handlers': ['queue'],
            'level': 'DEBUG'
        }
    }
    # The listener process configuration shows that the full flexibility of
    # logging configuration is available to dispatch events to handlers however
    # you want.
    # We disable existing loggers to disable the "setup" logger used in the
    # parent process. This is needed on POSIX because the logger will
    # be there in the child following a fork().
    config_listener = {
        'version': 1,
        'disable_existing_loggers': True,
        'formatters': {
            'detailed': {
                'class': 'logging.Formatter',
                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            },
            'simple': {
                'class': 'logging.Formatter',
                'format': '%(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            }
        },
        'handlers': {
            'console': {
                'class': 'logging.StreamHandler',
                'formatter': 'simple',
                'level': 'INFO'
            },
            'file': {
                'class': 'logging.FileHandler',
                'filename': 'mplog.log',
                'mode': 'w',
                'formatter': 'detailed'
            },
            'foofile': {
                'class': 'logging.FileHandler',
                'filename': 'mplog-foo.log',
                'mode': 'w',
                'formatter': 'detailed'
            },
            'errors': {
                'class': 'logging.FileHandler',
                'filename': 'mplog-errors.log',
                'mode': 'w',
                'formatter': 'detailed',
                'level': 'ERROR'
            }
        },
        'loggers': {
            'foo': {
                'handlers': ['foofile']
            }
        },
        'root': {
            'handlers': ['console', 'file', 'errors'],
            'level': 'DEBUG'
        }
    }
    # Log some initial events, just to show that logging in the parent works
    # normally.
    logging.config.dictConfig(config_initial)
    logger = logging.getLogger('setup')
    logger.info('About to create workers ...')
    workers = []
    for i in range(5):
        wp = Process(target=worker_process, name='worker %d' % (i + 1),
                     args=(config_worker,))
        workers.append(wp)
        wp.start()
        logger.info('Started worker: %s', wp.name)
    logger.info('About to create listener ...')
    stop_event = Event()
    lp = Process(target=listener_process, name='listener',
                 args=(q, stop_event, config_listener))
    lp.start()
    logger.info('Started listener')
    # We now hang around for the workers to finish their work.
    for wp in workers:
        wp.join()
    # Workers all done, listening can now stop.
    # Logging in the parent still works normally.
    logger.info('Telling listener to stop ...')
    stop_event.set()
    lp.join()
    logger.info('All done.')

if __name__ == '__main__':
    main()

Вставка BOM в сообщения, отправляемые в SysLogHandler

RFC 5424 требует отправлять сообщение Unicode демону syslog в виде набора байтов со следующей структурой: необязательный компонент, состоящий только из ASCII, затем метка порядка байтов UTF-8 (BOM), а после неё текст Unicode в кодировке UTF-8. (См. соответствующий раздел спецификации.)

В Python 3.1 в SysLogHandler был добавлен код для вставки BOM в сообщение, но, к сожалению, он был реализован неправильно: BOM помещался в начало сообщения, поэтому перед ним нельзя было разместить компонент, состоящий только из ASCII.

Поскольку это поведение ошибочно, некорректный код вставки BOM удаляется начиная с Python 3.2.4. Однако замены ему не предусмотрено. Поэтому, если вы хотите формировать соответствующие RFC 5424 сообщения, содержащие BOM, необязательную последовательность ASCII перед ним и произвольный текст Unicode после него в кодировке UTF-8, выполните следующие действия:

1. Присоедините экземпляр Formatter к экземпляру SysLogHandler, используя строку формата, например:

   'ASCII section\ufeffUnicode section'
   

   При кодировании с помощью UTF-8 кодовая точка Unicode U+FEFF преобразуется в UTF-8 BOM — байтовую строку b'\xef\xbb\xbf'.

2. Замените раздел ASCII любыми нужными заполнителями, но убедитесь, что после подстановки полученные данные всегда состоят только из ASCII (тогда после кодирования UTF-8 они останутся неизменными).
3. Замените раздел Unicode любыми нужными заполнителями; если после подстановки полученные данные содержат символы за пределами диапазона ASCII, это допустимо — они будут закодированы с помощью UTF-8.

Отформатированное сообщение будет закодировано в UTF-8 с помощью SysLogHandler. Если следовать приведённым выше правилам, можно формировать соответствующие RFC 5424 сообщения. Если этого не делать, ведение журнала может не выдать ошибку, но сообщения не будут соответствовать RFC 5424, и демон syslog может сообщить об этом.

Реализация структурированного ведения журнала

Большинство сообщений журнала предназначено для чтения людьми и поэтому не очень удобно для машинного разбора. Однако иногда может потребоваться выводить сообщения в структурированном формате, который можно разбирать программно (без сложных регулярных выражений для анализа сообщений журнала). С помощью пакета logging этого легко добиться. Существует несколько способов решения задачи, но ниже приведён простой подход, использующий JSON для сериализации события в удобном для машинного разбора виде:

import json
import logging

class StructuredMessage:
    def __init__(self, message, /, **kwargs):
        self.message = message
        self.kwargs = kwargs

    def __str__(self):
        return '%s >>> %s' % (self.message, json.dumps(self.kwargs))

_ = StructuredMessage   # optional, to improve readability

logging.basicConfig(level=logging.INFO, format='%(message)s')
logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456))

При запуске приведённого выше скрипта выводится:

message 1 >>> {"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"}

Обратите внимание, что порядок элементов может различаться в зависимости от версии Python.

Для более специализированной обработки можно использовать пользовательский кодировщик JSON, как в следующем полном примере:

import json
import logging


class Encoder(json.JSONEncoder):
    def default(self, o):
        if isinstance(o, set):
            return tuple(o)
        elif isinstance(o, str):
            return o.encode('unicode_escape').decode('ascii')
        return super().default(o)

class StructuredMessage:
    def __init__(self, message, /, **kwargs):
        self.message = message
        self.kwargs = kwargs

    def __str__(self):
        s = Encoder().encode(self.kwargs)
        return '%s >>> %s' % (self.message, s)

_ = StructuredMessage   # optional, to improve readability

def main():
    logging.basicConfig(level=logging.INFO, format='%(message)s')
    logging.info(_('message 1', set_value={1, 2, 3}, snowman='\u2603'))

if __name__ == '__main__':
    main()

При запуске приведённого выше скрипта выводится:

message 1 >>> {"snowman": "\u2603", "set_value": [1, 2, 3]}

Обратите внимание, что порядок элементов может различаться в зависимости от версии Python.

Настройка обработчиков с помощью dictConfig()

Иногда требуется особым образом настроить обработчики ведения журнала. Если используется dictConfig(), это можно сделать без создания подклассов. Например, может потребоваться изменить владельца файла журнала. В POSIX это легко сделать с помощью shutil.chown(), но файловые обработчики стандартной библиотеки не имеют встроенной поддержки этой операции. Создание обработчика можно настроить с помощью обычной функции, например:

def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    if owner:
        if not os.path.exists(filename):
            open(filename, 'a').close()
        shutil.chown(filename, *owner)
    return logging.FileHandler(filename, mode, encoding)

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

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'default': {
            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        },
    },
    'handlers': {
        'file':{
            # The values below are popped from this dictionary and
            # used to create the handler, set the handler's level and
            # its formatter.
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # The values below are passed to the handler creator callable
            # as keyword arguments.
            'owner': ['pulse', 'pulse'],
            'filename': 'chowntest.log',
            'mode': 'w',
            'encoding': 'utf-8',
        },
    },
    'root': {
        'handlers': ['file'],
        'level': 'DEBUG',
    },
}

В этом примере для наглядности владелец задаётся с помощью пользователя и группы pulse. Объединим всё это в рабочий скрипт, chowntest.py:

import logging, logging.config, os, shutil

def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    if owner:
        if not os.path.exists(filename):
            open(filename, 'a').close()
        shutil.chown(filename, *owner)
    return logging.FileHandler(filename, mode, encoding)

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'default': {
            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        },
    },
    'handlers': {
        'file':{
            # The values below are popped from this dictionary and
            # used to create the handler, set the handler's level and
            # its formatter.
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # The values below are passed to the handler creator callable
            # as keyword arguments.
            'owner': ['pulse', 'pulse'],
            'filename': 'chowntest.log',
            'mode': 'w',
            'encoding': 'utf-8',
        },
    },
    'root': {
        'handlers': ['file'],
        'level': 'DEBUG',
    },
}

logging.config.dictConfig(LOGGING)
logger = logging.getLogger('mylogger')
logger.debug('A debug message')

Для запуска, вероятно, потребуется выполнить команду от имени root:

$ sudo python3.3 chowntest.py
$ cat chowntest.log
2013-11-05 09:34:51,128 DEBUG mylogger A debug message
$ ls -l chowntest.log
-rw-r--r-- 1 pulse pulse 55 2013-11-05 09:34 chowntest.log

Обратите внимание, что в этом примере используется Python 3.3, поскольку именно в этой версии появился shutil.chown(). Этот подход должен работать в любой версии Python, поддерживающей dictConfig(), то есть в Python 2.7, 3.2 и более поздних версиях. В версиях до 3.3 фактическую смену владельца нужно реализовать, например, с помощью os.chown().

На практике функция создания обработчика может находиться в каком-либо служебном модуле проекта. Вместо строки конфигурации:

'()': owned_file_handler,

можно использовать, например:

'()': 'ext://project.util.owned_file_handler',

где project.util можно заменить фактическим именем пакета, в котором находится функция. В приведённом выше рабочем скрипте должно подойти 'ext://__main__.owned_file_handler'. Здесь вызываемый объект определяется функцией dictConfig() на основе спецификации ext://.

Надеемся, этот пример также подскажет, как аналогичным образом реализовать другие изменения файлов — например, установить определённые биты разрешений POSIX — с помощью os.chmod().

Разумеется, этот подход можно распространить и на обработчики других типов, а не только на FileHandler: например, на один из обработчиков с ротацией файлов или на обработчик совершенно другого типа.

Использование определённых стилей форматирования во всём приложении

В Python 3.2 в Formatter был добавлен параметр-ключевое слово style, который, по умолчанию принимая значение % для обратной совместимости, позволял задавать { или $ для поддержки способов форматирования, поддерживаемых str.format() и string.Template. Обратите внимание: этот параметр управляет форматированием сообщений журнала для их окончательного вывода в журналы и совершенно не связан с тем, как создаётся отдельное сообщение журнала.

Вызовы журналирования (debug(), info() и т. д.) принимают позиционные параметры только для самого сообщения журнала, а параметры-ключевые слова используются лишь для определения того, как обработать вызов журналирования (например, параметр-ключевое слово exc_info указывает, что следует записать информацию об обратной трассировке, а параметр-ключевое слово extra — что в журнал нужно добавить дополнительные контекстные сведения). Поэтому нельзя напрямую выполнять вызовы журналирования с использованием синтаксиса str.format() или string.Template, поскольку внутри пакет logging использует форматирование с %-оператором для объединения строки формата и переменных аргументов. Изменить это без нарушения обратной совместимости невозможно, поскольку во всех существующих вызовах журналирования в коде используются строки формата с %-оператором.

Предлагалось связывать стили форматирования с определёнными регистраторами, однако у такого подхода тоже возникают проблемы с обратной совместимостью, поскольку существующий код может использовать заданное имя регистратора и форматирование с %-оператором.

Чтобы журналирование работало совместно с любыми сторонними библиотеками и вашим кодом, решения о форматировании необходимо принимать на уровне отдельного вызова журналирования. Это позволяет использовать несколько способов поддержки альтернативных стилей форматирования.

class BraceMessage:
    def __init__(self, fmt, /, *args, **kwargs):
        self.fmt = fmt
        self.args = args
        self.kwargs = kwargs

    def __str__(self):
        return self.fmt.format(*self.args, **self.kwargs)

class DollarMessage:
    def __init__(self, fmt, /, **kwargs):
        self.fmt = fmt
        self.kwargs = kwargs

    def __str__(self):
        from string import Template
        return Template(self.fmt).substitute(**self.kwargs)

>>> __ = BraceMessage
>>> print(__('Message with {0} {1}', 2, 'placeholders'))
Message with 2 placeholders
>>> class Point: pass
...
>>> p = Point()
>>> p.x = 0.5
>>> p.y = 0.5
>>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})', point=p))
Message with coordinates: (0.50, 0.50)

>>> __ = DollarMessage
>>> print(__('Message with $num $what', num=2, what='placeholders'))
Message with 2 placeholders
>>>

Настройка фильтров с помощью dictConfig()

Фильтры можно настраивать с помощью dictConfig(), хотя с первого взгляда это может быть неочевидно (поэтому и понадобился этот пример). Поскольку Filter — единственный класс фильтра в стандартной библиотеке, и он вряд ли подойдёт для решения многих задач (он предназначен лишь для использования в качестве базового класса), обычно вам потребуется определить собственный подкласс Filter с переопределённым методом filter(). Для этого укажите ключ () в словаре конфигурации фильтра и задайте вызываемый объект, который будет использоваться для создания фильтра (самый очевидный вариант — класс, но можно указать любой вызываемый объект, возвращающий экземпляр Filter). Вот полный пример:

import logging
import logging.config
import sys

class MyFilter(logging.Filter):
    def __init__(self, param=None):
        self.param = param

    def filter(self, record):
        if self.param is None:
            allow = True
        else:
            allow = self.param not in record.msg
        if allow:
            record.msg = 'changed: ' + record.msg
        return allow

LOGGING = {
    'version': 1,
    'filters': {
        'myfilter': {
            '()': MyFilter,
            'param': 'noshow',
        }
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'filters': ['myfilter']
        }
    },
    'root': {
        'level': 'DEBUG',
        'handlers': ['console']
    },
}

if __name__ == '__main__':
    logging.config.dictConfig(LOGGING)
    logging.debug('hello')
    logging.debug('hello - noshow')

В этом примере показано, как передать конфигурационные данные вызываемому объекту, который создаёт экземпляр, в виде параметров-ключевых слов. При запуске приведённый выше скрипт выведет:

changed: hello

что показывает, что фильтр работает согласно настройке.

Также следует учесть несколько дополнительных моментов:

• Если нельзя напрямую указать вызываемый объект в конфигурации (например, если он находится в другом модуле и его нельзя импортировать напрямую в месте, где создаётся словарь конфигурации), можно использовать форму ext://..., описанную в разделе Доступ к внешним объектам. Например, в приведённом выше примере вместо MyFilter можно было использовать текст 'ext://__main__.MyFilter'.
• Эту технику можно использовать не только для фильтров, но и для настройки пользовательских обработчиков и форматировщиков. Дополнительные сведения о поддержке пользовательских объектов в конфигурации logging см. в разделе Объекты, определённые пользователем, а также в другом примере из этого руководства выше: Настройка обработчиков с помощью dictConfig().

Настраиваемое форматирование исключений

Иногда может понадобиться настроить форматирование исключений. Допустим, вы хотите, чтобы для каждого зарегистрированного события выводилась ровно одна строка, даже если есть информация об исключении. Это можно сделать с помощью пользовательского класса форматировщика, как показано в следующем примере:

import logging

class OneLineExceptionFormatter(logging.Formatter):
    def formatException(self, exc_info):
        """
        Format an exception so that it prints on a single line.
        """
        result = super().formatException(exc_info)
        return repr(result)  # or format into one line however you want to

    def format(self, record):
        s = super().format(record)
        if record.exc_text:
            s = s.replace('\n', '') + '|'
        return s

def configure_logging():
    fh = logging.FileHandler('output.txt', 'w')
    f = OneLineExceptionFormatter('%(asctime)s|%(levelname)s|%(message)s|',
                                  '%d/%m/%Y %H:%M:%S')
    fh.setFormatter(f)
    root = logging.getLogger()
    root.setLevel(logging.DEBUG)
    root.addHandler(fh)

def main():
    configure_logging()
    logging.info('Sample message')
    try:
        x = 1 / 0
    except ZeroDivisionError as e:
        logging.exception('ZeroDivisionError: %s', e)

if __name__ == '__main__':
    main()

При запуске скрипт создаёт файл ровно с двумя строками:

28/01/2015 07:21:23|INFO|Sample message|
28/01/2015 07:21:23|ERROR|ZeroDivisionError: integer division or modulo by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: integer division or modulo by zero'|

Хотя приведённый выше пример упрощён, он показывает, как можно форматировать информацию об исключениях по своему усмотрению. Для более специализированных задач может пригодиться модуль traceback.

Озвучивание сообщений журнала

Иногда сообщения журнала желательно представлять в звуковом, а не визуальном формате. Это несложно сделать, если в вашей системе доступны средства синтеза речи (TTS), даже если для них нет привязки к Python. В большинстве систем TTS есть программа командной строки, которую можно запустить; её можно вызвать из обработчика с помощью subprocess. Здесь предполагается, что программы TTS командной строки не будут взаимодействовать с пользователями и не потребуют много времени для выполнения, частота сообщений журнала будет не настолько высокой, чтобы завалить пользователя сообщениями, а последовательное озвучивание сообщений вместо одновременного будет приемлемым. Приведённый ниже пример реализации дожидается озвучивания одного сообщения, прежде чем обрабатывать следующее, что может заставить другие обработчики ждать. Вот короткий пример такого подхода, предполагающий, что доступен пакет TTS espeak:

import logging
import subprocess
import sys

class TTSHandler(logging.Handler):
    def emit(self, record):
        msg = self.format(record)
        # Speak slowly in a female English voice
        cmd = ['espeak', '-s150', '-ven+f3', msg]
        p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                             stderr=subprocess.STDOUT)
        # wait for the program to finish
        p.communicate()

def configure_logging():
    h = TTSHandler()
    root = logging.getLogger()
    root.addHandler(h)
    # the default formatter just returns the message
    root.setLevel(logging.DEBUG)

def main():
    logging.info('Hello')
    logging.debug('Goodbye')

if __name__ == '__main__':
    configure_logging()
    sys.exit(main())

При запуске этот скрипт должен произнести «Hello», а затем «Goodbye» женским голосом.

Описанный выше подход, разумеется, можно адаптировать для других систем TTS и даже для других систем, способных обрабатывать сообщения с помощью внешних программ, запускаемых из командной строки.

Буферизация сообщений журнала и их условный вывод

Иногда сообщения требуется записывать во временную область и выводить только при наступлении определённого условия. Например, можно начать записывать отладочные события в функции и не засорять журнал собранной отладочной информацией, если функция завершилась без ошибок. Но если произошла ошибка, необходимо вывести всю отладочную информацию вместе с сообщением об ошибке.

В этом примере показано, как этого добиться с помощью декоратора для функций, в которых журналирование должно работать таким образом. Здесь используется logging.handlers.MemoryHandler, позволяющий буферизовать зарегистрированные события до наступления определённого условия, после чего буферизованные события flushed — передаются другому обработчику (обработчику target) для обработки. По умолчанию MemoryHandler сбрасывает буфер, когда тот заполняется или когда встречается событие с уровнем, равным или превышающим заданный порог. Если требуется особое поведение при сбросе буфера, в этом примере можно использовать более специализированный подкласс MemoryHandler.

В примере скрипта есть простая функция foo, которая проходит по всем уровням журналирования, записывая в sys.stderr сообщение о том, на каком уровне она собирается выполнить запись, а затем действительно записывает сообщение на этом уровне. Функции foo можно передать параметр, который при значении true включает запись на уровнях ERROR и CRITICAL; в противном случае записываются только сообщения уровней DEBUG, INFO и WARNING.

Скрипт просто декорирует foo декоратором, который выполняет требуемое условное журналирование. Декоратор принимает регистратор в качестве параметра и на время вызова декорированной функции добавляет обработчик памяти. Кроме того, декоратор можно настроить, указав целевой обработчик, уровень, при достижении которого следует выполнить сброс буфера, и ёмкость буфера (число буферизованных записей). По умолчанию это соответственно StreamHandler, который записывает данные в sys.stderr, logging.ERROR и 100.

Вот скрипт:

import logging
from logging.handlers import MemoryHandler
import sys

logger = logging.getLogger(__name__)
logger.addHandler(logging.NullHandler())

def log_if_errors(logger, target_handler=None, flush_level=None, capacity=None):
    if target_handler is None:
        target_handler = logging.StreamHandler()
    if flush_level is None:
        flush_level = logging.ERROR
    if capacity is None:
        capacity = 100
    handler = MemoryHandler(capacity, flushLevel=flush_level, target=target_handler)

    def decorator(fn):
        def wrapper(*args, **kwargs):
            logger.addHandler(handler)
            try:
                return fn(*args, **kwargs)
            except Exception:
                logger.exception('call failed')
                raise
            finally:
                super(MemoryHandler, handler).flush()
                logger.removeHandler(handler)
        return wrapper

    return decorator

def write_line(s):
    sys.stderr.write('%s\n' % s)

def foo(fail=False):
    write_line('about to log at DEBUG ...')
    logger.debug('Actually logged at DEBUG')
    write_line('about to log at INFO ...')
    logger.info('Actually logged at INFO')
    write_line('about to log at WARNING ...')
    logger.warning('Actually logged at WARNING')
    if fail:
        write_line('about to log at ERROR ...')
        logger.error('Actually logged at ERROR')
        write_line('about to log at CRITICAL ...')
        logger.critical('Actually logged at CRITICAL')
    return fail

decorated_foo = log_if_errors(logger)(foo)

if __name__ == '__main__':
    logger.setLevel(logging.DEBUG)
    write_line('Calling undecorated foo with False')
    assert not foo(False)
    write_line('Calling undecorated foo with True')
    assert foo(True)
    write_line('Calling decorated foo with False')
    assert not decorated_foo(False)
    write_line('Calling decorated foo with True')
    assert decorated_foo(True)

При запуске этого скрипта должен появиться следующий вывод:

Calling undecorated foo with False
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
Calling undecorated foo with True
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
about to log at ERROR ...
about to log at CRITICAL ...
Calling decorated foo with False
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
Calling decorated foo with True
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
about to log at ERROR ...
Actually logged at DEBUG
Actually logged at INFO
Actually logged at WARNING
Actually logged at ERROR
about to log at CRITICAL ...
Actually logged at CRITICAL

Как видите, фактический вывод в журнал происходит только при регистрации события уровня ERROR или выше, но в этом случае также записываются все предшествующие события с более низкими уровнями.

Разумеется, можно использовать и обычный способ декорирования:

@log_if_errors(logger)
def foo(fail=False):
    ...

Отправка сообщений журнала по электронной почте с буферизацией

Чтобы показать, как отправлять сообщения журнала по электронной почте так, чтобы в каждом письме было заданное количество сообщений, можно создать подкласс BufferingHandler. В следующем примере, который можно адаптировать под свои задачи, приведён простой тестовый каркас. Он позволяет запускать скрипт с аргументами командной строки, указывающими типичные параметры для отправки данных через SMTP. (Запустите загруженный скрипт с аргументом -h, чтобы увидеть обязательные и необязательные аргументы.)

import logging
import logging.handlers
import smtplib

class BufferingSMTPHandler(logging.handlers.BufferingHandler):
    def __init__(self, mailhost, port, username, password, fromaddr, toaddrs,
                 subject, capacity):
        logging.handlers.BufferingHandler.__init__(self, capacity)
        self.mailhost = mailhost
        self.mailport = port
        self.username = username
        self.password = password
        self.fromaddr = fromaddr
        if isinstance(toaddrs, str):
            toaddrs = [toaddrs]
        self.toaddrs = toaddrs
        self.subject = subject
        self.setFormatter(logging.Formatter("%(asctime)s %(levelname)-5s %(message)s"))

    def flush(self):
        if len(self.buffer) > 0:
            try:
                smtp = smtplib.SMTP(self.mailhost, self.mailport)
                smtp.starttls()
                smtp.login(self.username, self.password)
                msg = "From: %s\r\nTo: %s\r\nSubject: %s\r\n\r\n" % (self.fromaddr, ','.join(self.toaddrs), self.subject)
                for record in self.buffer:
                    s = self.format(record)
                    msg = msg + s + "\r\n"
                smtp.sendmail(self.fromaddr, self.toaddrs, msg)
                smtp.quit()
            except Exception:
                if logging.raiseExceptions:
                    raise
            self.buffer = []

if __name__ == '__main__':
    import argparse

    ap = argparse.ArgumentParser()
    aa = ap.add_argument
    aa('host', metavar='HOST', help='SMTP server')
    aa('--port', '-p', type=int, default=587, help='SMTP port')
    aa('user', metavar='USER', help='SMTP username')
    aa('password', metavar='PASSWORD', help='SMTP password')
    aa('to', metavar='TO', help='Addressee for emails')
    aa('sender', metavar='SENDER', help='Sender email address')
    aa('--subject', '-s',
       default='Test Logging email from Python logging module (buffering)',
       help='Subject of email')
    options = ap.parse_args()
    logger = logging.getLogger()
    logger.setLevel(logging.DEBUG)
    h = BufferingSMTPHandler(options.host, options.port, options.user,
                             options.password, options.sender,
                             options.to, options.subject, 10)
    logger.addHandler(h)
    for i in range(102):
        logger.info("Info index = %d", i)
    h.flush()
    h.close()

Если запустить этот скрипт при правильно настроенном SMTP-сервере, он должен отправить указанному адресату одиннадцать писем. В первых десяти письмах будет по десять сообщений журнала, а в одиннадцатом — два сообщения. Всего получится 102 сообщения, как указано в скрипте.

Форматирование времени в UTC (GMT) с помощью конфигурации

Иногда требуется форматировать время по UTC. Для этого можно использовать класс, например UTCFormatter, показанный ниже:

import logging
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime

Затем в коде можно использовать UTCFormatter вместо Formatter. Если нужно настроить это с помощью конфигурации, можно воспользоваться API dictConfig(), как показано в следующем полном примере:

import logging
import logging.config
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'utc': {
            '()': UTCFormatter,
            'format': '%(asctime)s %(message)s',
        },
        'local': {
            'format': '%(asctime)s %(message)s',
        }
    },
    'handlers': {
        'console1': {
            'class': 'logging.StreamHandler',
            'formatter': 'utc',
        },
        'console2': {
            'class': 'logging.StreamHandler',
            'formatter': 'local',
        },
    },
    'root': {
        'handlers': ['console1', 'console2'],
   }
}

if __name__ == '__main__':
    logging.config.dictConfig(LOGGING)
    logging.warning('The local time is %s', time.asctime())

При запуске этого скрипта должно появиться примерно следующее:

2015-10-17 12:53:29,501 The local time is Sat Oct 17 13:53:29 2015
2015-10-17 13:53:29,501 The local time is Sat Oct 17 13:53:29 2015

В этом примере время форматируется и как местное, и как UTC — по одному варианту для каждого обработчика.

Использование менеджера контекста для выборочного журналирования

Иногда бывает полезно временно изменить конфигурацию журналирования, а затем восстановить её после выполнения некоторого действия. Для сохранения и восстановления контекста журналирования удобнее всего использовать менеджер контекста. Ниже приведён простой пример такого менеджера контекста, который позволяет при необходимости изменить уровень журналирования и добавить обработчик только в пределах области действия менеджера контекста:

import logging
import sys

class LoggingContext:
    def __init__(self, logger, level=None, handler=None, close=True):
        self.logger = logger
        self.level = level
        self.handler = handler
        self.close = close

    def __enter__(self):
        if self.level is not None:
            self.old_level = self.logger.level
            self.logger.setLevel(self.level)
        if self.handler:
            self.logger.addHandler(self.handler)

    def __exit__(self, et, ev, tb):
        if self.level is not None:
            self.logger.setLevel(self.old_level)
        if self.handler:
            self.logger.removeHandler(self.handler)
        if self.handler and self.close:
            self.handler.close()
        # implicit return of None => don't swallow exceptions

Если указать значение уровня, уровень регистратора будет установлен в это значение в пределах блока with, охваченного менеджером контекста. Если указать обработчик, при входе в блок он будет добавлен к регистратору, а при выходе — удалён. Можно также попросить менеджер закрыть обработчик при выходе из блока — это пригодится, если обработчик больше не нужен.

Чтобы показать, как это работает, добавим к приведённому выше коду следующий блок:

if __name__ == '__main__':
    logger = logging.getLogger('foo')
    logger.addHandler(logging.StreamHandler())
    logger.setLevel(logging.INFO)
    logger.info('1. This should appear just once on stderr.')
    logger.debug('2. This should not appear.')
    with LoggingContext(logger, level=logging.DEBUG):
        logger.debug('3. This should appear once on stderr.')
    logger.debug('4. This should not appear.')
    h = logging.StreamHandler(sys.stdout)
    with LoggingContext(logger, level=logging.DEBUG, handler=h, close=True):
        logger.debug('5. This should appear twice - once on stderr and once on stdout.')
    logger.info('6. This should appear just once on stderr.')
    logger.debug('7. This should not appear.')

Сначала мы устанавливаем для регистратора уровень INFO, поэтому сообщение #1 появляется, а сообщение #2 — нет. Затем в следующем блоке with мы временно меняем уровень на DEBUG, поэтому появляется сообщение #3. После выхода из блока уровень регистратора восстанавливается до INFO, поэтому сообщение #4 не появляется. В следующем блоке with мы снова устанавливаем уровень DEBUG, но также добавляем обработчик, записывающий данные в sys.stdout. Поэтому сообщение #5 дважды появляется в консоли (один раз через stderr и один раз через stdout). После завершения инструкции with состояние восстанавливается, поэтому сообщение #6 появляется (как сообщение #1), а сообщение #7 — нет (как и сообщение #2).

Если запустить получившийся скрипт, результат будет следующим:

$ python logctx.py
1. This should appear just once on stderr.
3. This should appear once on stderr.
5. This should appear twice - once on stderr and once on stdout.
5. This should appear twice - once on stderr and once on stdout.
6. This should appear just once on stderr.

Если запустить его ещё раз, но перенаправить stderr в /dev/null, мы увидим следующий результат — это единственное сообщение, записанное в stdout:

$ python logctx.py 2>/dev/null
5. This should appear twice - once on stderr and once on stdout.

Если снова запустить скрипт, перенаправив stdout в /dev/null, получим:

$ python logctx.py >/dev/null
1. This should appear just once on stderr.
3. This should appear once on stderr.
5. This should appear twice - once on stderr and once on stdout.
6. This should appear just once on stderr.

В этом случае, как и ожидалось, сообщение #5, выведенное в stdout, не появляется.

Разумеется, описанный здесь подход можно обобщить, например, чтобы временно подключать фильтры журналирования. Обратите внимание: приведённый выше код работает как в Python 2, так и в Python 3.

Шаблон для запуска приложения CLI

В этом примере показано, как можно:

• Использовать уровень журналирования, заданный аргументами командной строки
• Направлять выполнение в несколько подкоманд из отдельных файлов, чтобы все они записывали сообщения на одном уровне и единообразным способом
• Использовать простую минимальную конфигурацию

Предположим, у нас есть приложение командной строки, предназначенное для остановки, запуска или перезапуска служб. Для наглядности его можно организовать так: файл app.py будет основным скриптом приложения, а отдельные команды будут реализованы в файлах start.py, stop.py и restart.py. Кроме того, предположим, что мы хотим управлять подробностью вывода приложения с помощью аргумента командной строки, по умолчанию задающего уровень logging.INFO. Вот один из вариантов реализации app.py:

import argparse
import importlib
import logging
import os
import sys

def main(args=None):
    scriptname = os.path.basename(__file__)
    parser = argparse.ArgumentParser(scriptname)
    levels = ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')
    parser.add_argument('--log-level', default='INFO', choices=levels)
    subparsers = parser.add_subparsers(dest='command',
                                       help='Available commands:')
    start_cmd = subparsers.add_parser('start', help='Start a service')
    start_cmd.add_argument('name', metavar='NAME',
                           help='Name of service to start')
    stop_cmd = subparsers.add_parser('stop',
                                     help='Stop one or more services')
    stop_cmd.add_argument('names', metavar='NAME', nargs='+',
                          help='Name of service to stop')
    restart_cmd = subparsers.add_parser('restart',
                                        help='Restart one or more services')
    restart_cmd.add_argument('names', metavar='NAME', nargs='+',
                             help='Name of service to restart')
    options = parser.parse_args()
    # the code to dispatch commands could all be in this file. For the purposes
    # of illustration only, we implement each command in a separate module.
    try:
        mod = importlib.import_module(options.command)
        cmd = getattr(mod, 'command')
    except (ImportError, AttributeError):
        print('Unable to find the code for command \'%s\'' % options.command)
        return 1
    # Could get fancy here and load configuration from file or dictionary
    logging.basicConfig(level=options.log_level,
                        format='%(levelname)s %(name)s %(message)s')
    cmd(options)

if __name__ == '__main__':
    sys.exit(main())

Команды start, stop и restart можно реализовать в отдельных модулях, например, команду запуска — следующим образом:

# start.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    logger.debug('About to start %s', options.name)
    # actually do the command processing here ...
    logger.info('Started the \'%s\' service.', options.name)

а команду остановки — так:

# stop.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = ''
        services = '\'%s\'' % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'' % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to stop %s', services)
    # actually do the command processing here ...
    logger.info('Stopped the %s service%s.', services, plural)

и аналогично команду перезапуска:

# restart.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = ''
        services = '\'%s\'' % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'' % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to restart %s', services)
    # actually do the command processing here ...
    logger.info('Restarted the %s service%s.', services, plural)

Если запустить это приложение с уровнем журналирования по умолчанию, мы получим примерно такой вывод:

$ python app.py start foo
INFO start Started the 'foo' service.

$ python app.py stop foo bar
INFO stop Stopped the 'foo' and 'bar' services.

$ python app.py restart foo bar baz
INFO restart Restarted the 'foo', 'bar' and 'baz' services.

Первое слово обозначает уровень журналирования, а второе — имя модуля или пакета, в котором было зарегистрировано событие.

Изменив уровень журналирования, можно изменить объём информации, отправляемой в журнал. Например, если нужно больше сведений:

$ python app.py --log-level DEBUG start foo
DEBUG start About to start foo
INFO start Started the 'foo' service.

$ python app.py --log-level DEBUG stop foo bar
DEBUG stop About to stop 'foo' and 'bar'
INFO stop Stopped the 'foo' and 'bar' services.

$ python app.py --log-level DEBUG restart foo bar baz
DEBUG restart About to restart 'foo', 'bar' and 'baz'
INFO restart Restarted the 'foo', 'bar' and 'baz' services.

А если нужно меньше:

$ python app.py --log-level WARNING start foo
$ python app.py --log-level WARNING stop foo bar
$ python app.py --log-level WARNING restart foo bar baz

В этом случае команды ничего не выводят в консоль, поскольку они не регистрируют сообщения уровня WARNING или выше.

Графический интерфейс Qt для журналирования

Время от времени возникает вопрос о том, как вести журналирование в приложении с графическим интерфейсом. Фреймворк Qt — популярный кроссплатформенный фреймворк пользовательского интерфейса с привязками к Python, доступными в библиотеках PySide2 или PyQt5.

В следующем примере показано, как вести журналирование в графический интерфейс Qt. Здесь представлен простой класс QtHandler, который принимает вызываемый объект — слот в главном потоке, выполняющий обновление интерфейса. Также создаётся рабочий поток, чтобы показать, как можно вести журналирование в графический интерфейс как из самого интерфейса (с помощью кнопки для ручной записи сообщений), так и из рабочего потока, выполняющего задачу в фоновом режиме (в данном случае он просто записывает сообщения случайных уровней с небольшими случайными задержками между ними).

Рабочий поток реализован с помощью класса Qt QThread, а не модуля threading, поскольку в некоторых случаях необходимо использовать QThread, который обеспечивает более тесную интеграцию с другими компонентами Qt.

Код должен работать с недавними версиями любого из следующих пакетов: PySide6, PyQt6, PySide2 или PyQt5. Этот подход можно адаптировать и для более ранних версий Qt. Подробные сведения см. в комментариях к фрагменту кода.

import datetime
import logging
import random
import sys
import time

# Deal with minor differences between different Qt packages
try:
    from PySide6 import QtCore, QtGui, QtWidgets
    Signal = QtCore.Signal
    Slot = QtCore.Slot
except ImportError:
    try:
        from PyQt6 import QtCore, QtGui, QtWidgets
        Signal = QtCore.pyqtSignal
        Slot = QtCore.pyqtSlot
    except ImportError:
        try:
            from PySide2 import QtCore, QtGui, QtWidgets
            Signal = QtCore.Signal
            Slot = QtCore.Slot
        except ImportError:
            from PyQt5 import QtCore, QtGui, QtWidgets
            Signal = QtCore.pyqtSignal
            Slot = QtCore.pyqtSlot

logger = logging.getLogger(__name__)


#
# Signals need to be contained in a QObject or subclass in order to be correctly
# initialized.
#
class Signaller(QtCore.QObject):
    signal = Signal(str, logging.LogRecord)

#
# Output to a Qt GUI is only supposed to happen on the main thread. So, this
# handler is designed to take a slot function which is set up to run in the main
# thread. In this example, the function takes a string argument which is a
# formatted log message, and the log record which generated it. The formatted
# string is just a convenience - you could format a string for output any way
# you like in the slot function itself.
#
# You specify the slot function to do whatever GUI updates you want. The handler
# doesn't know or care about specific UI elements.
#
class QtHandler(logging.Handler):
    def __init__(self, slotfunc, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.signaller = Signaller()
        self.signaller.signal.connect(slotfunc)

    def emit(self, record):
        s = self.format(record)
        self.signaller.signal.emit(s, record)

#
# This example uses QThreads, which means that the threads at the Python level
# are named something like "Dummy-1". The function below gets the Qt name of the
# current thread.
#
def ctname():
    return QtCore.QThread.currentThread().objectName()


#
# Used to generate random levels for logging.
#
LEVELS = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
          logging.CRITICAL)

#
# This worker class represents work that is done in a thread separate to the
# main thread. The way the thread is kicked off to do work is via a button press
# that connects to a slot in the worker.
#
# Because the default threadName value in the LogRecord isn't much use, we add
# a qThreadName which contains the QThread name as computed above, and pass that
# value in an "extra" dictionary which is used to update the LogRecord with the
# QThread name.
#
# This example worker just outputs messages sequentially, interspersed with
# random delays of the order of a few seconds.
#
class Worker(QtCore.QObject):
    @Slot()
    def start(self):
        extra = {'qThreadName': ctname() }
        logger.debug('Started work', extra=extra)
        i = 1
        # Let the thread run until interrupted. This allows reasonably clean
        # thread termination.
        while not QtCore.QThread.currentThread().isInterruptionRequested():
            delay = 0.5 + random.random() * 2
            time.sleep(delay)
            try:
                if random.random() < 0.1:
                    raise ValueError('Exception raised: %d' % i)
                else:
                    level = random.choice(LEVELS)
                    logger.log(level, 'Message after delay of %3.1f: %d', delay, i, extra=extra)
            except ValueError as e:
                logger.exception('Failed: %s', e, extra=extra)
            i += 1

#
# Implement a simple UI for this cookbook example. This contains:
#
# * A read-only text edit window which holds formatted log messages
# * A button to start work and log stuff in a separate thread
# * A button to log something from the main thread
# * A button to clear the log window
#
class Window(QtWidgets.QWidget):

    COLORS = {
        logging.DEBUG: 'black',
        logging.INFO: 'blue',
        logging.WARNING: 'orange',
        logging.ERROR: 'red',
        logging.CRITICAL: 'purple',
    }

    def __init__(self, app):
        super().__init__()
        self.app = app
        self.textedit = te = QtWidgets.QPlainTextEdit(self)
        # Set whatever the default monospace font is for the platform
        f = QtGui.QFont('nosuchfont')
        if hasattr(f, 'Monospace'):
            f.setStyleHint(f.Monospace)
        else:
            f.setStyleHint(f.StyleHint.Monospace)  # for Qt6
        te.setFont(f)
        te.setReadOnly(True)
        PB = QtWidgets.QPushButton
        self.work_button = PB('Start background work', self)
        self.log_button = PB('Log a message at a random level', self)
        self.clear_button = PB('Clear log window', self)
        self.handler = h = QtHandler(self.update_status)
        # Remember to use qThreadName rather than threadName in the format string.
        fs = '%(asctime)s %(qThreadName)-12s %(levelname)-8s %(message)s'
        formatter = logging.Formatter(fs)
        h.setFormatter(formatter)
        logger.addHandler(h)
        # Set up to terminate the QThread when we exit
        app.aboutToQuit.connect(self.force_quit)

        # Lay out all the widgets
        layout = QtWidgets.QVBoxLayout(self)
        layout.addWidget(te)
        layout.addWidget(self.work_button)
        layout.addWidget(self.log_button)
        layout.addWidget(self.clear_button)
        self.setFixedSize(900, 400)

        # Connect the non-worker slots and signals
        self.log_button.clicked.connect(self.manual_update)
        self.clear_button.clicked.connect(self.clear_display)

        # Start a new worker thread and connect the slots for the worker
        self.start_thread()
        self.work_button.clicked.connect(self.worker.start)
        # Once started, the button should be disabled
        self.work_button.clicked.connect(lambda : self.work_button.setEnabled(False))

    def start_thread(self):
        self.worker = Worker()
        self.worker_thread = QtCore.QThread()
        self.worker.setObjectName('Worker')
        self.worker_thread.setObjectName('WorkerThread')  # for qThreadName
        self.worker.moveToThread(self.worker_thread)
        # This will start an event loop in the worker thread
        self.worker_thread.start()

    def kill_thread(self):
        # Just tell the worker to stop, then tell it to quit and wait for that
        # to happen
        self.worker_thread.requestInterruption()
        if self.worker_thread.isRunning():
            self.worker_thread.quit()
            self.worker_thread.wait()
        else:
            print('worker has already exited.')

    def force_quit(self):
        # For use when the window is closed
        if self.worker_thread.isRunning():
            self.kill_thread()

    # The functions below update the UI and run in the main thread because
    # that's where the slots are set up

    @Slot(str, logging.LogRecord)
    def update_status(self, status, record):
        color = self.COLORS.get(record.levelno, 'black')
        s = '<pre><font color="%s">%s</font></pre>' % (color, status)
        self.textedit.appendHtml(s)

    @Slot()
    def manual_update(self):
        # This function uses the formatted message passed in, but also uses
        # information from the record to format the message in an appropriate
        # color according to its severity (level).
        level = random.choice(LEVELS)
        extra = {'qThreadName': ctname() }
        logger.log(level, 'Manually logged!', extra=extra)

    @Slot()
    def clear_display(self):
        self.textedit.clear()


def main():
    QtCore.QThread.currentThread().setObjectName('MainThread')
    logging.getLogger().setLevel(logging.DEBUG)
    app = QtWidgets.QApplication(sys.argv)
    example = Window(app)
    example.show()
    if hasattr(app, 'exec'):
        rc = app.exec()
    else:
        rc = app.exec_()
    sys.exit(rc)

if __name__=='__main__':
    main()

Запись в syslog с поддержкой RFC 5424

Хотя стандарт RFC 5424 был опубликован в 2009 году, большинство серверов syslog по умолчанию настроены на использование более старого стандарта RFC 3164, появившегося в 2001 году. Когда в 2003 году в Python был добавлен logging, он поддерживал более ранний (и единственный существовавший на тот момент) протокол. После появления RFC 5424 этот стандарт не получил широкого распространения на серверах syslog, поэтому функциональность SysLogHandler не обновлялась.

В RFC 5424 есть полезные возможности, например поддержка структурированных данных. Если вам нужно вести журнал на сервере syslog с поддержкой этого стандарта, это можно сделать с помощью обработчика-подкласса, похожего на следующий:

import datetime
import logging.handlers
import re
import socket
import time

class SysLogHandler5424(logging.handlers.SysLogHandler):

    tz_offset = re.compile(r'([+-]\d{2})(\d{2})$')
    escaped = re.compile(r'([\]"\\])')

    def __init__(self, *args, **kwargs):
        self.msgid = kwargs.pop('msgid', None)
        self.appname = kwargs.pop('appname', None)
        super().__init__(*args, **kwargs)

    def format(self, record):
        version = 1
        asctime = datetime.datetime.fromtimestamp(record.created).isoformat()
        m = self.tz_offset.match(time.strftime('%z'))
        has_offset = False
        if m and time.timezone:
            hrs, mins = m.groups()
            if int(hrs) or int(mins):
                has_offset = True
        if not has_offset:
            asctime += 'Z'
        else:
            asctime += f'{hrs}:{mins}'
        try:
            hostname = socket.gethostname()
        except Exception:
            hostname = '-'
        appname = self.appname or '-'
        procid = record.process
        msgid = '-'
        msg = super().format(record)
        sdata = '-'
        if hasattr(record, 'structured_data'):
            sd = record.structured_data
            # This should be a dict where the keys are SD-ID and the value is a
            # dict mapping PARAM-NAME to PARAM-VALUE (refer to the RFC for what these
            # mean)
            # There's no error checking here - it's purely for illustration, and you
            # can adapt this code for use in production environments
            parts = []

            def replacer(m):
                g = m.groups()
                return '\\' + g[0]

            for sdid, dv in sd.items():
                part = f'[{sdid}'
                for k, v in dv.items():
                    s = str(v)
                    s = self.escaped.sub(replacer, s)
                    part += f' {k}="{s}"'
                part += ']'
                parts.append(part)
            sdata = ''.join(parts)
        return f'{version} {asctime} {hostname} {appname} {procid} {msgid} {sdata} {msg}'

Чтобы полностью понять приведённый выше код, нужно знать RFC 5424; кроме того, ваши требования могут немного отличаться (например, в том, как передавать структурированные данные в журнал). Тем не менее приведённый выше код можно адаптировать под ваши конкретные потребности. С этим обработчиком структурированные данные можно передавать примерно так:

sd = {
    'foo@12345': {'bar': 'baz', 'baz': 'bozz', 'fizz': r'buzz'},
    'foo@54321': {'rab': 'baz', 'zab': 'bozz', 'zzif': r'buzz'}
}
extra = {'structured_data': sd}
i = 1
logger.debug('Message %d', i, extra=extra)

Как использовать регистратор в качестве потока вывода

Иногда требуется взаимодействовать со сторонним API, который ожидает объект, похожий на файл, для записи данных, но вы хотите направить вывод API в регистратор. Это можно сделать с помощью класса, который предоставляет регистратор через файловый интерфейс. Ниже приведён короткий скрипт, демонстрирующий такой класс:

import logging

class LoggerWriter:
    def __init__(self, logger, level):
        self.logger = logger
        self.level = level

    def write(self, message):
        if message != '\n':  # avoid printing bare newlines, if you like
            self.logger.log(self.level, message)

    def flush(self):
        # doesn't actually do anything, but might be expected of a file-like
        # object - so optional depending on your situation
        pass

    def close(self):
        # doesn't actually do anything, but might be expected of a file-like
        # object - so optional depending on your situation. You might want
        # to set a flag so that later calls to write raise an exception
        pass

def main():
    logging.basicConfig(level=logging.DEBUG)
    logger = logging.getLogger('demo')
    info_fp = LoggerWriter(logger, logging.INFO)
    debug_fp = LoggerWriter(logger, logging.DEBUG)
    print('An INFO message', file=info_fp)
    print('A DEBUG message', file=debug_fp)

if __name__ == "__main__":
    main()

При запуске этот скрипт выводит

INFO:demo:An INFO message
DEBUG:demo:A DEBUG message

Можно также перенаправить sys.stdout и sys.stderr с помощью LoggerWriter, например так:

import sys

sys.stdout = LoggerWriter(logger, logging.INFO)
sys.stderr = LoggerWriter(logger, logging.WARNING)

Это следует делать после настройки журналирования. В приведённом выше примере для этого используется вызов basicConfig() (значение sys.stderr используется до того, как его заменит экземпляр LoggerWriter). Тогда результат будет выглядеть примерно так:

>>> print('Foo')
INFO:demo:Foo
>>> print('Bar', file=sys.stderr)
WARNING:demo:Bar
>>>

Разумеется, в приведённых выше примерах показан вывод в формате, используемом basicConfig(), но при настройке журналирования можно использовать другой форматировщик.

Обратите внимание: при описанном выше подходе многое зависит от буферизации и последовательности перехватываемых вызовов записи. Например, если использовать приведённое выше определение LoggerWriter и следующий фрагмент:

sys.stderr = LoggerWriter(logger, logging.WARNING)
1 / 0

то при запуске скрипта получится

WARNING:demo:Traceback (most recent call last):

WARNING:demo:  File "/home/runner/cookbook-loggerwriter/test.py", line 53, in <module>

WARNING:demo:
WARNING:demo:main()
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/test.py", line 49, in main

WARNING:demo:
WARNING:demo:1 / 0
WARNING:demo:ZeroDivisionError
WARNING:demo::
WARNING:demo:division by zero

Как видите, такой вывод неидеален. Это происходит потому, что код, записывающий данные в sys.stderr, выполняет несколько операций записи, каждая из которых приводит к созданию отдельной строки журнала (например, трёх последних строк выше). Чтобы решить эту проблему, нужно буферизовать данные и выводить строки журнала только при обнаружении символа новой строки. Воспользуемся немного более удачной реализацией LoggerWriter:

class BufferingLoggerWriter(LoggerWriter):
    def __init__(self, logger, level):
        super().__init__(logger, level)
        self.buffer = ''

    def write(self, message):
        if '\n' not in message:
            self.buffer += message
        else:
            parts = message.split('\n')
            if self.buffer:
                s = self.buffer + parts.pop(0)
                self.logger.log(self.level, s)
            self.buffer = parts.pop()
            for part in parts:
                self.logger.log(self.level, part)

Она просто буферизует данные до появления символа новой строки, а затем записывает в журнал полные строки. Такой подход даёт более качественный вывод:

WARNING:demo:Traceback (most recent call last):
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/main.py", line 55, in <module>
WARNING:demo:    main()
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/main.py", line 52, in main
WARNING:demo:    1/0
WARNING:demo:ZeroDivisionError: division by zero

Антипаттерны

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

Другие ресурсы