3 fI @sdZddlZddlZddlZddlZddlZddlZddlZddlm Z m Z m Z ddl Z y ddl Z Wnek r|dZ YnXdZdZdZdZdZdZd(ZGd d d ejZGd ddeZGdddeZGdddejZGdddejZGdddeZGdddejZGdddejZGdddejZ GdddejZ!Gdd d ejZ"Gd!d"d"e"Z#Gd#d$d$ejZ$e rGd%d&d&e%Z&dS))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@s2eZdZdZd ddZddZdd Zd d ZdS) BaseRotatingHandlerz Base class for handlers that rotate log files at a certain point. Not meant to be instantiated directly. Instead, use RotatingFileHandler or TimedRotatingFileHandler. NFcCs0tjj|||||||_||_d|_d|_dS)zA Use the specified filename for streamed logging N)logging FileHandler__init__modeencodingnamerrotator)selffilenamer r delayr(/usr/lib64/python3.6/logging/handlers.pyr 5s zBaseRotatingHandler.__init__c CsHy$|j|r|jtjj||Wntk rB|j|YnXdS)z Emit a record. Output the record to the file, catering for rollover as described in doRollover(). N)shouldRollover doRolloverrr emit Exception handleError)rrecordrrrr?s  zBaseRotatingHandler.emitcCst|js|}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 )rZ default_nameresultrrrrotation_filenameMs  z%BaseRotatingHandler.rotation_filenamecCs4t|js$tjj|r0tj||n |j||dS)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)rrospathexistsrename)rsourcedestrrrrotate`s  zBaseRotatingHandler.rotate)NF)__name__ __module__ __qualname____doc__r rrr#rrrrr/s  rc@s*eZdZdZd ddZdd Zd d ZdS) 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. arNFcCs.|dkr d}tj|||||||_||_dS)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. rr)N)rr maxBytes backupCount)rrr r*r+r rrrrr zs zRotatingFileHandler.__init__cCs|jr|jjd|_|jdkrxtt|jdddD]^}|jd|j|f}|jd|j|df}tjj|r4tjj|rtj |tj ||q4W|j|jd}tjj|rtj ||j |j||j s|j |_dS)z< Do a rollover, as described in __init__(). Nrz%s.%dz.1)streamcloser+ranger baseFilenamerrrremover r#r_open)riZsfndfnrrrrs$        zRotatingFileHandler.doRollovercCs|tjj|jr"tjj|j r"dS|jdkr6|j|_|jdkrxd|j|}|jj dd|jj t ||jkrxdSdS)z Determine if rollover should occur. Basically, see if the supplied record would cause the file to exceed the size limit we have. FNrz%s T) rrrr1isfiler.r3r*formatseektelllen)rrmsgrrrrs   z"RotatingFileHandler.shouldRollover)r)rrNF)r$r%r&r'r rrrrrrr(us r(c@s:eZdZdZdddZd d Zd d Zd dZddZdS)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,rNFc Cstj||d|||j|_||_||_||_|jdkrNd|_d|_d|_ n|jdkrld|_d|_d |_ n|jd krd|_d |_d |_ n|jd ks|jdkrd|_d|_d|_ n|jj dr.d|_t |jdkrt d|j|jddks|jddkrt d|jt |jd|_d|_d|_ nt d|jtj|j tj|_ |j||_|j}tjj|r~tj|t} n t tj} |j| |_dS) Nr)Sr,z%Y-%m-%d_%H-%M-%Sz-^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2}(\.\w+)?$Mrz%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+)?$DMIDNIGHTrz%Y-%m-%dz^\d{4}-\d{2}-\d{2}(\.\w+)?$Wr6zHYou 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: %siiiQiiQi: )rr upperwhenr+utcatTimeintervalsuffixextMatch startswithr; ValueErrorint dayOfWeekrecompileASCIIr1rrrstatrtimecomputeRollover rolloverAt) rrrIrLr+r rrJrKtrrrr sL        z!TimedRotatingFileHandler.__init__cCsd||j}|jdks"|jjdr`|jr4tj|}n tj|}|d}|d}|d}|d}|jdkrnt}n |jj d|jj d|jj }||d|d|} | d kr| t7} |d d }|| }|jjdr`|} | |j kr`| |j kr|j | } nd| |j d } || d} |js\|d} tj| d}| |kr\| sPd}nd }| |7} | }|S)zI Work out the rollover time based on the specified time. rCrDNrrr,rEriiiQr-r-i) rLrIrOrJrWgmtime localtimerK _MIDNIGHTZhourZminutesecondrR)r currentTimerrZZ currentHourZ currentMinuteZ currentSecondZ currentDayZ rotate_tsrZdayZ daysToWait newRolloverAtdstNow dstAtRolloveraddendrrrrXsH           z(TimedRotatingFileHandler.computeRollovercCs@tjj|jr"tjj|j r"dSttj}||jkr|jjdrx|j rxtj| d } || krx|sld }nd}| |7} | |_dS) 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,irirrCrDr-r-ir-i)r.r/rQrWr`rYrLrJr_rr1ZstrftimerMrrrr2r#r+rqrr3rXrIrO) rrcrfrZZ timeTupleZdstThenrhr5srergrrrrtsH            $ z#TimedRotatingFileHandler.doRollover)r>r,rNFFN) r$r%r&r'r rXrrqrrrrrr=s  9Ir=c@s2eZdZdZd ddZddZd d Zd d ZdS)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)NFcCs,tjj|||||d\|_|_|jdS)Nr,r-r-)r-r-)rr r devino _statstream)rrr r rrrrr s zWatchedFileHandler.__init__cCs0|jr,tj|jj}|t|t|_|_dS)N)r.rfstatfilenorrrtru)rsresrrrrvszWatchedFileHandler._statstreamc Csytj|j}Wntk r(d}YnX| sL|t|jksL|t|jkr|jdk r|jj |jj d|_|j |_|j dS)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. N) rrVr1FileNotFoundErrorrrtrrur.flushr/r3rv)rryrrrreopenIfNeededs  "    z!WatchedFileHandler.reopenIfNeededcCs|jtjj||dS)z Emit a record. If underlying file has changed, reopen the file before emitting the record to it. N)r|rr r)rrrrrrszWatchedFileHandler.emit)r)NF)r$r%r&r'r rvr|rrrrrrss  rsc@sReZdZdZddZdddZddZd d Zd d Zd dZ ddZ ddZ dS) 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. cCsZtjj|||_||_|dkr(||_n ||f|_d|_d|_d|_d|_ d|_ d|_ dS)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@) rHandlerr hostportaddresssock closeOnError retryTime retryStartretryMax retryFactor)rrrrrrr s  zSocketHandler.__init__r,c Csj|jdk rtj|j|d}nJtjtjtj}|j|y|j|jWntk rd|j YnX|S)zr A factory method which allows subclasses to define the precise type of socket they want. N)timeout) rsocketZcreate_connectionrAF_UNIX SOCK_STREAMZ settimeoutconnectOSErrorr/)rrrrrr makeSockets  zSocketHandler.makeSocketc Cstj}|jdkrd}n ||jk}|ry|j|_d|_WnVtk r|jdkr^|j|_n"|j|j|_|j|jkr|j|_||j|_YnXdS)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) rWrrrrrZ retryPeriodrr)rZnowZattemptrrr createSocket"s       zSocketHandler.createSocketc CsR|jdkr|j|jrNy|jj|Wn$tk rL|jjd|_YnXdS)z Send a pickled string to the socket. This function allows for partial sends which can happen when the network is busy. N)rrsendallrr/)rrrrrrsend>s  zSocketHandler.sendcCsj|j}|r|j|}t|j}|j|d<d|d<d|d<|jddtj|d}tj dt |}||S)z Pickles the record in binary format with a length prefix, and returns it ready for transmission across the socket. r<Nargsexc_infomessager,z>L) rr8dict__dict__Z getMessagepoppickledumpsstructZpackr;)rrZeiZdummydrrZslenrrr makePickleQs     zSocketHandler.makePicklecCs0|jr|jr|jjd|_ntjj||dS)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)rrr/rr~r)rrrrrrgs  zSocketHandler.handleErrorc Cs<y|j|}|j|Wntk r6|j|YnXdS)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)rrrr)rrrrrrrrus  zSocketHandler.emitc Cs@|jz(|j}|r"d|_|jtjj|Wd|jXdS)z$ Closes the socket. N)acquirerr/rr~release)rrrrrr/szSocketHandler.closeN)r,) r$r%r&r'r rrrrrrr/rrrrr}s  r}c@s(eZdZdZddZddZddZdS) 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. cCstj|||d|_dS)zP Initializes the handler with a specific host address and port. FN)r}r r)rrrrrrr szDatagramHandler.__init__cCs*|jdkrtj}ntj}tj|tj}|S)zu The factory method of SocketHandler is here overridden to create a UDP socket (SOCK_DGRAM). N)rrrZAF_INET SOCK_DGRAM)rZfamilyrrrrrrs  zDatagramHandler.makeSocketcCs&|jdkr|j|jj||jdS)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)rrsendtor)rrrrrrrs zDatagramHandler.sendN)r$r%r&r'r rrrrrrrs  rc@s"eZdZdZdZdZdZdZdZdZ dZ d Z dZ dZ dZdZdZdZdZd Zd Zd Zd Zd ZdZdZdZdZdZdZdZdZeeee eeee e eeed Z eeeeee eeeeee eeeeeeeeedZ!ddddddZ"de#fe dfd d!Z$d"d#Z%d$d%Z&d&d'Z'd(d)Z(d*Z)d+Z*d,d-Z+dS). 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). rr,r6r[r\r]r^rE ) ZalertZcritcriticaldebugZemergerrerrorinfoZnoticeZpanicwarnwarning)ZauthZauthprivZcrondaemonZftpZkernZlprZmailZnewsZsecurityZsysloguserZuucpZlocal0Zlocal1Zlocal2Zlocal3Zlocal4Zlocal5Zlocal6Zlocal7rrrrr)DEBUGINFOWARNINGERRORCRITICALZ localhostNcCs0tjj|||_||_||_t|trTd|_y|j |Wnt k rPYnXnd|_|dkrht j }|\}}t j ||d|}|st dx|D]|}|\}}} } } d} } y(t j ||| } |t jkr| j| PWqt k r }z|} | dk r| jWYdd}~XqXqW| dk r | | |_ ||_dS)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. TFNrz!getaddrinfo returns an empty list)rr~r rfacilitysocktype isinstancestr unixsocket_connect_unixsocketrrrZ getaddrinforrr/)rrrrrrZressresZafproto_Zsarrexcrrrr #sB      zSysLogHandler.__init__cCs|j}|dkrtj}tjtj||_y|jj|||_Wnxtk r|jj|jdk r`tj}tjtj||_y|jj|||_Wn tk r|jjYnXYnXdS)N)rrrrrrr/r)rrZ use_socktyperrrrYs&       z!SysLogHandler._connect_unixsocketcCs4t|tr|j|}t|tr(|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. r[)rrfacility_namespriority_names)rrZpriorityrrrencodePriorityqs     zSysLogHandler.encodePriorityc Cs2|jz|jjtjj|Wd|jXdS)z$ Closes the socket. N)rrr/rr~r)rrrrr/~s  zSysLogHandler.closecCs|jj|dS)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)rZ levelNamerrr mapPriorityszSysLogHandler.mapPriorityTcCsy|j|}|jr|j|}|jr*|d7}d|j|j|j|j}|jd}|jd}||}|jry|j j |Wqt k r|j j |j |j|j j |YqXn*|jt jkr|j j||jn |j j|Wntk r|j|YnXdS)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)r8ident append_nulrrrZ levelnameencoderrrrr/rrrrrrrr)rrr<Zpriorrrrs.        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_LOCAL7rrrSYSLOG_UDP_PORTr rrr/rrrrrrrrrs 5   rc@s*eZdZdZd ddZddZdd ZdS) SMTPHandlerzK A handler class which sends an SMTP email for each logging event. N@cCstjj|t|ttfr(|\|_|_n|d|_|_t|ttfrR|\|_|_ nd|_||_ t|t rn|g}||_ ||_ ||_||_dS)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)rr~r rlisttuplemailhostmailportusernamepasswordfromaddrrtoaddrssubjectsecurer)rrrrr credentialsrrrrrr s  zSMTPHandler.__init__cCs|jS)z Determine the subject for the email. If you want to specify a subject line which is record-dependent, override this method. )r)rrrrr getSubjectszSMTPHandler.getSubjectc Csyddl}ddlm}ddl}|j}|s.|j}|j|j||jd}|}|j |d<dj |j |d<|j ||d<|j j|d <|j|j||jr|jdk r|j|j|j|j|j|j|j|j||jWntk r|j|YnXdS) zd Emit a record. Format the record and send it to the specified addressees. rN) EmailMessage)rZFrom,ZToZSubjectZDate)smtplibZ email.messagerZ email.utilsrZ SMTP_PORTZSMTPrrrrnrrZutilsr`Z set_contentr8rrZehloZstarttlsZloginrZ send_messagequitrr)rrrrZemailrZsmtpr<rrrrs0      zSMTPHandler.emit)NNr)r$r%r&r'r rrrrrrrs " rc@sBeZdZdZdddZddZdd Zd d Zd d ZddZ dS)NTEventLogHandlera 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. N ApplicationcCstjj|yddl}ddl}||_||_|s`tjj |jj }tjj |d}tjj |dd}||_ ||_ |jj||||j|_tj|jtj|jtj|jtj|jtj|ji|_Wn"tk rtdd|_YnXdS)Nrzwin32service.pydzWThe Python Win32 extensions for NT (service, event logging) appear not to be available.)rr~r win32evtlogutil win32evtlogappname_welurrrj__file__rndllnamelogtypeZAddSourceToRegistryZEVENTLOG_ERROR_TYPEdeftyperZEVENTLOG_INFORMATION_TYPErrZEVENTLOG_WARNING_TYPErrtypemap ImportErrorprint)rrrrrrrrrr s* zNTEventLogHandler.__init__cCsdS)ay 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. r,r)rrrrr getMessageID.szNTEventLogHandler.getMessageIDcCsdS)z Return the event category for the record. Override this if you want to specify your own categories. This version returns 0. rr)rrrrrgetEventCategory8sz"NTEventLogHandler.getEventCategorycCs|jj|j|jS)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. )rrlevelnor)rrrrr getEventTypeAs zNTEventLogHandler.getEventTypec Csn|jrjyD|j|}|j|}|j|}|j|}|jj|j||||gWntk rh|j|YnXdS)z Emit a record. Determine the message ID, event category and event type. Then log the message in the NT event log. N) rrrrr8Z ReportEventrrr)rridcattyper<rrrrNs    zNTEventLogHandler.emitcCstjj|dS)aS 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)rr~r/)rrrrr/_s zNTEventLogHandler.close)Nr) r$r%r&r'r rrrrr/rrrrr s     rc@s*eZdZdZd ddZddZd d ZdS) HTTPHandlerz^ A class which sends records to a Web server, using either GET or POST semantics. GETFNcCsbtjj||j}|dkr$td| r:|dk r:td||_||_||_||_||_ ||_ dS)zr Initialize the instance with the host, the request URL, and the method ("GET" or "POST") rPOSTzmethod must be GET or POSTNz3context parameter only makes sense with secure=True)rr) rr~r rHrPrurlmethodrrcontext)rrrrrrrrrrr qs zHTTPHandler.__init__cCs|jS)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)rrrrr mapLogRecordszHTTPHandler.mapLogRecordc CsxyPddl}ddl}|j}|jr4|jj||jd}n |jj|}|j}|j j |j |}|j dkr|j ddkrvd}nd}|d||f}|j|j ||j d} | dkr|d| }|j d kr|jd d |jd tt||jr$ddl} d |jjd} d| j| jjd} |jd| |j|j d krH|j|jd|jWn tk rr|j|YnXdS)zk Emit a record. Send the record to the Web server as a percent-encoded dictionary rN)rr?&z%c%s:rz Content-typez!application/x-www-form-urlencodedzContent-lengthz%s:%szutf-8zBasic asciiZ Authorization)Z http.clientZ urllib.parserrZclientZHTTPSConnectionrZHTTPConnectionrparseZ urlencoderrfindZ putrequestZ putheaderrr;rbase64rZ b64encodestripdecodeZ endheadersrZ getresponserr) rrZhttpZurllibrr>rdatasepr4rrrrrrrs@        zHTTPHandler.emit)rFNN)r$r%r&r'r rrrrrrrls  rc@s8eZdZdZddZddZddZdd Zd d Zd S) BufferingHandlerz 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. cCstjj|||_g|_dS)z> Initialize the handler with the buffer size. N)rr~r capacitybuffer)rr rrrr s zBufferingHandler.__init__cCst|j|jkS)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 )rrrrr shouldFlushszBufferingHandler.shouldFlushcCs"|jj||j|r|jdS)z Emit a record. Append the record. If shouldFlush() tells us to, call flush() to process the buffer. N)r rmrr{)rrrrrrs  zBufferingHandler.emitc Cs"|jz g|_Wd|jXdS)zw Override to implement custom flushing behaviour. This version just zaps the buffer to empty. N)rr r)rrrrr{s zBufferingHandler.flushc Cs z |jWdtjj|XdS)zp Close the handler. This version just flushes and chains to the parent class' close(). N)r{rr~r/)rrrrr/s zBufferingHandler.closeN) r$r%r&r'r rrr{r/rrrrr s    r c@sBeZdZdZejddfddZddZdd Zd d Z d d Z dS) 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. NTcCs"tj||||_||_||_dS)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)rr rrrrrrr s zMemoryHandler.__init__cCst|j|jkp|j|jkS)zP Check for buffer full or a record at the flushLevel or higher. )r;r r rr)rrrrrrszMemoryHandler.shouldFlushcCs ||_dS)z: Set the target handler for this handler. N)r)rrrrr setTargetszMemoryHandler.setTargetc CsD|jz,|jr2x|jD]}|jj|qWg|_Wd|jXdS)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)rrr handler)rrrrrr{s  zMemoryHandler.flushcCsBz|jr|jWd|jzd|_tj|Wd|jXXdS)zi Flush, if appropriately configured, set the target to None and lose the buffer. N)rr{rrr r/r)rrrrr/,s zMemoryHandler.close) r$r%r&r'rrr rrr{r/rrrrrs rc@s0eZdZdZddZddZddZdd Zd 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. cCstjj|||_dS)zA Initialise an instance, using the passed queue. N)rr~r queue)rrrrrr Hs zQueueHandler.__init__cCs|jj|dS)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)rrrrrenqueueOszQueueHandler.enqueuecCs"|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)r8rr<rr)rrrrrprepareYs  zQueueHandler.preparec Cs8y|j|j|Wntk r2|j|YnXdS)zm Emit a record. Writes the LogRecord to the queue, preparing it for pickling first. N)rrrr)rrrrrrrszQueueHandler.emitN)r$r%r&r'r rrrrrrrr=s   rc@sZeZdZdZdZddddZddZd d Zd d Zd dZ ddZ ddZ ddZ dS) 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. NF)respect_handler_levelcGs||_||_d|_||_dS)zc Initialise an instance with the specified queue and handlers. N)rhandlers_threadr)rrrrrrrr szQueueListener.__init__cCs |jj|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. )rr)rblockrrrdequeueszQueueListener.dequeuecCs&tj|jd|_}d|_|jdS)z Start the listener. This starts up a background thread to monitor the queue for LogRecords to process. )rTN) threadingZThread_monitorrrstart)rrZrrrr"szQueueListener.startcCs|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)rrrrrrszQueueListener.preparecCsD|j|}x4|jD]*}|js"d}n |j|jk}|r|j|qWdS)z Handle a record. This just loops through the handlers offering them the record to handle. TN)rrrrlevelr)rrZhandlerZprocessrrrrs   zQueueListener.handlec Csd|j}t|d}xNy0|jd}||jkr*P|j||r@|jWqtjk rZPYqXqWdS)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)rhasattrr _sentinelrr$ZEmpty)rqZ has_task_donerrrrr!s     zQueueListener._monitorcCs|jj|jdS)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)rrr&)rrrrenqueue_sentinelszQueueListener.enqueue_sentinelcCs|j|jjd|_dS)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(rrn)rrrrstops zQueueListener.stop) r$r%r&r'r&r rr"rrr!r(r)rrrrr~s     riiQ)'r'rrrrrrWrSrVrrrrr rZDEFAULT_TCP_LOGGING_PORTZDEFAULT_UDP_LOGGING_PORTZDEFAULT_HTTP_LOGGING_PORTZDEFAULT_SOAP_LOGGING_PORTrZSYSLOG_TCP_PORTrar rr(r=rsr~r}rrrrrr rrobjectrrrrrsB8  FOcE(*PbO9I@