syslog — Программирование для библиотеки syslog Unix

Этот модуль предоставляет интерфейс к библиотечным функциям Unix syslog. Обратитесь к страницам руководства Unix для подробного описания syslog объекта.

Этот модуль оборачивает семейство системных функций syslog. Чистая библиотека Python, способная общаться с сервером syslog, доступна в модуле logging.handlers в качестве SysLogHandler.

Модуль определяет следующие функции:

syslog.syslog(message)

syslog.syslog(priority, message)

Отправляет строку message в системный логгер. В конце добавляется символ новой строки, если необходимо. Каждый запрос сопровождается приоритетом, составленным из facility и level. Необязательный аргумент priority, который по умолчанию равен LOG_INFO, определяет приоритет сообщения. Если объект facility не закодирован в priority с помощью логического ИЛИ (LOG_INFO | LOG_USER), используется значение, заданное в вызове openlog().

Если функция openlog() не была вызвана до вызова syslog(), функция openlog() будет вызвана без аргументов.

Вызывает событие аудита аудита syslog.syslog с аргументами priority, message.

Изменено в версии 3.2: В предыдущих версиях функция openlog() не вызывалась автоматически, если её не вызывать до вызова syslog(), перепоручая вызов openlog() реализации syslog.

Изменено в версии 3.12: Эта функция ограничена в дочерних интерпретаторах. (Затронуты только коды, работающие в нескольких интерпретаторах, и ограничение не актуально для большинства пользователей.) Функция openlog() должна быть вызвана в главном интерпретаторе перед использованием syslog() в дочернем интерпретаторе. В противном случае будет возбуждено исключение RuntimeError.

syslog.openlog([ident[, logoption[, facility]]])

Параметры логгирования последующих вызовов syslog() могут быть установлены вызовом openlog(). Модуль syslog() вызовет openlog() без аргументов, если журнал не открыт.

Необязательный ключевой аргумент ident — строка, которая добавляется к каждому сообщению, по умолчанию это sys.argv[0], с удалением начальных компонентов пути. Необязательный ключевой аргумент logoption (по умолчанию 0) — битовое поле; см. ниже возможные значения для комбинирования. Необязательный ключевой аргумент facility (по умолчанию LOG_USER) задаёт значение объекта по умолчанию для сообщений, у которых явно не указан объект facility.

Вызывает событие аудита аудита syslog.openlog с аргументами ident, logoption, facility.

Изменено в версии 3.2: В предыдущих версиях ключевые аргументы не допускались, а ident был обязательным.

Изменено в версии 3.12: Эта функция ограничена в дочерних интерпретаторах. (Затронуты только коды, работающие в нескольких интерпретаторах, и ограничение не актуально для большинства пользователей.) Функция может быть вызвана только в главном интерпретаторе. При вызове в подинтерпретаторе возбуждается исключение RuntimeError.

syslog.closelog()

Сбрасывает значения модуля syslog и вызывает системную библиотечную функцию closelog().

Это заставляет модуль вести себя так же, как при первоначальном импорте. Например, openlog() будет вызываться при первом вызове syslog() (если openlog() ещё не был вызван), и параметры ident и другие параметры openlog() сбрасываются до значений по умолчанию.

Вызывает событие аудита аудита syslog.closelog без аргументов.

Изменено в версии 3.12: Эта функция ограничена в дочерних интерпретаторах. (Затронуты только коды, работающие в нескольких интерпретаторах, и ограничение не актуально для большинства пользователей.) Функция может быть вызвана только в главном интерпретаторе. При вызове в подинтерпретаторе возбуждается исключение RuntimeError.

syslog.setlogmask(maskpri)

Устанавливает маску приоритетов на maskpri и возвращает предыдущее значение маски. Вызовы syslog() с уровнем приоритета, не заданным в maskpri, игнорируются. По умолчанию все приоритеты регистрируются. Функция LOG_MASK(pri) вычисляет маску для отдельного приоритета pri. Функция LOG_UPTO(pri) вычисляет маску для всех приоритетов до и включая pri.

Вызывает событие аудита аудита syslog.setlogmask с аргументом maskpri.

Модуль определяет следующие константы:

Уровни приоритетов (высокий к низкому):

LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG.

Типы:

LOG_KERN, LOG_USER, LOG_MAIL, LOG_DAEMON, LOG_AUTH, LOG_LPR, LOG_NEWS, LOG_UUCP, LOG_CRON, LOG_SYSLOG, LOG_LOCAL0 до LOG_LOCAL7, и, если определено в <syslog.h>, LOG_AUTHPRIV.

Параметры логгирования:

LOG_PID, LOG_CONS, LOG_NDELAY, и, если определено в <syslog.h>, LOG_ODELAY, LOG_NOWAIT, и LOG_PERROR.