Unix syslog 库例程

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

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

这个模块定义了以下函数：

  • syslog.syslog(message)
  • syslog.syslog(priority, message)
  • Send the string message to the system logger. A trailing newline is addedif necessary. Each message is tagged with a priority composed of afacility and a level. The optional priority argument, which defaultsto LOGINFO, determines the message priority. If the facility isnot encoded in _priority using logical-or (LOG_INFO | LOG_USER), thevalue given in the openlog() call is used.

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

  • syslog.openlog([ident[, logoption[, facility]]])
  • Logging options of subsequent syslog() calls can be set by callingopenlog(). syslog() will call openlog() with no argumentsif the log is not currently open.

The optional ident keyword argument is a string which is prepended to everymessage, and defaults to sys.argv[0] with leading path componentsstripped. The optional logoption keyword argument (default is 0) is a bitfield — see below for possible values to combine. The optional _facility_keyword argument (default is LOG_USER) sets the default facility formessages which do not have a facility explicitly encoded.

在 3.2 版更改: In previous versions, keyword arguments were not allowed, and ident wasrequired. The default for ident was dependent on the system libraries,and often was python instead of the name of the Python program file.

  • syslog.closelog()
  • Reset the syslog module values and call the system library closelog().

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

  • syslog.setlogmask(maskpri)
  • Set the priority mask to maskpri and return the previous mask value. Callsto syslog() with a priority level not set in maskpri are ignored.The default is to log all priorities. The function LOGMASK(pri)calculates the mask for the individual priority _pri. The functionLOGUPTO(pri) calculates the mask for all priorities up to and including_pri.

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.

例子

Simple example

A simple set of examples:

  1. import syslog
  2.  
  3. syslog.syslog('Processing started')
  4. if error:
  5.     syslog.syslog(syslog.LOG_ERR, 'Processing started')

An example of setting some log options, these would include the process ID inlogged messages, and write the messages to the destination facility used formail logging:

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