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

Этот модуль предоставляет интерфейс к процедурам библиотеки 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.openlog([ident[, logoption[, facility]]])

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

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

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

syslog.closelog()

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

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

syslog.setlogmask(maskpri)

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

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

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

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

Объекты facilities:

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.

35.13.1. Примеры

35.13.1.1. Простой пример

Простой набор примеров:

import syslog

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

Пример установки некоторых параметров логгирования, которые включают идентификатор процесса в регистрируемых сообщениях и запись сообщений в объект facility, используемый для регистрации почты:

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