*j< d S r SSKrSSKrSSKrSSKrSSKrSSKrSSKrSSKrSSK r SSK
r
SSK r Sr Sr
SrSrSrSrSr " S S
\R& 5 r " S S \5 r " S
S\5 r " S S\R& 5 r " S S\R0 5 r " S S\5 r " S S\R0 5 r " S S\R0 5 r " S S\R0 5 r " S S \R0 5 r " S S \R0 5 r " S S \ 5 r " S! S"\R0 5 r! " S# S$\"5 r#g)%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-2021 Vinay Sajip. All Rights Reserved.
To use, simply 'import logging.handlers' and log away!
Ni<# i=# i># i?# i Q c < \ rS rSrSrSrSrS S jrS rS r S r
Sr g)
BaseRotatingHandler3 z
Base class for handlers that rotate log files at a certain point.
Not meant to be instantiated directly. Instead, use RotatingFileHandler
or TimedRotatingFileHandler.
Nc h [ R R XUX4US9 X l X0l XPl g)z1
Use the specified filename for streamed logging
modeencodingdelayerrorsN)logging FileHandler__init__r r
r selffilenamer r
r r s 7/opt/alt/python313/lib64/python3.13/logging/handlers.pyr BaseRotatingHandler.__init__< s8 $$T$.6,2 % 4
c U R U5 ( a U R 5 [ R R X5 g! [
a U R
U5 gf = f)zd
Emit a record.
Output the record to the file, catering for rollover as described
in doRollover().
N)shouldRollover
doRolloverr
r emit Exception handleErrorr records r r BaseRotatingHandler.emitG sS %""6**! $ $T 2 % V $ %s AA A&%A&c d [ U R 5 ( d UnU$ U R U5 nU$ )ay
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.
)callablenamer)r default_nameresults r rotation_filename%BaseRotatingHandler.rotation_filenameU s4
##!F
ZZ -F
r c [ U R 5 ( d< [ R R U5 ( a [ R
" X5 ggU R X5 g)a
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 rotatorospathexistsrename)r sourcedests r rotateBaseRotatingHandler.rotateh sE %%ww~~f%% &' &
LL &r )r
r r )NFN) __name__
__module__ __qualname____firstlineno____doc__r! r' r r r$ r. __static_attributes__ r r r r 3 s'
EG % &'r r c 2 \ rS rSrSr SS jrS rS rSrg) RotatingFileHandler} z
Handler for logging to a set of files, which switches from one file
to the next when the current file reaches a certain size.
Nc US: a SnSU; a [ R " U5 n[ R XX%XgS9 X0l X@l g)az
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 abr
r r N)io
text_encodingr r maxBytes backupCount)r r r r@ rA r
r r s r r RotatingFileHandler.__init__ sM 6 a<D d?''1H$$TT+0 % A
&r c t U R ( a! U R R 5 SU l U R S: GaN [ U R S-
SS5 H nU R SU R
U4- 5 nU R SU R
US- 4- 5 n[ R R U5 ( d Ml [ R R U5 ( a [ R " U5 [ R " X#5 M U R U R
S- 5 n[ R R U5 ( a [ R " U5 U R U R
U5 U R ( d U R 5 U l gg)z,
Do a rollover, as described in __init__().
Nr z%s.%dz.1)streamcloserA ranger$ baseFilenamer( r) r* remover+ r. r _open)r isfndfns r r RotatingFileHandler.doRollover s? ;; KK DK a 4++a/B7,,W8I8I17M-MN,,W8I8I89A8? .? @77>>#&&ww~~c** #IIc' 8 (():):T)ABCww~~c"" # KK))3 /zz **,DK r c U R c U R 5 U l U R S: a U R R 5 nU( d gSU R
U5 - nU[ U5 - U R : a^ [ R R U R 5 ( a/ [ R R U R 5 ( d ggg! [ R
a gf = f)z
Determine if rollover should occur.
Basically, see if the supplied record would cause the file to exceed
the size limit we have.
r Fz%s
T)
rF rK r@ tellr> UnsupportedOperationformatlenr( r) r* rI isfile)r r posmsgs r r "RotatingFileHandler.shouldRollover s ;; **,DK ==1
kk&&( 4;;v..CSX~ .77>>$"3"344RWW^^DL]L]=^=^ **
s C% %C<;C<)rA r@ rF )r; r r NFN) r0 r1 r2 r3 r4 r r r r5 r6 r r r8 r8 } s! DE48"'H'.r r8 c @ \ rS rSrSr S
S jrS rS rS rS r S r
g) TimedRotatingFileHandler z
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.
Nc
[ R " U5 n[ R XSUXiS9 UR 5 U l X@l Xpl Xl U R
S:X a SU l SU l
Sn
GOJU R
S:X a SU l S U l
S
n
GO(U R
S :X a S U l S
U l
Sn
GOU R
S:X d U R
S:X a SU l SU l
Sn
OU R
R S5 ( a SU l [ U R
5 S:w a [ SU R
- 5 eU R
S S: d U R
S S: a [ SU R
- 5 e[ U R
S 5 U l SU l
Sn
O[ SU R
- 5 e[ R" " U
[ R$ 5 U l U R U- U l U R( n[* R, R/ U5 ( a* [ [* R0 " U5 R2 5 n O [ [4 R4 " 5 5 n U R7 U 5 U l g ) Nr; r= SrD z%Y-%m-%d_%H-%M-%Sz0(? r? r r upperwhenrA utcatTimeintervalsuffix
startswithrT
ValueErrorint dayOfWeekrecompileASCIIextMatchrI r( r) r* statst_mtimetimecomputeRollover
rolloverAt) r r ri rl rA r
r rj rk r ru ts r r !TimedRotatingFileHandler.__init__ s
##H-$$TS8+0 % AJJL & 99 DM-DKJH
YY#
DM*DKDH
YY#
#DM'DK>H
YY#
j!8 (DM$DK8H
YY
!
!#
&
& ,DM499~" !knrnwnw!wxxyy|c!TYYq\C%7 !PSWS\S\!\]] 1 .DN$DK8H F RS S
8RXX6
0
$$
77>>( # #BGGH%../ADIIK A ..q1r c D XR - nU R S:X d! U R R S5 ( Ga U R ( a [ R
" U5 nO[ R " U5 nUS nUS nUS nUS nU R c [ nOJU R R S- U R R - S- U R R - nXS- U- S- U- -
n U S:: a U [ -
n US - S
- nX- nU R R S5 ( ai Un
XR :w a? XR : a U R U
-
n OSU
-
U R - S - n X+[ - -
nX R [ S
- -
-
nOX R [ -
-
nU R ( dV US n [ R " U5 S n
X:w a3 U ( d& S n[ R " US
-
5 S ( d SnOS
nX.-
nU$ )z9
Work out the rollover time based on the specified time.
rc rd r_ r rD rE ra )
rl ri rn rj rx gmtime localtimerk _MIDNIGHThourminutesecondrq )r currentTimer# r{ currentHour
currentMinute
currentSecond
currentDay rotate_tsrday
daysToWaitdstNow
dstAtRolloveraddends r ry (TimedRotatingFileHandler.computeRollover" s }}, 99
"dii&:&:3&?&?xxKK ,NN;/A$K aDM aDM1J{{" % "kk . . 3dkk6H6H H" LKK&& ' B . >" D AAv Y (1n 1
_F yy##C(( ..(^^+%)^^c%9
%&Wt~~%=%A
9 44F--)a-77--)33882 $v 6r :
*!!& #~~fTk :2 >%&F!%$F
r c F [ [ R " 5 5 nX R : at [ R R U R 5 ( aE [ R R U R 5 ( d U R U5 U l ggg)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
FT) rp rx rz r( r) r* rI rU ry )r r r{ s r r 'TimedRotatingFileHandler.shouldRollovero sl
ww~~d / /00 HYHY9Z9Z #'"6"6q"9 r c [ R R U R 5 u p[ R " U5 n/ nU R
cy US- n[
U5 nU Hb nUSU U:X d M XvS nU R R U5 ( d M4 UR [ R R X5 5 Md OU H nU R R U5 n U ( d M' U R U R S- U S - 5 n
[ R R U
5 U:X a0 UR [ R R X5 5 M U R R XyR 5 S- 5 n U ( a M M [
U5 U R : a / nU$ UR 5 US[
U5 U R -
nU$ )zw
Determine the files to delete when rolling over.
More specific than the earlier method, which just used glob.glob().
N.r rD )r( r) splitrI listdirr! rT ru fullmatchappendjoinsearchbasenamestartrA sort) r dirNamebaseName fileNamesr# prefixplenfileNamerm mrN s r getFilesToDelete)TimedRotatingFileHandler.getFilesToDelete s GGMM$*;*; <JJw' :: ^Fv;D %ET?f, %e_F}}..v66
bggll7&EF & &
MM((2a **T%6%6%># ;; KK DK D%%s+ a **, ! -zz **,DK ..{;r )
rk rA rq ru rl rz rF rm rj ri )hrD r NFFNN) r0 r1 r2 r3 r4 r ry r r r r5 r6 r r rZ rZ s2 DE?C A2FKZ&$L& r? r
r r devino _statstreamr s r r WatchedFileHandler.__init__ sX d?''1H$$T$.6,2 % 4 $$( r c U R c g [ R " U R R 5 5 nUR U l UR U l g N)rF r( fstatfilenost_devr st_inor )r sress r r WatchedFileHandler._statstream s@ ;; xx **,-;;;;r c U R c g [ R " U R 5 nUR U R
:g =( d UR U R :g nU( d gU R R 5 U R R 5 SU l U R 5 U l U R 5 g! [ a Sn Nwf = f)z
Reopen log file if needed.
Checks if the underlying file has changed, and if it
has, close the old stream and reopen the file to get the
current stream.
NT)
rF r( rv rI r r r r FileNotFoundErrorflushrG rK r )r r reopens r reopenIfNeeded!WatchedFileHandler.reopenIfNeeded s ;; 774,,-D kkTXX-H1HF
jjl ! F s AC C! C!c b U R 5 [ R R X5 g)zc
Emit a record.
If underlying file has changed, reopen the file before emitting the
record to it.
N)r r
r r r s r r WatchedFileHandler.emit s$
.r )r r rF )r; NFN)
r0 r1 r2 r3 r4 r r r r r5 r6 r r r r s& $ AF "H/r r c L \ rS rSrSrS rS
S jrS rS rS r S r
S r S
r S r
g )
SocketHandleri# a
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 [ R R U 5 Xl X l Uc Xl OX4U l SU l SU l SU l SU l SU l
SU l g)z
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 retryFactorr r r s r r SocketHandler.__init__0 sa & < L >63E3EFF g &
t||,
s 4B B-c [ R " 5 nU R c SnOXR : nU( a U R 5 U l SU l gg! [ a~ U R c U R
U l OIU R U R - U l U R U R : a U R U l XR - U l gf = f)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) rx r r r r r retryPeriodr r )r nowattempts r createSocketSocketHandler.createSocketZ s iik >> !Gnn,G
8 OO - !%
8>>)'+D$'+'7'7$:J:J'JD$''$--7+/==(!$'7'7!7
8s A BC"!C"c U R c U R 5 U R ( a U R R U5 gg! [ a$ U R R 5 SU l gf = f)zy
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 rG r r s r sendSocketHandler.sendv se 99 99
! !!!$
! !
!s A
+A;:A;c H UR nU( a U R U5 n[ UR 5 nUR 5 US' SUS' SUS' UR SS5 [ R " US5 n[ R " S[ U5 5 nXe- $ )zt
Pickles the record in binary format with a length prefix, and
returns it ready for transmission across the socket.
rW Nargsexc_infomessagerD z>L) r rS dict__dict__
getMessagepoppickledumpsstructpackrT )r r eidummydr slens r
makePickleSocketHandler.makePickle s
__
KK'E
!$$&%& *
i LLA {{4Q(xr c U R ( a3 U R ( a" U R R 5 SU l g[ R R X5 g)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 rG r
r r r s r r SocketHandler.handleError s: IIOO DI OO ' ' 5r c U R U5 nU R U5 g! [ a U R U5 gf = f)z
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 r s r r SocketHandler.emit s= %'A IIaL % V $ %s "% AAc U R U R nU( a SU l UR 5 [ R R U 5 SSS5 g! , ( d f g= fz
Closes the socket.
N)lockr rG r
r r r s r rG SocketHandler.close sC YY99D
OO ! !$ ' YY A
A
A.)
r r r r r r r r r r N)rD )r0 r1 r2 r3 r4 r r r r r r r rG r5 r6 r r r r # s/
2"88!&, 6
% (r r c * \ rS rSrSrS rS rS rSrg)DatagramHandleri a|
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 > [ R XU5 SU l g)z@
Initializes the handler with a specific host address and port.
FN)r r r r s r r DatagramHandler.__init__ s t40 !r c U R c [ R nO[ R n[ R " U[ R 5 nU$ )z]
The factory method of SocketHandler is here overridden to create
a UDP socket (SOCK_DGRAM).
)r r r AF_INET
SOCK_DGRAM)r familyr s r r DatagramHandler.makeSocket s;
99 ^^F^^F MM&&"3"3 4r c U R c U R 5 U R R XR 5 g)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 s r r DatagramHandler.send s0 99 LL)r )r N) r0 r1 r2 r3 r4 r r r r5 r6 r r r r s "
*r r c
\ rS rSrSrSrSrSrSrSr Sr
S r S
r Sr
SrSrSrSrSrS rS
rS rS rS
rSrSrSrSrSr Sr Sr Sr Sr Sr!Sr"Sr#Sr$\\\\ \\\\ \
\\ \ S. r%0 S \_S \_S \_S \_S \_S!\_S"\
_S#\_S$\_S%\_S&\_S'\_S(\ _S)\_S*\_S+\_S,\ _\ \ \ \!\"\#\$S-.Er&S.S/S0S1S2S3.r'S4\(4\S54S6 jr)S7 r*S8 r+S9 r,S: r-S; r.S r1S?r2g5)@
SysLogHandleri z
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 rD re r~ r r r r
) alertcritcriticaldebugemergerrerrorinfonoticepanicwarnwarningauthauthprivconsolecrondaemonftpkernlprmailnewsntpsecurityz solaris-cronsysloguseruucplocal0)local1local2local3local4local5local6local7r. r2 r6 r1 r- )DEBUGINFOWARNINGERRORCRITICAL localhostNc [ R R U 5 Xl X l X0l SU l U R 5 g)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.
N)r
r r r facilitysocktyper r )r r rU rV s r r SysLogHandler.__init__] s8 &
r c T U R nUc [ R n[ R " [ R U5 U l U R R U5 X l g ! [
a U R R
5 U R b e [ R n[ R " [ R U5 U l U R R U5 X l g ! [
a U R R
5 e f = ff = fr )rV r r r r r rG r )r r use_socktypes r _connect_unixsocket!SysLogHandler._connect_unixsocketr s }} !,,L mmFNNLA KK ( (M
KK }}(!--L -- EDK
##G, ,
!!#
s !A- -A,D'!C==&D##D'c j U R nU R n[ U[ 5 ( a SU l U R U5 gSU l Uc [ R nUu p4[ R " X4SU5 nU( d [
S5 eU HI nUu prpn
S=p [ R " XrU5 n U[ R :X a U R U
5 O W b U eW U l X l g! [ a gf = f! [ a& n
U
n U b U R 5 Sn
A
M Sn
A
M Sn
A
ff = f)a6
Try to create a socket and, if it's not a datagram socket, connect it
to the other end. This method is called during handler initialization,
but it's not regarded as an error if the other end isn't listening yet
--- the method will be called again when emitting an event,
if there is no socket at that point.
TFNr z!getaddrinfo returns an empty list)
r rV
isinstancestr
unixsocketrZ r r r getaddrinfor r rG )r r rV r r ressresafproto_sar0 r excs r r SysLogHandler.createSocket s) ,,== gs # # "DO
((1 $DO !,, JD%%d!X>D ABB-0*e !!%!==u=D 6#5#55 R( DK $M3
$ % C'
(%s) C2 C?
D2 D--D2c [ U[ 5 ( a U R U n[ U[ 5 ( a U R U nUS- U- $ )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.
r~ )r] r^ facility_namespriority_names)r rU prioritys r encodePriority SysLogHandler.encodePriority sM h $ $**84H h $ $**84HA
))r c U R U R nU( a SU l UR 5 [ R R U 5 SSS5 g! , ( d f g= fr )r r rG r
r r
s r rG SysLogHandler.close sC YY;;D "
OO ! !$ ' YYr c : U R R US5 $ )a
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).
r6 ) priority_mapget)r levelNames r mapPrioritySysLogHandler.mapPriority s $$Y ::r Tc U R U5 nU R ( a U R U- nU R ( a US-
nSU R U R U R UR 5 5 - nUR S5 nUR S5 nX2- nU R ( d U R 5 U R ( a U R R U5 gU R [ R" :X a& U R R% X R 5 gU R R' U5 g! [ aS U R R 5 U R U R 5 U R R U5 gf = f! [( a U R+ U5 gf = f)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>utf-8N)rS ident
append_nulrm rU ru levelnameencoder r r_ r r rG rZ r rV r r r r r )r r rW prios r r SysLogHandler.emit sb %++f%Czzjj3&v
D / /
040@0@AQAQ0R T TD;;w'D**W%C*C;;!!#*KK$$S)
&"3"33 ""3 5 ##C( *KK%%',,T\\:KK$$S)* % V $ %s> CF6 E 6AF6 :F6 AF30F6 2F33F6 6GG)r rU r rV r_ )3r0 r1 r2 r3 r4 LOG_EMERG LOG_ALERTLOG_CRITLOG_ERR LOG_WARNING
LOG_NOTICELOG_INFO LOG_DEBUGLOG_KERNLOG_USERLOG_MAIL
LOG_DAEMONLOG_AUTH
LOG_SYSLOGLOG_LPRLOG_NEWSLOG_UUCPLOG_CRON LOG_AUTHPRIVLOG_FTPLOG_NTP LOG_SECURITY LOG_CONSOLE LOG_SOLCRON
LOG_LOCAL0
LOG_LOCAL1
LOG_LOCAL2
LOG_LOCAL3
LOG_LOCAL4
LOG_LOCAL5
LOG_LOCAL6
LOG_LOCAL7rk rj rr SYSLOG_UDP_PORTr rZ r rm rG ru r{ r| r r5 r6 r r r r s $ IIHGKJHI HHHJHJGHHHLGGLKK JJJJJJJJ
N
!
"
#
$ #""""""1
N< L !,_ ="T *0,%\ * (;
EJ&%r r c 0 \ rS rSrSr SS jrS rS rSrg) SMTPHandleri zC
A handler class which sends an SMTP email for each logging event.
Nc [ R R U 5 [ U[ [
45 ( a Uu U l U l OUSsU l U l [ U[ [
45 ( a Uu U l U l OSU l X l
[ U[ 5 ( a U/nX0l X@l
X`l Xpl g)a
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
`ssl.SSLContext.load_cert_chain` 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 s r r SMTPHandler.__init__ s & & hu
. .+3 (DM4=+3T (DM4= kD%= 1 1+6 (DM4= DM
gs # # iG r c U R $ )z~
Determine the subject for the email.
If you want to specify a subject line which is record-dependent,
override this method.
)r r s r
getSubjectSMTPHandler.getSubject- s ||r c SSK nSSKJn SSKnU R nU( d UR
nUR
U R XPR S9nU" 5 nU R US' SR U R 5 US' U R U5 US' UR R 5 US ' UR U R! U5 5 U R" ( a U R$ bb SSKn U R$ S n U R$ S
n
UR+ XS 9n UR- 5 UR/ U S 9 UR- 5 UR1 U R" U R2 5 UR5 U5 UR7 5 g! [( a Sn Nf = f! [( a Sn
Nf = f! [8 a U R; U5 gf = f)
zL
Emit a record.
Format the record and send it to the specified addressees.
r N) EmailMessager From,ToSubjectDaterD )certfilekeyfilecontext) smtplib
email.messager email.utilsr SMTP_PORTSMTPr r r r r r utilsr set_contentrS r r ssl
IndexError_create_stdlib_contextehlostarttlsloginr send_messagequitr r ) r r r r emailr smtprW r r r r s r r SMTPHandler.emit6 s ' % 2 ==D ((<<
t\\<JD .C --CK .CI !__V 4C N ++//1CK OODKK / 0}};;* '"&++a.(#';;q> " 8 8!) 9 G IIKMM'M2IIK
4==$--8 c " IIK! & '"&'
& (#'( % V $ %sU C8G ;F F2 BG F/,G .F//G 2 G>G GG G"!G") r r r r r r r r r )NNg @) r0 r1 r2 r3 r4 r r r r5 r6 r r r r s 9<" H -%r r c @ \ rS rSrSrS S jrS rS rS rS r S r
S
r g) NTEventLogHandlerie a
A handler class which sends events to the NT Event Log. Adds a
registry entry for the specified application name. If no dllname is
provided, win32service.pyd (which contains some basic message
placeholders) is used. Note that use of these placeholders will make
your event logs big, as the entire message source is held in the log.
If you want slimmer logs, you have to pass in the name of your own DLL
which contains the message definitions you want to use in the event log.
Nc
[ R R U 5 SS KnSS KnXl X@l U( dx [ R R U R R 5 n[ R R US 5 n[ R R US S5 nX l X0l
U R R XU5 UR" U l [ R& UR( [ R* UR( [ R, UR. [ R0 UR" [ R2 UR" 0U l g ! [ a n[! USS 5 S:w a e S nANS nAff = f! [6 a [9 S5 S U l g f = f)Nr zwin32service.pydwinerrorr zWThe Python Win32 extensions for NT (service, event logging) appear not to be available.) r
r r win32evtlogutil win32evtlogappname_welur( r) r __file__r dllnamelogtypeAddSourceToRegistryr getattrEVENTLOG_ERROR_TYPEdeftyperN EVENTLOG_INFORMATION_TYPErO rP EVENTLOG_WARNING_TYPErQ rR typemap ImportErrorprint)r r r r r r es r r NTEventLogHandler.__init__o sN & /"L(J ''--
(;(;< ''--
3 '',,wqz3FG"L"L
..wI '::DL
+"G"G +"G"G+"C"C
+"A"A +"A"A DL
1j$/14 5
?
@ DJ s= B F! E8 BF! 8
F FF! F F! ! G ?G c g)aI
Return the message ID for the event record. If you are using your
own messages, you could do this by having the msg passed to the
logger being an ID rather than a formatting string. Then, in here,
you could use a dictionary lookup to get the message ID. This
version returns 1, which is the base message ID in win32service.pyd.
rD r6 r s r getMessageID NTEventLogHandler.getMessageID s r c g)z~
Return the event category for the record.
Override this if you want to specify your own categories. This version
returns 0.
r r6 r s r getEventCategory"NTEventLogHandler.getEventCategory s r c b U R R UR U R 5 $ )a
Return the event type for the record.
Override this if you want to specify your own types. This version does
a mapping using the handler's typemap attribute, which is set up in
__init__() to a dictionary which contains mappings for DEBUG, INFO,
WARNING, ERROR and CRITICAL. If you are using your own levels you will
either need to override this method or place a suitable dictionary in
the handler's typemap attribute.
)r rs levelnor r s r getEventType NTEventLogHandler.getEventType s# || ==r c D U R ( an U R U5 nU R U5 nU R U5 nU R U5 nU R R U R X#XE/5 gg! [ a U R U5 gf = f)zt
Emit a record.
Determine the message ID, event category and event type. Then
log the message in the NT event log.
N) r r r r rS ReportEventr r r )r r idcattyperW s r r NTEventLogHandler.emit s ::
)&&v.++F3((0kk&)
&&t||RdEJ
) (
)s A,B B B c B [ R R U 5 g)a
Clean up this handler.
You can remove the application name from the registry as a
source of event log entries. However, if you do this, you will
not be able to see the events as you intended in the Event Log
Viewer - it needs to be able to access the registry to get the
DLL name.
N)r
r rG r s r rG NTEventLogHandler.close s d#r )r r r r r r )N Application) r0 r1 r2 r3 r4 r r r r r rG r5 r6 r r r r e s& ! F >)" $r r c 8 \ rS rSrSr S S jrS rS rS rSr g)
HTTPHandleri zR
A class which sends records to a web server, using either GET or
POST semantics.
Nc [ R R U 5 UR 5 nUS; a [ S5 eU( d Ub [ S5 eXl X l X0l X@l XPl X`l
g)zZ
Initialize the instance with the host, the request URL, and the method
("GET" or "POST")
)GETPOSTzmethod must be GET or POSTNz3context parameter only makes sense with secure=True) r
r r rh ro r urlmethodr r r )r r r r r r r s r r HTTPHandler.__init__ sn & ( 9: :'- 0 1
1 & r c UR $ )z
Default implementation of mapping the log record into a dict
that is sent as the CGI data. Overwrite in your class.
Contributed by Franz Glasner.
)r r s r mapLogRecordHTTPHandler.mapLogRecord s r c SSK nU( a% UR R XR S9nU$ UR R U5 nU$ )zk
get a HTTP[S]Connection.
Override when a custom connection is required, for example if
there is a proxy.
r Nr ) http.clientclientHTTPSConnectionr HTTPConnection)r r r http
connections r
getConnectionHTTPHandler.getConnection sI 44T<<4PJ 33D9Jr c SSK nU R nU R X0R 5 nU R nUR
R
U R U5 5 nU R S:X a# UR S5 S: a SnOSnUSXv4- - nUR U R U5 UR S5 nUS: a USU nU R S:X a6 UR S S
5 UR S [ [ U5 5 5 U R ( ae SSKn S U R - R! S
5 n
SU R# U
5 R% 5 R' S5 - n
UR SU
5 UR) 5 U R S:X a UR+ UR! S
5 5 UR- 5 g! [. a U R1 U5 gf = f)zS
Emit a record.
Send the record to the web server as a percent-encoded dictionary
r Nr ?&z%c%s:r z Content-typez!application/x-www-form-urlencodedzContent-lengthz%s:%srz zBasic ascii
Authorization) urllib.parser r
r r parse urlencoder r find
putrequest putheaderr^ rT r base64r~ b64encodestripdecode
endheadersr getresponser r ) r r urllibr r r dataseprL r r s r r HTTPHandler.emit s # % 99D""45A((C<<))$*;*;F*CDD{{e#HHSMQ& C CFc[ 00
LLc * #AAvBQx {{f$ N ?A ,c#d)n= t / //77@ v / / 2 8 8 : A A' JJ OQ/
LLN{{f$t{{7+,
MMO % V $ %s GG G98G9)r r r r r r )r FNN)
r0 r1 r2 r3 r4 r r r
r r5 r6 r r r r s% KO ( )%r r c 6 \ rS rSrSrS rS rS rS rS r Sr
g )
BufferingHandleri* z
A handler class which buffers logging records in memory. Whenever each
record is added to the buffer, a check is made to see if the buffer should
be flushed. If it should, then flush() is expected to do what's needed.
c \ [ R R U 5 Xl / U l g)z.
Initialize the handler with the buffer size.
N)r
r r capacitybuffer)r r( s r r BufferingHandler.__init__0 s" &
r c F [ U R 5 U R : $ )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.
)rT r) r( r s r shouldFlush BufferingHandler.shouldFlush8 s DKK DMM12r c U R R U5 U R U5 ( a U R 5 gg)zf
Emit a record.
Append the record. If shouldFlush() tells us to, call flush() to process
the buffer.
N)r) r r, r r s r r BufferingHandler.emitA s5
6" F # # JJL $r c U R U R R 5 SSS5 g! , ( d f g= f)z_
Override to implement custom flushing behaviour.
This version just zaps the buffer to empty.
N)r r) clearr s r r BufferingHandler.flushL s% YY KK YYs 1
?c U R 5 [ R R U 5 g! [ R R U 5 f = f)zX
Close the handler.
This version just flushes and chains to the parent class' close().
N)r r
r rG r s r rG BufferingHandler.closeU s5 ( JJL OO ! !$ 'GOO ! !$ 's 2 !A)r) r( N) r0 r1 r2 r3 r4 r r, r r rG r5 r6 r r r& r& * s
3 (r r& c T \ rS rSrSr\R SS4S jrS rS r S r
S r S
r g)
MemoryHandleri` z
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.
NTc R [ R X5 X l X0l X@l g)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!
The ``flushOnClose`` argument is ``True`` for backward compatibility
reasons - the old behaviour is that when the handler is closed, the
buffer is flushed, even if the flush level hasn't been exceeded nor the
capacity exceeded. To prevent this, set ``flushOnClose`` to ``False``.
N)r& r
flushLeveltarget flushOnClose)r r( r8 r9 r: s r r MemoryHandler.__init__f s" !!$1$ (r c [ U R 5 U R : =( d UR U R : $ )z@
Check for buffer full or a record at the flushLevel or higher.
)rT r) r( r r8 r s r r, MemoryHandler.shouldFlushz s3 DKK DMM1 4 4??2 4r c \ U R Xl SSS5 g! , ( d f g= f)z*
Set the target handler for this handler.
N)r r9 )r r9 s r setTargetMemoryHandler.setTarget s YY K YYs
+c U R U R ( aH U R H nU R R U5 M U R R 5 SSS5 g! , ( d f g= f)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 only cleared if a target has been set.
N)r r9 r) handler1 r s r r MemoryHandler.flush sL YY{{ "kkFKK&&v. * !!# YYs AA00
A>c Z U R ( a U R 5 U R SU l [ R U 5 SSS5 g! , ( d f g= f! U R SU l [ R U 5 SSS5 f ! , ( d f f = f= f)zQ
Flush, if appropriately configured, set the target to None and lose the
buffer.
N)r: r r r9 r& rG r s r rG MemoryHandler.close sd
-
" &&t, " &&t, s. !A& A
A#&
B*3 B B*
B' #B*)r8 r: r9 )
r0 r1 r2 r3 r4 r
rQ r r, r? r rG r5 r6 r r r6 r6 ` s.
-4MM$ ")(4! $ -r r6 c 0 \ rS rSrSrS rS rS rS rSr g) QueueHandleri ah
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 \ [ R R U 5 Xl SU l g)z1
Initialise an instance, using the passed queue.
N)r
r r queuelistener)r rI s r r QueueHandler.__init__ s" &
r c : U R R U5 g)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)rI
put_nowaitr s r enqueueQueueHandler.enqueue s
f%r c U R U5 n[ R " U5 nX!l X!l SUl SUl SUl SUl U$ )a]
Prepare 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.
Specifically, it overwrites the record's `msg` and
`message` attributes with the merged message (obtained by
calling the handler's `format` method), and sets the `args`,
`exc_info` and `exc_text` attributes to None.
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)rS copyr rW r r exc_text
stack_info)r r rW s r prepareQueueHandler.prepare sL , kk&!6"
r c U R U R U5 5 g! [ a U R U5 gf = f)zU
Emit a record.
Writes the LogRecord to the queue, preparing it for pickling first.
N)rN rT r r r s r r QueueHandler.emit s9 % LL f- . % V $ %s # A A)rJ rI N)
r0 r1 r2 r3 r4 r rN rT r r5 r6 r r rG rG s & B %r rG c T \ rS rSrSrSrSS.S jrS rS rS r S
r
S r S r S
r
Srg)
QueueListeneri z
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.
NF)respect_handler_levelc 6 Xl X0l SU l X l g)z?
Initialise an instance with the specified queue and
handlers.
N)rI handlers_threadrZ )r rI rZ r\ s r r QueueListener.__init__ s
%:"r c 8 U R R U5 $ )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.
)rI rs )r blocks r dequeueQueueListener.dequeue s zz~~e$$r c U R b [ S5 e[ R " U R S9=U l nSUl UR
5 g)zi
Start the listener.
This starts up a background thread to monitor the queue for
LogRecords to process.
NzListener already started)r9 T)r] RuntimeError threadingThread_monitorr; r )r r{ s r r QueueListener.start sE << # 9: :$++4==AA q r c U$ )z
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.
r6 r s r rT QueueListener.prepare s
r c U R U5 nU R HJ nU R ( d SnOUR UR : nU( d M9 UR U5 ML g)z\
Handle a record.
This just loops through the handlers offering them the record
to handle.
TN)rT r\ rZ r levelrB )r r handlerprocesss r rB QueueListener.handle! sQ f%}}G-- ..GMM9wv&
%r c , U R n[ US5 n U R S5 nX0R L a U( a UR 5 gU R U5 U( a UR 5 Mb ! [ R a gf = f)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)rI hasattrra _sentinelrq rB Empty)r q
has_task_doner s r rg QueueListener._monitor1 s}
JJ ;/
d+^^+$
F# KKM ;;
s 6A< (A< <BBc N U R R U R 5 g)z
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)rI rM rs r s r enqueue_sentinel QueueListener.enqueue_sentinelH s
dnn-r c U R ( a2 U R 5 U R R 5 SU l gg)z
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] ry r r s r stopQueueListener.stopR s3 << ! ! # LL DL r )r] r\ rI rZ )r0 r1 r2 r3 r4 rs r ra r rT rB rg ry r| r5 r6 r r rY rY s9
I?D ;% ' .. r rY )$r4 rQ r> r
r( r rI rr r r re rx DEFAULT_TCP_LOGGING_PORTDEFAULT_UDP_LOGGING_PORTDEFAULT_HTTP_LOGGING_PORTDEFAULT_SOAP_LOGGING_PORTr SYSLOG_TCP_PORTr r r r8 rZ r r r r r r r r r& r6 rG objectrY r6 r r r sN "
# " " " ! ! H''-- H'TX- Xtw< 2 w