mirror of
https://github.com/python/cpython.git
synced 2024-11-29 21:05:33 +08:00
8569e582f8
svn+ssh://pythondev@svn.python.org/python/trunk ........ r80030 | georg.brandl | 2010-04-13 08:43:54 +0200 (Di, 13 Apr 2010) | 1 line Get rid of multi-row cells. ........ r80067 | georg.brandl | 2010-04-14 10:53:38 +0200 (Mi, 14 Apr 2010) | 1 line #5341: typo. ........ r80069 | georg.brandl | 2010-04-14 15:50:31 +0200 (Mi, 14 Apr 2010) | 1 line Add an x-ref to where the O_ constants are documented and move the SEEK_ constants after lseek(). ........ r80080 | georg.brandl | 2010-04-14 21:16:38 +0200 (Mi, 14 Apr 2010) | 1 line #8399: add note about Windows and O_BINARY. ........ r80081 | georg.brandl | 2010-04-14 23:34:44 +0200 (Mi, 14 Apr 2010) | 1 line #5250: document __instancecheck__ and __subclasscheck__. I hope the part about the class/metaclass distinction is understandable. ........ r80084 | georg.brandl | 2010-04-14 23:46:45 +0200 (Mi, 14 Apr 2010) | 1 line Fix missing. ........ r80432 | georg.brandl | 2010-04-24 10:56:58 +0200 (Sa, 24 Apr 2010) | 1 line Markup fixes. ........ r80433 | georg.brandl | 2010-04-24 11:08:10 +0200 (Sa, 24 Apr 2010) | 1 line #7507: quote "!" in pipes.quote(); it is a special character for some shells. ........ r80465 | georg.brandl | 2010-04-25 12:29:17 +0200 (So, 25 Apr 2010) | 1 line Remove LaTeXy index entry syntax. ........ r80466 | georg.brandl | 2010-04-25 12:54:42 +0200 (So, 25 Apr 2010) | 1 line Patch from Tim Hatch: Better cross-referencing in socket and winreg docs. ........ r80467 | georg.brandl | 2010-04-25 12:55:16 +0200 (So, 25 Apr 2010) | 1 line Patch from Tim Hatch: Remove reference to winreg being the fabled high-level registry interface. ........ r80468 | georg.brandl | 2010-04-25 12:55:58 +0200 (So, 25 Apr 2010) | 1 line Patch from Tim Hatch: Minor spelling changes to _winreg docs. ........ r80469 | georg.brandl | 2010-04-25 12:56:41 +0200 (So, 25 Apr 2010) | 1 line Fix code example to have valid syntax so that it can be highlighted. ........ r80470 | georg.brandl | 2010-04-25 12:57:15 +0200 (So, 25 Apr 2010) | 1 line Patch from Tim Hatch: Make socket setblocking <-> settimeout examples symmetric. ........ r81059 | georg.brandl | 2010-05-10 23:02:51 +0200 (Mo, 10 Mai 2010) | 1 line #8642: fix wrong function name. ........ r81065 | georg.brandl | 2010-05-10 23:46:50 +0200 (Mo, 10 Mai 2010) | 1 line Fix reference direction. ........ r81066 | georg.brandl | 2010-05-10 23:50:57 +0200 (Mo, 10 Mai 2010) | 1 line Consolidate deprecation messages. ........ r81067 | georg.brandl | 2010-05-10 23:51:33 +0200 (Mo, 10 Mai 2010) | 1 line Fix typo. ........
108 lines
4.0 KiB
ReStructuredText
108 lines
4.0 KiB
ReStructuredText
:mod:`syslog` --- Unix syslog library routines
|
|
==============================================
|
|
|
|
.. module:: syslog
|
|
:platform: Unix
|
|
:synopsis: An interface to the Unix syslog library routines.
|
|
|
|
|
|
This module provides an interface to the Unix ``syslog`` library routines.
|
|
Refer to the Unix manual pages for a detailed description of the ``syslog``
|
|
facility.
|
|
|
|
This module wraps the system ``syslog`` family of routines. A pure Python
|
|
library that can speak to a syslog server is available in the
|
|
:mod:`logging.handlers` module as :class:`SysLogHandler`.
|
|
|
|
The module defines the following functions:
|
|
|
|
|
|
.. function:: syslog([priority,] message)
|
|
|
|
Send the string *message* to the system logger. A trailing newline is added
|
|
if necessary. Each message is tagged with a priority composed of a
|
|
*facility* and a *level*. The optional *priority* argument, which defaults
|
|
to :const:`LOG_INFO`, determines the message priority. If the facility is
|
|
not encoded in *priority* using logical-or (``LOG_INFO | LOG_USER``), the
|
|
value given in the :func:`openlog` call is used.
|
|
|
|
If :func:`openlog` has not been called prior to the call to :func:`syslog`,
|
|
``openlog()`` will be called with no arguments.
|
|
|
|
|
|
.. function:: openlog([ident[, logopt[, facility]]])
|
|
|
|
Logging options of subsequent :func:`syslog` calls can be set by calling
|
|
:func:`openlog`. :func:`syslog` will call :func:`openlog` with no arguments
|
|
if the log is not currently open.
|
|
|
|
The optional *ident* keyword argument is a string which is prepended to every
|
|
message, and defaults to ``sys.argv[0]`` with leading path components
|
|
stripped. The optional *logopt* keyword argument (default is 0) is a bit
|
|
field -- see below for possible values to combine. The optional *facility*
|
|
keyword argument (default is :const:`LOG_USER`) sets the default facility for
|
|
messages which do not have a facility explicitly encoded.
|
|
|
|
.. versionchanged:: 3.2
|
|
In previous versions, keyword arguments were not allowed, and *ident* was
|
|
required. The default for *ident* was dependent on the system libraries,
|
|
and often was ``python`` instead of the name of the python program file.
|
|
|
|
|
|
.. function:: closelog()
|
|
|
|
Reset the syslog module values and call the system library ``closelog()``.
|
|
|
|
This causes the module to behave as it does when initially imported. For
|
|
example, :func:`openlog` will be called on the first :func:`syslog` call (if
|
|
:func:`openlog` hasn't already been called), and *ident* and other
|
|
:func:`openlog` parameters are reset to defaults.
|
|
|
|
|
|
.. function:: setlogmask(maskpri)
|
|
|
|
Set the priority mask to *maskpri* and return the previous mask value. Calls
|
|
to :func:`syslog` with a priority level not set in *maskpri* are ignored.
|
|
The default is to log all priorities. The function ``LOG_MASK(pri)``
|
|
calculates the mask for the individual priority *pri*. The function
|
|
``LOG_UPTO(pri)`` calculates the mask for all priorities up to and including
|
|
*pri*.
|
|
|
|
The module defines the following constants:
|
|
|
|
Priority levels (high to low):
|
|
:const:`LOG_EMERG`, :const:`LOG_ALERT`, :const:`LOG_CRIT`, :const:`LOG_ERR`,
|
|
:const:`LOG_WARNING`, :const:`LOG_NOTICE`, :const:`LOG_INFO`,
|
|
:const:`LOG_DEBUG`.
|
|
|
|
Facilities:
|
|
:const:`LOG_KERN`, :const:`LOG_USER`, :const:`LOG_MAIL`, :const:`LOG_DAEMON`,
|
|
:const:`LOG_AUTH`, :const:`LOG_LPR`, :const:`LOG_NEWS`, :const:`LOG_UUCP`,
|
|
:const:`LOG_CRON` and :const:`LOG_LOCAL0` to :const:`LOG_LOCAL7`.
|
|
|
|
Log options:
|
|
:const:`LOG_PID`, :const:`LOG_CONS`, :const:`LOG_NDELAY`, :const:`LOG_NOWAIT`
|
|
and :const:`LOG_PERROR` if defined in ``<syslog.h>``.
|
|
|
|
|
|
Examples
|
|
--------
|
|
|
|
Simple example
|
|
~~~~~~~~~~~~~~
|
|
|
|
A simple set of examples::
|
|
|
|
import syslog
|
|
|
|
syslog.syslog('Processing started')
|
|
if error:
|
|
syslog.syslog(syslog.LOG_ERR, 'Processing started')
|
|
|
|
An example of setting some log options, these would include the process ID in
|
|
logged messages, and write the messages to the destination facility used for
|
|
mail logging::
|
|
|
|
syslog.openlog(logopt=syslog.LOG_PID, facility=syslog.LOG_MAIL)
|
|
syslog.syslog('E-mail processing initiated...')
|