syslog — Протоколы Unix syslog библиотеки

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

Этот модуль оборачивает семейство системных функций 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.

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

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

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

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

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

syslog.closelog()

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

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

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

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.

import syslog

syslog.syslog('Processing started')
if error:
    syslog.syslog(syslog.LOG_ERR, 'Processing started')

syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL)
syslog.syslog('E-mail processing initiated...')