syslog — Unix syslog library routines¶

This module provides an interface to the Unixsyslog library routines.Refer to the Unix manual pages for a detailed description of thesyslogfacility.

This module wraps the systemsyslog family of routines. A pure Pythonlibrary that can speak to a syslog server is available in thelogging.handlers module asSysLogHandler.

The module defines the following functions:

syslog.syslog(message)¶

syslog.syslog(priority,message)

Send the stringmessage to the system logger. A trailing newline is addedif necessary. Each message is tagged with a priority composed of afacility and alevel. The optionalpriority argument, which defaultstoLOG_INFO, determines the message priority. If the facility isnot encoded inpriority using logical-or (LOG_INFO|LOG_USER), thevalue given in theopenlog() call is used.

Ifopenlog() has not been called prior to the call tosyslog(),openlog() will be called with no arguments.

Raises anauditing eventsyslog.syslog with argumentspriority,message.

Changed in version 3.2:In previous versions,openlog() would not be called automatically ifit wasn’t called prior to the call tosyslog(), deferring to the syslogimplementation to callopenlog().

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

Logging options of subsequentsyslog() calls can be set by callingopenlog().syslog() will callopenlog() with no argumentsif the log is not currently open.

The optionalident keyword argument is a string which is prepended to everymessage, and defaults tosys.argv[0] with leading path componentsstripped. The optionallogoption keyword argument (default is 0) is a bitfield – see below for possible values to combine. The optionalfacilitykeyword argument (default isLOG_USER) sets the default facility formessages which do not have a facility explicitly encoded.

Raises anauditing eventsyslog.openlog with argumentsident,logoption,facility.

Changed in version 3.2:In previous versions, keyword arguments were not allowed, andident wasrequired.

syslog.closelog()¶

Reset the syslog module values and call the system librarycloselog().

This causes the module to behave as it does when initially imported. Forexample,openlog() will be called on the firstsyslog() call (ifopenlog() hasn’t already been called), andident and otheropenlog() parameters are reset to defaults.

Raises anauditing eventsyslog.closelog with no arguments.

syslog.setlogmask(maskpri)¶

Set the priority mask tomaskpri and return the previous mask value. Callstosyslog() with a priority level not set inmaskpri are ignored.The default is to log all priorities. The functionLOG_MASK(pri)calculates the mask for the individual prioritypri. The functionLOG_UPTO(pri) calculates the mask for all priorities up to and includingpri.

Raises anauditing eventsyslog.setlogmask with argumentmaskpri.

The module defines the following constants:

Priority levels (high to low):

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 toLOG_LOCAL7, and, if defined in<syslog.h>,LOG_AUTHPRIV.

Log options:

LOG_PID,LOG_CONS,LOG_NDELAY, and, if definedin<syslog.h>,LOG_ODELAY,LOG_NOWAIT, andLOG_PERROR.

importsyslogsyslog.syslog('Processing started')iferror:syslog.syslog(syslog.LOG_ERR,'Processing started')

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