Yf @ s0 d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z m
Z
m Z d d l Z y d d l
Z
Wn e k
r d Z
Yn Xd Z d Z d Z d Z d Z d Z d( Z Gd d d e j Z Gd
d d e Z Gd d d e Z Gd d d e j Z Gd d d e j Z Gd d d e Z Gd d d e j Z Gd d d e j Z Gd d d e j Z Gd d d e j Z! Gd d d e j Z" Gd! d" d" e" Z# Gd# d$ d$ e j Z$ e
r,Gd% d& d& e% Z& d S))z
Additional handlers for the logging package for Python. The core package is
based on PEP 282 and comments thereto in comp.lang.python.
Copyright (C) 2001-2016 Vinay Sajip. All Rights Reserved.
To use, simply 'import logging.handlers' and log away!
N)ST_DEVST_INOST_MTIMEi<# i=# i># i?# i < c @ sL e Z d Z d Z d d d d Z d d Z d d Z d
d Z d S) BaseRotatingHandlerz
Base class for handlers that rotate log files at a certain point.
Not meant to be instantiated directly. Instead, use RotatingFileHandler
or TimedRotatingFileHandler.
NFc C sD t j j | | | | | | | _ | | _ d | _ d | _ d S)zA
Use the specified filename for streamed logging
N)logging FileHandler__init__modeencodingnamerrotator)selffilenamer r delay r 5/opt/alt/python35/lib64/python3.5/logging/handlers.pyr
5 s
z BaseRotatingHandler.__init__c C sV y0 | j | r | j t j j | | Wn t k
rQ | j | Yn Xd S)z
Emit a record.
Output the record to the file, catering for rollover as described
in doRollover().
N)shouldRollover
doRolloverr r emit Exception handleError)r recordr r r r ? s
zBaseRotatingHandler.emitc C s+ t | j s | } n | j | } | S)a
Modify the filename of a log file when rotating.
This is provided so that a custom filename can be provided.
The default implementation calls the 'namer' attribute of the
handler, if it's callable, passing the default name to
it. If the attribute isn't callable (the default is None), the name
is returned unchanged.
:param default_name: The default name for the log file.
)callabler
)r Z default_nameresultr r r rotation_filenameM s
z%BaseRotatingHandler.rotation_filenamec C sH t | j s4 t j j | rD t j | | n | j | | d S)aL
When rotating, rotate the current log.
The default implementation calls the 'rotator' attribute of the
handler, if it's callable, passing the source and dest arguments to
it. If the attribute isn't callable (the default is None), the source
is simply renamed to the destination.
:param source: The source filename. This is normally the base
filename, e.g. 'test.log'
:param dest: The destination filename. This is normally
what the source is rotated to, e.g. 'test.log.1'.
N)r r ospathexistsrename)r sourcedestr r r rotate` s zBaseRotatingHandler.rotate)__name__
__module__ __qualname____doc__r
r r r# r r r r r / s
r c @ sI e Z d Z d Z d d d d d d d Z d d Z d
d Z d S) RotatingFileHandlerz
Handler for logging to a set of files, which switches from one file
to the next when the current file reaches a certain size.
ar NFc C sA | d k r d } t j | | | | | | | _ | | _ d S)a
Open the specified file and use it as the stream for logging.
By default, the file grows indefinitely. You can specify particular
values of maxBytes and backupCount to allow the file to rollover at
a predetermined size.
Rollover occurs whenever the current log file is nearly maxBytes in
length. If backupCount is >= 1, the system will successively create
new files with the same pathname as the base file, but with extensions
".1", ".2" etc. appended to it. For example, with a backupCount of 5
and a base file name of "app.log", you would get "app.log",
"app.log.1", "app.log.2", ... through to "app.log.5". The file being
written to is always "app.log" - when it gets filled up, it is closed
and renamed to "app.log.1", and if files "app.log.1", "app.log.2" etc.
exist, then they are renamed to "app.log.2", "app.log.3" etc.
respectively.
If maxBytes is zero, rollover never occurs.
r r) N)r r
maxBytes backupCount)r r r r* r+ r r r r r r
z s
z RotatingFileHandler.__init__c C s3 | j r | j j d | _ | j d k rx t | j d d d D] } | j d | j | f } | j d | j | d f } t j j | rH t j j | r t j | t j
| | qH W| j | j d } t j j | rt j | | j | j | | j s/| j
| _ d S)z<
Do a rollover, as described in __init__().
Nr z%s.%dz.1)streamcloser+ ranger baseFilenamer r r remover r# r _open)r iZsfndfnr r r r s$
z RotatingFileHandler.doRolloverc C s} | j d k r | j | _ | j d k ry d | j | } | j j d d | j j t | | j k ry d Sd S)z
Determine if rollover should occur.
Basically, see if the supplied record would cause the file to exceed
the size limit we have.
Nr z%s
r, )r. r3 r* formatseektelllen)r r msgr r r r s "z"RotatingFileHandler.shouldRollover)r$ r% r& r' r
r r r r r r r( u s r( c @ sg e Z d Z d Z d d d d d d d d d Z d d
Z d d Z d
d Z d d Z d S)TimedRotatingFileHandlerz
Handler for logging to a file, rotating the log file at certain timed
intervals.
If backupCount is > 0, when rollover is done, no more than backupCount
files are kept - the oldest ones are deleted.
hr, r NFc
C s; t j | | d | | | j | _ | | _ | | _ | | _ | j d k rp d | _ d | _ d | _ nP| j d k r d | _ d | _ d | _ n#| j d
k r d | _ d | _ d | _ n | j d
k s | j d k rd | _ d | _ d | _ n | j j
d rd | _ t | j d k rIt d | j | j d d k so| j d d k rt d | j t
| j d | _ d | _ d | _ n t d | j t j | j t j | _ | j | | _ t j j | rt j | t } n t
t j } | j | | _ d S) Nr) Sr, z%Y-%m-%d_%H-%M-%Sz-^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2}(\.\w+)?$Mr z%Y-%m-%d_%H-%Mz'^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}(\.\w+)?$Hz %Y-%m-%d_%Hz!^\d{4}-\d{2}-\d{2}_\d{2}(\.\w+)?$DMIDNIGHTr z%Y-%m-%dz^\d{4}-\d{2}-\d{2}(\.\w+)?$W r6 zHYou must specify a day for weekly rollover from 0 to 6 (0 is Monday): %s06z-Invalid day specified for weekly rollover: %sz'Invalid rollover interval specified: %si i iQ i iQ i: )r r
upperwhenr+ utcatTimeintervalsuffixextMatch
startswithr:
ValueErrorint dayOfWeekrecompileASCIIr r r statr timecomputeRollover
rolloverAt)
r r rH rK r+ r r rI rJ tr r r r
sJ
& z!TimedRotatingFileHandler.__init__c C s | | j } | j d k s. | j j d r| j rI t j | } n t j | } | d } | d } | d } | d } | j d k r t } n( | j j d | j j
d | j j } | | d | d | } | d k r | t 7} | d
d } | | } | j j d r| }
|
| j k r|
| j k rN| j |
} n d |
| j d
} | | d } | j s| d }
t j | d } |
| k r|
sd } n d
} | | 7} | } | S)zI
Work out the rollover time based on the specified time.
rB rC Nr r r, rD r i i iQ r- r- i)
rK rH rN rI rV gmtime localtimerJ _MIDNIGHTZhourZminutesecondrQ )r currentTimer rY Z currentHourZ
currentMinuteZ
currentSecondZ
currentDayZ rotate_tsrZdayZ
daysToWait
newRolloverAtdstNow
dstAtRolloveraddendr r r rW sH
!
z(TimedRotatingFileHandler.computeRolloverc C s) t t j } | | j k r% d Sd S)z
Determine if rollover should occur.
record is not used, as we are just comparing times, but it is needed so
the method signatures are the same
r, r )rP rV rX )r r rY r r r r H s z'TimedRotatingFileHandler.shouldRolloverc C s t j j | j \ } } t j | } g } | d } t | } xb | D]Z } | d | | k rM | | d } | j j | rM | j t j j | | qM W| j
t | | j k r g } n | d t | | j } | S)z
Determine the files to delete when rolling over.
More specific than the earlier method, which just used glob.glob().
.N) r r splitr1 listdirr: rM matchappendjoinsortr+ ) r ZdirNameZbaseNameZ fileNamesr prefixZplenZfileNamerL r r r getFilesToDeleteT s
z)TimedRotatingFileHandler.getFilesToDeletec C s | j r | j j d | _ t t j } t j | d } | j | j } | j ro t j | } nM t j | } | d } | | k r | r d } n d
} t j | | } | j | j
d t j | j | } t
j j | rt
j | | j | j
| | j d k rJx! | j D] } t
j | q3W| j sb| j | _ | j | } x | | k r| | j } qtW| j d k s| j j d r| j rt j | d }
| |
k r| sd } n d } | | 7} | | _ d S)
ax
do a rollover; in this case, a date/time stamp is appended to the filename
when the rollover happens. However, you want the file to be named for the
start of the interval, not the current time. If there is a backup count,
then we have to get a list of matching filenames, sort them and remove
the one with the oldest suffix.
Nr, i rh r rB rC r- r- ir- i)r. r/ rP rV r_ rX rK rI r^ r r1 ZstrftimerL r r r r2 r# r+ rp r r3 rW rH rN ) r rb re rY Z timeTupleZdstThenrg r5 srd rf r r r r k sH
+
z#TimedRotatingFileHandler.doRollover) r$ r% r& r' r
rW r rp r r r r r r< s !6 I r< c @ sC e Z d Z d Z d d d d d Z d d Z d d
Z d S) WatchedFileHandlera
A handler for logging to a file, which watches the file
to see if it has changed while in use. This can happen because of
usage of programs such as newsyslog and logrotate which perform
log file rotation. This handler, intended for use under Unix,
watches the file to see if it has changed since the last emit.
(A file has changed if its device or inode have changed.)
If it has changed, the old file stream is closed, and the file
opened to get a new stream.
This handler is not appropriate for use under Windows, because
under Windows open files cannot be moved or renamed - logging
opens the files with exclusive locks - and so there is no need
for such a handler. Furthermore, ST_INO is not supported under
Windows; stat always returns zero for this value.
This handler is based on a suggestion and patch by Chad J.
Schroeder.
r) NFc C s< t j j | | | | | d \ | _ | _ | j d S)Nr, r- r- )r- r- )r r r
devino _statstream)r r r r r r r r r
s zWatchedFileHandler.__init__c C s@ | j r< t j | j j } | t | t | _ | _ d S)N)r. r fstatfilenor r rs rt )r sresr r r ru s z WatchedFileHandler._statstreamc C s y t j | j } Wn t k
r0 d } Yn X| s^ | t | j k s^ | t | j k r | j d k r | j j | j j
d | _ | j | _ | j t
j j | | d S)z
Emit a record.
First check if the underlying file has changed, and if it
has, close the old stream and reopen the file to get the
current stream.
N)r rU r1 FileNotFoundErrorr rs r rt r. flushr/ r3 ru r r r )r r rx r r r r s
-
zWatchedFileHandler.emit)r$ r% r& r' r
ru r r r r r rr s rr c @ sy e Z d Z d Z d d Z d d d Z d d Z d d
Z d d Z d
d Z d d Z
d d Z d S)
SocketHandlera
A handler class which writes logging records, in pickle format, to
a streaming socket. The socket is kept open across logging calls.
If the peer resets it, an attempt is made to reconnect on the next call.
The pickle which is sent is that of the LogRecord's attribute dictionary
(__dict__), so that the receiver does not need to have the logging module
installed in order to process the logging event.
To unpickle the record at the receiving end into a LogRecord, use the
makeLogRecord function.
c C s t j j | | | _ | | _ | d k r: | | _ n | | f | _ d | _ d | _ d | _ d | _ d | _
d | _ d S)a
Initializes the handler with a specific host address and port.
When the attribute *closeOnError* is set to True - if a socket error
occurs, the socket is silently closed and then reopened on the next
logging call.
NFg ?g >@g @) r Handlerr
hostportaddresssock closeOnError retryTime
retryStartretryMax retryFactor)r r} r~ r r r r
s zSocketHandler.__init__r, c C s | j d k r* t j | j d | } n[ t j t j t j } | j | y | j | j Wn t k
r | j Yn X| S)zr
A factory method which allows subclasses to define the precise
type of socket they want.
Ntimeout)
r~ socketZcreate_connectionr AF_UNIX SOCK_STREAMZ
settimeoutconnectOSErrorr/ )r r r r r r
makeSocket s
zSocketHandler.makeSocketc C s t j } | j d k r$ d } n | | j k } | r y | j | _ d | _ Wnq t k
r | j d k r | j | _ n1 | j | j | _ | j | j k r | j | _ | | j | _ Yn Xd S)z
Try to create a socket, using an exponential backoff with
a max retry time. Thanks to Robert Olson for the original patch
(SF #815911) which has been slightly refactored.
NT) rV r r r r r Z retryPeriodr r )r ZnowZattemptr r r createSocket s
zSocketHandler.createSocketc C se | j d k r | j | j ra y | j j | Wn( t k
r` | j j d | _ Yn Xd S)z
Send a pickled string to the socket.
This function allows for partial sends which can happen when the
network is busy.
N)r r sendallr r/ )r rq r r r send, s
zSocketHandler.sendc C s | j } | r | j | } t | j } | j | d L) r r7 dict__dict__Z
getMessagepoppickledumpsstructZpackr: )r r ZeiZdummydrq Zslenr r r
makePickle? s
zSocketHandler.makePicklec C sB | j r+ | j r+ | j j d | _ n t j j | | d S)z
Handle an error during logging.
An error has occurred during logging. Most likely cause -
connection lost. Close the socket so that we can retry on the
next event.
N)r r r/ r r| r )r r r r r r U s
zSocketHandler.handleErrorc C sF y | j | } | j | Wn t k
rA | j | Yn Xd S)a
Emit a record.
Pickles the record and writes it to the socket in binary format.
If there is an error with the socket, silently drop the packet.
If there was a problem with the socket, re-establishes the
socket.
N)r r r r )r r rq r r r r c s
zSocketHandler.emitc
C sR | j z6 | j } | r/ d | _ | j t j j | Wd | j Xd S)z$
Closes the socket.
N)acquirer r/ r r| release)r r r r r r/ r s
zSocketHandler.closeN) r$ r% r& r' r
r r r r r r r/ r r r r r{ s r{ c @ s: e Z d Z d Z d d Z d d Z d d Z d S) DatagramHandlera
A handler class which writes logging records, in pickle format, to
a datagram socket. The pickle which is sent is that of the LogRecord's
attribute dictionary (__dict__), so that the receiver does not need to
have the logging module installed in order to process the logging event.
To unpickle the record at the receiving end into a LogRecord, use the
makeLogRecord function.
c C s t j | | | d | _ d S)zP
Initializes the handler with a specific host address and port.
FN)r{ r
r )r r} r~ r r r r
s zDatagramHandler.__init__c C s= | j d k r t j } n t j } t j | t j } | S)zu
The factory method of SocketHandler is here overridden to create
a UDP socket (SOCK_DGRAM).
N)r~ r r ZAF_INET
SOCK_DGRAM)r Zfamilyrq r r r r s
zDatagramHandler.makeSocketc C s3 | j d k r | j | j j | | j d S)z
Send a pickled string to a socket.
This function no longer allows for partial sends which can happen
when the network is busy - UDP does not guarantee delivery and
can deliver packets out of sequence.
N)r r sendtor )r rq r r r r s
zDatagramHandler.sendN)r$ r% r& r' r
r r r r r r r s
r c * @ s e Z d Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d Z d Z
d Z d Z d Z d Z d Z d Z d
Z d Z d Z d
Z d Z d Z d Z d Z d Z d Z d Z d Z d e d e d e d e d e d e d e d e
d e d e d e d! e i Z d" e d# e d$ e d% e d& e d' e d( e d) e d* e d+ e d, e d- e
d. e d/ e d0 e d1 e d2 e d3 e d4 e d5 e d6 e i Z! d7 d d8 d d9 d! d: d d; d i Z" d< e# f e
d= d> d? Z$ d@ dA Z% dB dC Z& dD dE Z' dF dG Z( dH Z) dI Z* dJ dK Z+ d= S)L
SysLogHandlera
A handler class which sends formatted logging records to a syslog
server. Based on Sam Rushing's syslog module:
http://www.nightmare.com/squirl/python-ext/misc/syslog.py
Contributed by Nicolas Untz (after which minor refactoring changes
have been made).
r r, r6 rZ r[ r\ r] rD
ZalertZcritZcriticaldebugZemergerrerrorinfoZnoticeZpanicwarnwarningZauthZauthprivZcrondaemonZftpZkernZlprZmailZnewsZsecurityZsysloguserZuucpZlocal0Zlocal1Zlocal2Zlocal3Zlocal4Zlocal5Zlocal6Zlocal7DEBUGINFOWARNINGERRORCRITICALZ localhostNc C s t j j | | | _ | | _ | | _ t | t rl d | _ y | j | Wqt
k
rh YqXn"d | _ | d k r t j } | \ } } t j
| | d | } | s t
d x | D] } | \ } } } }
} d } }
y6 t j | | | }
| t j k r |
j | PWq t
k
re} z! | } |
d k rS|
j WYd d } ~ Xq Xq W| d k r|| |
| _ | | _ d S)a
Initialize a handler.
If address is specified as a string, a UNIX socket is used. To log to a
local syslogd, "SysLogHandler(address="/dev/log")" can be used.
If facility is not specified, LOG_USER is used. If socktype is
specified as socket.SOCK_DGRAM or socket.SOCK_STREAM, that specific
socket type will be used. For Unix sockets, you can also specify a
socktype of None, in which case socket.SOCK_DGRAM will be used, falling
back to socket.SOCK_STREAM.
TFNr z!getaddrinfo returns an empty list)r r| r
r facilitysocktype
isinstancestr
unixsocket_connect_unixsocketr r r Z getaddrinfor r r/ )r r r r r} r~ ZressresZafproto_Zsar r excr r r r
sB
! zSysLogHandler.__init__c C s | j } | d k r t j } t j t j | | _ y | j j | | | _ Wn t k
r | j j | j d k r t j } t j t j | | _ y | j j | | | _ Wn" t k
r | j j Yn XYn Xd S)N)r r r r r r r/ r )r r Z use_socktyper r r r G s&
z!SysLogHandler._connect_unixsocketc C sD t | t r | j | } t | t r8 | j | } | d >| BS)z
Encode the facility and priority. You can pass in strings or
integers - if strings are passed, the facility_names and
priority_names mapping dictionaries are used to convert them to
integers.
rZ )r r facility_namespriority_names)r r Zpriorityr r r encodePriority_ s
z SysLogHandler.encodePriorityc
C s= | j z! | j j t j j | Wd | j Xd S)z$
Closes the socket.
N)r r r/ r r| r )r r r r r/ l s
zSysLogHandler.closec C s | j j | d S)aK
Map a logging level name to a key in the priority_names map.
This is useful in two scenarios: when custom levels are being
used, and in the case where you can't do a straightforward
mapping by lowercasing the logging level name because of locale-
specific issues (see SF #1524081).
r ) priority_mapget)r Z levelNamer r r mapPriorityw s zSysLogHandler.mapPriority Tc C sL y&| j | } | j r( | j | } | j r; | d 7} d | j | j | j | j } | j d } | j d } | | } | j r y | j j
| Wq%t k
r | j j | j
| j | j j
| Yq%Xn; | j t j k r| j j | | j n | j j | Wn t k
rG| j | Yn Xd S)z
Emit a record.
The record is formatted, and then sent to the syslog server. If
exception information is present, it is NOT sent to the server.
z<%d>zutf-8N)r7 ident
append_nulr r r Z levelnameencoder r r r r/ r r r r r r r r )r r r; Zprior r r r s.
zSysLogHandler.emit),r$ r% r& r' Z LOG_EMERGZ LOG_ALERTZLOG_CRITZLOG_ERRZ LOG_WARNINGZ
LOG_NOTICEZLOG_INFOZ LOG_DEBUGZLOG_KERNZLOG_USERZLOG_MAILZ
LOG_DAEMONZLOG_AUTHZ
LOG_SYSLOGZLOG_LPRZLOG_NEWSZLOG_UUCPZLOG_CRONZ LOG_AUTHPRIVZLOG_FTPZ
LOG_LOCAL0Z
LOG_LOCAL1Z
LOG_LOCAL2Z
LOG_LOCAL3Z
LOG_LOCAL4Z
LOG_LOCAL5Z
LOG_LOCAL6Z
LOG_LOCAL7r r r SYSLOG_UDP_PORTr
r r r/ r r r r r r r r r s 5
r c @ sC e Z d Z d Z d d d d d Z d d Z d d Z d S)
SMTPHandlerzK
A handler class which sends an SMTP email for each logging event.
Ng @c C s t j j | t | t t f r: | \ | _ | _ n | d | _ | _ t | t t f rw | \ | _ | _ n d | _ | | _
t | t r | g } | | _ | | _
| | _ | | _ d S)ax
Initialize the handler.
Initialize the instance with the from and to addresses and subject
line of the email. To specify a non-standard SMTP port, use the
(host, port) tuple format for the mailhost argument. To specify
authentication credentials, supply a (username, password) tuple
for the credentials argument. To specify the use of a secure
protocol (TLS), pass in a tuple for the secure argument. This will
only be used when authentication credentials are supplied. The tuple
will be either an empty tuple, or a single-value tuple with the name
of a keyfile, or a 2-value tuple with the names of the keyfile and
certificate file. (This tuple is passed to the `starttls` method).
A timeout in seconds can be specified for the SMTP connection (the
default is one second).
N)r r| r
r listtuplemailhostmailportusernamepasswordfromaddrr toaddrssubjectsecurer )r r r r r credentialsr r r r r r
s zSMTPHandler.__init__c C s | j S)z
Determine the subject for the email.
If you want to specify a subject line which is record-dependent,
override this method.
)r )r r r r r
getSubject s zSMTPHandler.getSubjectc C sY y3d d l } d d l m } d d l } | j } | sC | j } | j | j | d | j } | } | j | d
Initialize the handler with the buffer size.
N)r r| r
capacitybuffer)r r r r r r
s zBufferingHandler.__init__c C s t | j | j k S)z
Should the handler flush its buffer?
Returns true if the buffer is up to capacity. This method can be
overridden to implement custom flushing strategies.
)r: r r )r r r r r shouldFlush s z BufferingHandler.shouldFlushc C s- | j j | | j | r) | j d S)z
Emit a record.
Append the record. If shouldFlush() tells us to, call flush() to process
the buffer.
N)r rl r rz )r r r r r r s zBufferingHandler.emitc
C s) | j z
g | _ Wd | j Xd S)zw
Override to implement custom flushing behaviour.
This version just zaps the buffer to empty.
N)r r r )r r r r rz s
zBufferingHandler.flushc C s& z | j Wd t j j | Xd S)zp
Close the handler.
This version just flushes and chains to the parent class' close().
N)rz r r| r/ )r r r r r/ s zBufferingHandler.closeN) r$ r% r& r' r
r r rz r/ r r r r r s r c @ s[ e Z d Z d Z e j d d d Z d d Z d d Z d d
Z d d Z
d S)
MemoryHandlerz
A handler class which buffers logging records in memory, periodically
flushing them to a target handler. Flushing occurs whenever the buffer
is full, or when an event of a certain severity or greater is seen.
Nc C s& t j | | | | _ | | _ d S)a
Initialize the handler with the buffer size, the level at which
flushing should occur and an optional target.
Note that without a target being set either here or via setTarget(),
a MemoryHandler is no use to anyone!
N)r r
flushLeveltarget)r r r r r r r r
s zMemoryHandler.__init__c C s( t | j | j k p' | j | j k S)zP
Check for buffer full or a record at the flushLevel or higher.
)r: r r r r )r r r r r r s zMemoryHandler.shouldFlushc C s
| | _ d S)z:
Set the target handler for this handler.
N)r )r r r r r setTarget s zMemoryHandler.setTargetc
C sV | j z: | j rC x! | j D] } | j j | q Wg | _ Wd | j Xd S)z
For a MemoryHandler, flushing means just sending the buffered
records to the target, if there is one. Override if you want
different behaviour.
The record buffer is also cleared by this operation.
N)r r r handler )r r r r r rz s
zMemoryHandler.flushc C sH z | j Wd | j z d | _ t j | Wd | j XXd S)zD
Flush, set the target to None and lose the buffer.
N)rz r r r r/ r )r r r r r/ s
zMemoryHandler.close) r$ r% r& r' r r r
r r
rz r/ r r r r r
s r
c @ sF e Z d Z d Z d d Z d d Z d d Z d d Z d
S) QueueHandlera
This handler sends events to a queue. Typically, it would be used together
with a multiprocessing Queue to centralise logging to file in one process
(in a multi-process application), so as to avoid file write contention
between processes.
This code is new in Python 3.2, but this class can be copy pasted into
user code for use with earlier Python versions.
c C s t j j | | | _ d S)zA
Initialise an instance, using the passed queue.
N)r r| r
queue)r r r r r r
* s zQueueHandler.__init__c C s | j j | d S)z
Enqueue a record.
The base implementation uses put_nowait. You may want to override
this method if you want to use blocking, timeouts or custom queue
implementations.
N)r
put_nowait)r r r r r enqueue1 s zQueueHandler.enqueuec C s/ | j | | j | _ d | _ d | _ | S)a
Prepares a record for queuing. The object returned by this method is
enqueued.
The base implementation formats the record to merge the message
and arguments, and removes unpickleable items from the record
in-place.
You might want to override this method if you want to convert
the record to a dict or JSON string, or send a modified copy
of the record while leaving the original intact.
N)r7 r r; r r )r r r r r prepare; s
zQueueHandler.preparec C s@ y | j | j | Wn t k
r; | j | Yn Xd S)zm
Emit a record.
Writes the LogRecord to the queue, preparing it for pickling first.
N)r r r r )r r r r r r T s
zQueueHandler.emitN)r$ r% r& r' r
r r r r r r r r s
r c @ s e Z d Z d Z d Z d d d d Z d d Z d d
Z d d Z d
d Z d d Z
d d Z d d Z d S)
QueueListenerz
This class implements an internal threaded listener which watches for
LogRecords being added to a queue, removes them and passes them to a
list of handlers for processing.
Nrespect_handler_levelFc G s( | | _ | | _ d | _ | | _ d S)zc
Initialise an instance with the specified queue and
handlers.
N)r handlers_threadr )r r r r r r r r
h s zQueueListener.__init__c C s | j j | S)z
Dequeue a record and return it, optionally blocking.
The base implementation uses get. You may want to override this method
if you want to use timeouts or work with custom queue implementations.
)r r )r blockr r r dequeuer s zQueueListener.dequeuec C s3 t j d | j | _ } d | _ | j d S)z
Start the listener.
This starts up a background thread to monitor the queue for
LogRecords to process.
r TN) threadingZThread_monitorr r start)r rY r r r r { s zQueueListener.startc C s | S)a
Prepare a record for handling.
This method just returns the passed-in record. You may want to
override this method if you need to do any custom marshalling or
manipulation of the record before passing it to the handlers.
r )r r r r r r s zQueueListener.preparec C s^ | j | } xH | j D]= } | j s1 d } n | j | j k } | r | j | q Wd S)z
Handle a record.
This just loops through the handlers offering them the record
to handle.
TN)r r r r levelr )r r ZhandlerZprocessr r r r s zQueueListener.handlec C s| | j } t | d } x] y@ | j d } | | j k r= P| j | | rZ | j Wq t j k
rs PYq Xq Wd S)z
Monitor the queue for records, and ask the handler
to deal with them.
This method runs on a separate, internal thread.
The thread will terminate if it sees a sentinel object in the queue.
task_doneTN)r hasattrr _sentinelr r ZEmpty)r qZ
has_task_doner r r r r s
zQueueListener._monitorc C s | j j | j d S)a
This is used to enqueue the sentinel record.
The base implementation uses put_nowait. You may want to override this
method if you want to use timeouts or work with custom queue
implementations.
N)r r r )r r r r enqueue_sentinel s z QueueListener.enqueue_sentinelc C s$ | j | j j d | _ d S)a!
Stop the listener.
This asks the thread to terminate, and then waits for it to do so.
Note that if you don't call this before your application exits, there
may be some records still left on the queue, which won't be processed.
N)r" r rm )r r r r stop s
zQueueListener.stop)
r$ r% r& r' r r
r r r r r r" r# r r r r r ` s
r i iQ )'r' r r r r r rV rR rU r r r r r r ZDEFAULT_TCP_LOGGING_PORTZDEFAULT_UDP_LOGGING_PORTZDEFAULT_HTTP_LOGGING_PORTZDEFAULT_SOAP_LOGGING_PORTr ZSYSLOG_TCP_PORTr` r r r( r< rr r| r{ r r r r r r r
r objectr r r r r s: T
FL<*PbM9?@