1 # Copyright 2001-2005 by Vinay Sajip. All Rights Reserved.
3 # Permission to use, copy, modify, and distribute this software and its
4 # documentation for any purpose and without fee is hereby granted,
5 # provided that the above copyright notice appear in all copies and that
6 # both that copyright notice and this permission notice appear in
7 # supporting documentation, and that the name of Vinay Sajip
8 # not be used in advertising or publicity pertaining to distribution
9 # of the software without specific, written prior permission.
10 # VINAY SAJIP DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
11 # ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
12 # VINAY SAJIP BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
13 # ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
14 # IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
15 # OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 Additional handlers for the logging package for Python. The core package is
19 based on PEP 282 and comments thereto in comp.lang.python, and influenced by
20 Apache's log4j system.
22 Should work under Python versions >= 1.5.2, except that source line
23 information is not available unless 'sys._getframe()' is.
25 Copyright (C) 2001-2004 Vinay Sajip. All Rights Reserved.
27 To use, simply 'import logging' and log away!
30 import sys
, logging
, socket
, types
, os
, string
, cPickle
, struct
, time
, glob
41 DEFAULT_TCP_LOGGING_PORT
= 9020
42 DEFAULT_UDP_LOGGING_PORT
= 9021
43 DEFAULT_HTTP_LOGGING_PORT
= 9022
44 DEFAULT_SOAP_LOGGING_PORT
= 9023
47 class BaseRotatingHandler(logging
.FileHandler
):
49 Base class for handlers that rotate log files at a certain point.
50 Not meant to be instantiated directly. Instead, use RotatingFileHandler
51 or TimedRotatingFileHandler.
53 def __init__(self
, filename
, mode
, encoding
=None):
55 Use the specified filename for streamed logging
59 logging
.FileHandler
.__init
__(self
, filename
, mode
, encoding
)
61 self
.encoding
= encoding
63 def emit(self
, record
):
67 Output the record to the file, catering for rollover as described
71 if self
.shouldRollover(record
):
73 logging
.FileHandler
.emit(self
, record
)
74 except (KeyboardInterrupt, SystemExit):
77 self
.handleError(record
)
79 class RotatingFileHandler(BaseRotatingHandler
):
81 Handler for logging to a set of files, which switches from one file
82 to the next when the current file reaches a certain size.
84 def __init__(self
, filename
, mode
='a', maxBytes
=0, backupCount
=0, encoding
=None):
86 Open the specified file and use it as the stream for logging.
88 By default, the file grows indefinitely. You can specify particular
89 values of maxBytes and backupCount to allow the file to rollover at
92 Rollover occurs whenever the current log file is nearly maxBytes in
93 length. If backupCount is >= 1, the system will successively create
94 new files with the same pathname as the base file, but with extensions
95 ".1", ".2" etc. appended to it. For example, with a backupCount of 5
96 and a base file name of "app.log", you would get "app.log",
97 "app.log.1", "app.log.2", ... through to "app.log.5". The file being
98 written to is always "app.log" - when it gets filled up, it is closed
99 and renamed to "app.log.1", and if files "app.log.1", "app.log.2" etc.
100 exist, then they are renamed to "app.log.2", "app.log.3" etc.
103 If maxBytes is zero, rollover never occurs.
106 mode
= 'a' # doesn't make sense otherwise!
107 BaseRotatingHandler
.__init
__(self
, filename
, mode
, encoding
)
108 self
.maxBytes
= maxBytes
109 self
.backupCount
= backupCount
111 def doRollover(self
):
113 Do a rollover, as described in __init__().
117 if self
.backupCount
> 0:
118 for i
in range(self
.backupCount
- 1, 0, -1):
119 sfn
= "%s.%d" % (self
.baseFilename
, i
)
120 dfn
= "%s.%d" % (self
.baseFilename
, i
+ 1)
121 if os
.path
.exists(sfn
):
122 #print "%s -> %s" % (sfn, dfn)
123 if os
.path
.exists(dfn
):
126 dfn
= self
.baseFilename
+ ".1"
127 if os
.path
.exists(dfn
):
129 os
.rename(self
.baseFilename
, dfn
)
130 #print "%s -> %s" % (self.baseFilename, dfn)
132 self
.stream
= codecs
.open(self
.baseFilename
, 'w', self
.encoding
)
134 self
.stream
= open(self
.baseFilename
, 'w')
136 def shouldRollover(self
, record
):
138 Determine if rollover should occur.
140 Basically, see if the supplied record would cause the file to exceed
141 the size limit we have.
143 if self
.maxBytes
> 0: # are we rolling over?
144 msg
= "%s\n" % self
.format(record
)
145 self
.stream
.seek(0, 2) #due to non-posix-compliant Windows feature
146 if self
.stream
.tell() + len(msg
) >= self
.maxBytes
:
150 class TimedRotatingFileHandler(BaseRotatingHandler
):
152 Handler for logging to a file, rotating the log file at certain timed
155 If backupCount is > 0, when rollover is done, no more than backupCount
156 files are kept - the oldest ones are deleted.
158 def __init__(self
, filename
, when
='h', interval
=1, backupCount
=0, encoding
=None):
159 BaseRotatingHandler
.__init
__(self
, filename
, 'a', encoding
)
160 self
.when
= string
.upper(when
)
161 self
.backupCount
= backupCount
162 # Calculate the real rollover interval, which is just the number of
163 # seconds between rollovers. Also set the filename suffix used when
164 # a rollover occurs. Current 'when' events supported:
169 # midnight - roll over at midnight
170 # W{0-6} - roll over on a certain day; 0 - Monday
172 # Case of the 'when' specifier is not important; lower or upper case
174 currentTime
= int(time
.time())
176 self
.interval
= 1 # one second
177 self
.suffix
= "%Y-%m-%d_%H-%M-%S"
178 elif self
.when
== 'M':
179 self
.interval
= 60 # one minute
180 self
.suffix
= "%Y-%m-%d_%H-%M"
181 elif self
.when
== 'H':
182 self
.interval
= 60 * 60 # one hour
183 self
.suffix
= "%Y-%m-%d_%H"
184 elif self
.when
== 'D' or self
.when
== 'MIDNIGHT':
185 self
.interval
= 60 * 60 * 24 # one day
186 self
.suffix
= "%Y-%m-%d"
187 elif self
.when
.startswith('W'):
188 self
.interval
= 60 * 60 * 24 * 7 # one week
189 if len(self
.when
) != 2:
190 raise ValueError("You must specify a day for weekly rollover from 0 to 6 (0 is Monday): %s" % self
.when
)
191 if self
.when
[1] < '0' or self
.when
[1] > '6':
192 raise ValueError("Invalid day specified for weekly rollover: %s" % self
.when
)
193 self
.dayOfWeek
= int(self
.when
[1])
194 self
.suffix
= "%Y-%m-%d"
196 raise ValueError("Invalid rollover interval specified: %s" % self
.when
)
198 self
.interval
= self
.interval
* interval
# multiply by units requested
199 self
.rolloverAt
= currentTime
+ self
.interval
201 # If we are rolling over at midnight or weekly, then the interval is already known.
202 # What we need to figure out is WHEN the next interval is. In other words,
203 # if you are rolling over at midnight, then your base interval is 1 day,
204 # but you want to start that one day clock at midnight, not now. So, we
205 # have to fudge the rolloverAt value in order to trigger the first rollover
206 # at the right time. After that, the regular interval will take care of
207 # the rest. Note that this code doesn't care about leap seconds. :)
208 if self
.when
== 'MIDNIGHT' or self
.when
.startswith('W'):
209 # This could be done with less code, but I wanted it to be clear
210 t
= time
.localtime(currentTime
)
214 # r is the number of seconds left between now and midnight
215 r
= (24 - currentHour
) * 60 * 60 # number of hours in seconds
216 r
= r
+ (59 - currentMinute
) * 60 # plus the number of minutes (in secs)
217 r
= r
+ (59 - currentSecond
) # plus the number of seconds
218 self
.rolloverAt
= currentTime
+ r
219 # If we are rolling over on a certain day, add in the number of days until
220 # the next rollover, but offset by 1 since we just calculated the time
221 # until the next day starts. There are three cases:
222 # Case 1) The day to rollover is today; in this case, do nothing
223 # Case 2) The day to rollover is further in the interval (i.e., today is
224 # day 2 (Wednesday) and rollover is on day 6 (Sunday). Days to
225 # next rollover is simply 6 - 2 - 1, or 3.
226 # Case 3) The day to rollover is behind us in the interval (i.e., today
227 # is day 5 (Saturday) and rollover is on day 3 (Thursday).
228 # Days to rollover is 6 - 5 + 3, or 4. In this case, it's the
229 # number of days left in the current week (1) plus the number
230 # of days in the next week until the rollover day (3).
231 if when
.startswith('W'):
232 day
= t
[6] # 0 is Monday
233 if day
> self
.dayOfWeek
:
234 daysToWait
= (day
- self
.dayOfWeek
) - 1
235 self
.rolloverAt
= self
.rolloverAt
+ (daysToWait
* (60 * 60 * 24))
236 if day
< self
.dayOfWeek
:
237 daysToWait
= (6 - self
.dayOfWeek
) + day
238 self
.rolloverAt
= self
.rolloverAt
+ (daysToWait
* (60 * 60 * 24))
240 #print "Will rollover at %d, %d seconds from now" % (self.rolloverAt, self.rolloverAt - currentTime)
242 def shouldRollover(self
, record
):
244 Determine if rollover should occur
246 record is not used, as we are just comparing times, but it is needed so
247 the method siguratures are the same
250 if t
>= self
.rolloverAt
:
252 #print "No need to rollover: %d, %d" % (t, self.rolloverAt)
255 def doRollover(self
):
257 do a rollover; in this case, a date/time stamp is appended to the filename
258 when the rollover happens. However, you want the file to be named for the
259 start of the interval, not the current time. If there is a backup count,
260 then we have to get a list of matching filenames, sort them and remove
261 the one with the oldest suffix.
264 # get the time that this sequence started at and make it a TimeTuple
265 t
= self
.rolloverAt
- self
.interval
266 timeTuple
= time
.localtime(t
)
267 dfn
= self
.baseFilename
+ "." + time
.strftime(self
.suffix
, timeTuple
)
268 if os
.path
.exists(dfn
):
270 os
.rename(self
.baseFilename
, dfn
)
271 if self
.backupCount
> 0:
272 # find the oldest log file and delete it
273 s
= glob
.glob(self
.baseFilename
+ ".20*")
274 if len(s
) > self
.backupCount
:
277 #print "%s -> %s" % (self.baseFilename, dfn)
279 self
.stream
= codecs
.open(self
.baseFilename
, 'w', self
.encoding
)
281 self
.stream
= open(self
.baseFilename
, 'w')
282 self
.rolloverAt
= int(time
.time()) + self
.interval
284 class SocketHandler(logging
.Handler
):
286 A handler class which writes logging records, in pickle format, to
287 a streaming socket. The socket is kept open across logging calls.
288 If the peer resets it, an attempt is made to reconnect on the next call.
289 The pickle which is sent is that of the LogRecord's attribute dictionary
290 (__dict__), so that the receiver does not need to have the logging module
291 installed in order to process the logging event.
293 To unpickle the record at the receiving end into a LogRecord, use the
294 makeLogRecord function.
297 def __init__(self
, host
, port
):
299 Initializes the handler with a specific host address and port.
301 The attribute 'closeOnError' is set to 1 - which means that if
302 a socket error occurs, the socket is silently closed and then
303 reopened on the next logging call.
305 logging
.Handler
.__init
__(self
)
309 self
.closeOnError
= 0
310 self
.retryTime
= None
312 # Exponential backoff parameters.
314 self
.retryStart
= 1.0
316 self
.retryFactor
= 2.0
318 def makeSocket(self
):
320 A factory method which allows subclasses to define the precise
321 type of socket they want.
323 s
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
324 s
.connect((self
.host
, self
.port
))
327 def createSocket(self
):
329 Try to create a socket, using an exponential backoff with
330 a max retry time. Thanks to Robert Olson for the original patch
331 (SF #815911) which has been slightly refactored.
334 # Either retryTime is None, in which case this
335 # is the first time back after a disconnect, or
336 # we've waited long enough.
337 if self
.retryTime
is None:
340 attempt
= (now
>= self
.retryTime
)
343 self
.sock
= self
.makeSocket()
344 self
.retryTime
= None # next time, no delay before trying
346 #Creation failed, so set the retry time and return.
347 if self
.retryTime
is None:
348 self
.retryPeriod
= self
.retryStart
350 self
.retryPeriod
= self
.retryPeriod
* self
.retryFactor
351 if self
.retryPeriod
> self
.retryMax
:
352 self
.retryPeriod
= self
.retryMax
353 self
.retryTime
= now
+ self
.retryPeriod
357 Send a pickled string to the socket.
359 This function allows for partial sends which can happen when the
362 if self
.sock
is None:
364 #self.sock can be None either because we haven't reached the retry
365 #time yet, or because we have reached the retry time and retried,
366 #but are still unable to connect.
369 if hasattr(self
.sock
, "sendall"):
375 sent
= self
.sock
.send(s
[sentsofar
:])
376 sentsofar
= sentsofar
+ sent
380 self
.sock
= None # so we can call createSocket next time
382 def makePickle(self
, record
):
384 Pickles the record in binary format with a length prefix, and
385 returns it ready for transmission across the socket.
389 dummy
= self
.format(record
) # just to get traceback text into record.exc_text
390 record
.exc_info
= None # to avoid Unpickleable error
391 s
= cPickle
.dumps(record
.__dict
__, 1)
393 record
.exc_info
= ei
# for next handler
394 slen
= struct
.pack(">L", len(s
))
397 def handleError(self
, record
):
399 Handle an error during logging.
401 An error has occurred during logging. Most likely cause -
402 connection lost. Close the socket so that we can retry on the
405 if self
.closeOnError
and self
.sock
:
407 self
.sock
= None #try to reconnect next time
409 logging
.Handler
.handleError(self
, record
)
411 def emit(self
, record
):
415 Pickles the record and writes it to the socket in binary format.
416 If there is an error with the socket, silently drop the packet.
417 If there was a problem with the socket, re-establishes the
421 s
= self
.makePickle(record
)
423 except (KeyboardInterrupt, SystemExit):
426 self
.handleError(record
)
435 logging
.Handler
.close(self
)
437 class DatagramHandler(SocketHandler
):
439 A handler class which writes logging records, in pickle format, to
440 a datagram socket. The pickle which is sent is that of the LogRecord's
441 attribute dictionary (__dict__), so that the receiver does not need to
442 have the logging module installed in order to process the logging event.
444 To unpickle the record at the receiving end into a LogRecord, use the
445 makeLogRecord function.
448 def __init__(self
, host
, port
):
450 Initializes the handler with a specific host address and port.
452 SocketHandler
.__init
__(self
, host
, port
)
453 self
.closeOnError
= 0
455 def makeSocket(self
):
457 The factory method of SocketHandler is here overridden to create
458 a UDP socket (SOCK_DGRAM).
460 s
= socket
.socket(socket
.AF_INET
, socket
.SOCK_DGRAM
)
465 Send a pickled string to a socket.
467 This function no longer allows for partial sends which can happen
468 when the network is busy - UDP does not guarantee delivery and
469 can deliver packets out of sequence.
471 if self
.sock
is None:
473 self
.sock
.sendto(s
, (self
.host
, self
.port
))
475 class SysLogHandler(logging
.Handler
):
477 A handler class which sends formatted logging records to a syslog
478 server. Based on Sam Rushing's syslog module:
479 http://www.nightmare.com/squirl/python-ext/misc/syslog.py
480 Contributed by Nicolas Untz (after which minor refactoring changes
484 # from <linux/sys/syslog.h>:
485 # ======================================================================
486 # priorities/facilities are encoded into a single 32-bit quantity, where
487 # the bottom 3 bits are the priority (0-7) and the top 28 bits are the
488 # facility (0-big number). Both the priorities and the facilities map
489 # roughly one-to-one to strings in the syslogd(8) source code. This
490 # mapping is included in this file.
492 # priorities (these are ordered)
494 LOG_EMERG
= 0 # system is unusable
495 LOG_ALERT
= 1 # action must be taken immediately
496 LOG_CRIT
= 2 # critical conditions
497 LOG_ERR
= 3 # error conditions
498 LOG_WARNING
= 4 # warning conditions
499 LOG_NOTICE
= 5 # normal but significant condition
500 LOG_INFO
= 6 # informational
501 LOG_DEBUG
= 7 # debug-level messages
504 LOG_KERN
= 0 # kernel messages
505 LOG_USER
= 1 # random user-level messages
506 LOG_MAIL
= 2 # mail system
507 LOG_DAEMON
= 3 # system daemons
508 LOG_AUTH
= 4 # security/authorization messages
509 LOG_SYSLOG
= 5 # messages generated internally by syslogd
510 LOG_LPR
= 6 # line printer subsystem
511 LOG_NEWS
= 7 # network news subsystem
512 LOG_UUCP
= 8 # UUCP subsystem
513 LOG_CRON
= 9 # clock daemon
514 LOG_AUTHPRIV
= 10 # security/authorization messages (private)
516 # other codes through 15 reserved for system use
517 LOG_LOCAL0
= 16 # reserved for local use
518 LOG_LOCAL1
= 17 # reserved for local use
519 LOG_LOCAL2
= 18 # reserved for local use
520 LOG_LOCAL3
= 19 # reserved for local use
521 LOG_LOCAL4
= 20 # reserved for local use
522 LOG_LOCAL5
= 21 # reserved for local use
523 LOG_LOCAL6
= 22 # reserved for local use
524 LOG_LOCAL7
= 23 # reserved for local use
529 "critical": LOG_CRIT
,
533 "error": LOG_ERR
, # DEPRECATED
535 "notice": LOG_NOTICE
,
536 "panic": LOG_EMERG
, # DEPRECATED
537 "warn": LOG_WARNING
, # DEPRECATED
538 "warning": LOG_WARNING
,
543 "authpriv": LOG_AUTHPRIV
,
545 "daemon": LOG_DAEMON
,
550 "security": LOG_AUTH
, # DEPRECATED
551 "syslog": LOG_SYSLOG
,
554 "local0": LOG_LOCAL0
,
555 "local1": LOG_LOCAL1
,
556 "local2": LOG_LOCAL2
,
557 "local3": LOG_LOCAL3
,
558 "local4": LOG_LOCAL4
,
559 "local5": LOG_LOCAL5
,
560 "local6": LOG_LOCAL6
,
561 "local7": LOG_LOCAL7
,
564 def __init__(self
, address
=('localhost', SYSLOG_UDP_PORT
), facility
=LOG_USER
):
566 Initialize a handler.
568 If address is specified as a string, UNIX socket is used.
569 If facility is not specified, LOG_USER is used.
571 logging
.Handler
.__init
__(self
)
573 self
.address
= address
574 self
.facility
= facility
575 if type(address
) == types
.StringType
:
576 self
._connect
_unixsocket
(address
)
579 self
.socket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_DGRAM
)
582 self
.formatter
= None
584 def _connect_unixsocket(self
, address
):
585 self
.socket
= socket
.socket(socket
.AF_UNIX
, socket
.SOCK_DGRAM
)
586 # syslog may require either DGRAM or STREAM sockets
588 self
.socket
.connect(address
)
591 self
.socket
= socket
.socket(socket
.AF_UNIX
, socket
.SOCK_STREAM
)
592 self
.socket
.connect(address
)
594 # curious: when talking to the unix-domain '/dev/log' socket, a
595 # zero-terminator seems to be required. this string is placed
596 # into a class variable so that it can be overridden if
598 log_format_string
= '<%d>%s\000'
600 def encodePriority (self
, facility
, priority
):
602 Encode the facility and priority. You can pass in strings or
603 integers - if strings are passed, the facility_names and
604 priority_names mapping dictionaries are used to convert them to
607 if type(facility
) == types
.StringType
:
608 facility
= self
.facility_names
[facility
]
609 if type(priority
) == types
.StringType
:
610 priority
= self
.priority_names
[priority
]
611 return (facility
<< 3) | priority
619 logging
.Handler
.close(self
)
621 def emit(self
, record
):
625 The record is formatted, and then sent to the syslog server. If
626 exception information is present, it is NOT sent to the server.
628 msg
= self
.format(record
)
630 We need to convert record level to lowercase, maybe this will
631 change in the future.
633 msg
= self
.log_format_string
% (
634 self
.encodePriority(self
.facility
,
635 string
.lower(record
.levelname
)),
640 self
.socket
.send(msg
)
642 self
._connect
_unixsocket
(self
.address
)
643 self
.socket
.send(msg
)
645 self
.socket
.sendto(msg
, self
.address
)
646 except (KeyboardInterrupt, SystemExit):
649 self
.handleError(record
)
651 class SMTPHandler(logging
.Handler
):
653 A handler class which sends an SMTP email for each logging event.
655 def __init__(self
, mailhost
, fromaddr
, toaddrs
, subject
):
657 Initialize the handler.
659 Initialize the instance with the from and to addresses and subject
660 line of the email. To specify a non-standard SMTP port, use the
661 (host, port) tuple format for the mailhost argument.
663 logging
.Handler
.__init
__(self
)
664 if type(mailhost
) == types
.TupleType
:
665 host
, port
= mailhost
669 self
.mailhost
= mailhost
671 self
.fromaddr
= fromaddr
672 if type(toaddrs
) == types
.StringType
:
674 self
.toaddrs
= toaddrs
675 self
.subject
= subject
677 def getSubject(self
, record
):
679 Determine the subject for the email.
681 If you want to specify a subject line which is record-dependent,
682 override this method.
686 weekdayname
= ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
689 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
690 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
694 Return the current date and time formatted for a MIME header.
695 Needed for Python 1.5.2 (no email package available)
697 year
, month
, day
, hh
, mm
, ss
, wd
, y
, z
= time
.gmtime(time
.time())
698 s
= "%s, %02d %3s %4d %02d:%02d:%02d GMT" % (
699 self
.weekdayname
[wd
],
700 day
, self
.monthname
[month
], year
,
704 def emit(self
, record
):
708 Format the record and send it to the specified addressees.
713 from email
.Utils
import formatdate
715 formatdate
= self
.date_time
718 port
= smtplib
.SMTP_PORT
719 smtp
= smtplib
.SMTP(self
.mailhost
, port
)
720 msg
= self
.format(record
)
721 msg
= "From: %s\r\nTo: %s\r\nSubject: %s\r\nDate: %s\r\n\r\n%s" % (
723 string
.join(self
.toaddrs
, ","),
724 self
.getSubject(record
),
726 smtp
.sendmail(self
.fromaddr
, self
.toaddrs
, msg
)
728 except (KeyboardInterrupt, SystemExit):
731 self
.handleError(record
)
733 class NTEventLogHandler(logging
.Handler
):
735 A handler class which sends events to the NT Event Log. Adds a
736 registry entry for the specified application name. If no dllname is
737 provided, win32service.pyd (which contains some basic message
738 placeholders) is used. Note that use of these placeholders will make
739 your event logs big, as the entire message source is held in the log.
740 If you want slimmer logs, you have to pass in the name of your own DLL
741 which contains the message definitions you want to use in the event log.
743 def __init__(self
, appname
, dllname
=None, logtype
="Application"):
744 logging
.Handler
.__init
__(self
)
746 import win32evtlogutil
, win32evtlog
747 self
.appname
= appname
748 self
._welu
= win32evtlogutil
750 dllname
= os
.path
.split(self
._welu
.__file
__)
751 dllname
= os
.path
.split(dllname
[0])
752 dllname
= os
.path
.join(dllname
[0], r
'win32service.pyd')
753 self
.dllname
= dllname
754 self
.logtype
= logtype
755 self
._welu
.AddSourceToRegistry(appname
, dllname
, logtype
)
756 self
.deftype
= win32evtlog
.EVENTLOG_ERROR_TYPE
758 logging
.DEBUG
: win32evtlog
.EVENTLOG_INFORMATION_TYPE
,
759 logging
.INFO
: win32evtlog
.EVENTLOG_INFORMATION_TYPE
,
760 logging
.WARNING
: win32evtlog
.EVENTLOG_WARNING_TYPE
,
761 logging
.ERROR
: win32evtlog
.EVENTLOG_ERROR_TYPE
,
762 logging
.CRITICAL
: win32evtlog
.EVENTLOG_ERROR_TYPE
,
765 print "The Python Win32 extensions for NT (service, event "\
766 "logging) appear not to be available."
769 def getMessageID(self
, record
):
771 Return the message ID for the event record. If you are using your
772 own messages, you could do this by having the msg passed to the
773 logger being an ID rather than a formatting string. Then, in here,
774 you could use a dictionary lookup to get the message ID. This
775 version returns 1, which is the base message ID in win32service.pyd.
779 def getEventCategory(self
, record
):
781 Return the event category for the record.
783 Override this if you want to specify your own categories. This version
788 def getEventType(self
, record
):
790 Return the event type for the record.
792 Override this if you want to specify your own types. This version does
793 a mapping using the handler's typemap attribute, which is set up in
794 __init__() to a dictionary which contains mappings for DEBUG, INFO,
795 WARNING, ERROR and CRITICAL. If you are using your own levels you will
796 either need to override this method or place a suitable dictionary in
797 the handler's typemap attribute.
799 return self
.typemap
.get(record
.levelno
, self
.deftype
)
801 def emit(self
, record
):
805 Determine the message ID, event category and event type. Then
806 log the message in the NT event log.
810 id = self
.getMessageID(record
)
811 cat
= self
.getEventCategory(record
)
812 type = self
.getEventType(record
)
813 msg
= self
.format(record
)
814 self
._welu
.ReportEvent(self
.appname
, id, cat
, type, [msg
])
815 except (KeyboardInterrupt, SystemExit):
818 self
.handleError(record
)
822 Clean up this handler.
824 You can remove the application name from the registry as a
825 source of event log entries. However, if you do this, you will
826 not be able to see the events as you intended in the Event Log
827 Viewer - it needs to be able to access the registry to get the
830 #self._welu.RemoveSourceFromRegistry(self.appname, self.logtype)
831 logging
.Handler
.close(self
)
833 class HTTPHandler(logging
.Handler
):
835 A class which sends records to a Web server, using either GET or
838 def __init__(self
, host
, url
, method
="GET"):
840 Initialize the instance with the host, the request URL, and the method
843 logging
.Handler
.__init
__(self
)
844 method
= string
.upper(method
)
845 if method
not in ["GET", "POST"]:
846 raise ValueError, "method must be GET or POST"
851 def mapLogRecord(self
, record
):
853 Default implementation of mapping the log record into a dict
854 that is sent as the CGI data. Overwrite in your class.
855 Contributed by Franz Glasner.
857 return record
.__dict
__
859 def emit(self
, record
):
863 Send the record to the Web server as an URL-encoded dictionary
866 import httplib
, urllib
868 h
= httplib
.HTTP(host
)
870 data
= urllib
.urlencode(self
.mapLogRecord(record
))
871 if self
.method
== "GET":
872 if (string
.find(url
, '?') >= 0):
876 url
= url
+ "%c%s" % (sep
, data
)
877 h
.putrequest(self
.method
, url
)
878 # support multiple hosts on one IP address...
879 # need to strip optional :port from host, if present
880 i
= string
.find(host
, ":")
883 h
.putheader("Host", host
)
884 if self
.method
== "POST":
885 h
.putheader("Content-type",
886 "application/x-www-form-urlencoded")
887 h
.putheader("Content-length", str(len(data
)))
889 if self
.method
== "POST":
891 h
.getreply() #can't do anything with the result
892 except (KeyboardInterrupt, SystemExit):
895 self
.handleError(record
)
897 class BufferingHandler(logging
.Handler
):
899 A handler class which buffers logging records in memory. Whenever each
900 record is added to the buffer, a check is made to see if the buffer should
901 be flushed. If it should, then flush() is expected to do what's needed.
903 def __init__(self
, capacity
):
905 Initialize the handler with the buffer size.
907 logging
.Handler
.__init
__(self
)
908 self
.capacity
= capacity
911 def shouldFlush(self
, record
):
913 Should the handler flush its buffer?
915 Returns true if the buffer is up to capacity. This method can be
916 overridden to implement custom flushing strategies.
918 return (len(self
.buffer) >= self
.capacity
)
920 def emit(self
, record
):
924 Append the record. If shouldFlush() tells us to, call flush() to process
927 self
.buffer.append(record
)
928 if self
.shouldFlush(record
):
933 Override to implement custom flushing behaviour.
935 This version just zaps the buffer to empty.
943 This version just flushes and chains to the parent class' close().
946 logging
.Handler
.close(self
)
948 class MemoryHandler(BufferingHandler
):
950 A handler class which buffers logging records in memory, periodically
951 flushing them to a target handler. Flushing occurs whenever the buffer
952 is full, or when an event of a certain severity or greater is seen.
954 def __init__(self
, capacity
, flushLevel
=logging
.ERROR
, target
=None):
956 Initialize the handler with the buffer size, the level at which
957 flushing should occur and an optional target.
959 Note that without a target being set either here or via setTarget(),
960 a MemoryHandler is no use to anyone!
962 BufferingHandler
.__init
__(self
, capacity
)
963 self
.flushLevel
= flushLevel
966 def shouldFlush(self
, record
):
968 Check for buffer full or a record at the flushLevel or higher.
970 return (len(self
.buffer) >= self
.capacity
) or \
971 (record
.levelno
>= self
.flushLevel
)
973 def setTarget(self
, target
):
975 Set the target handler for this handler.
981 For a MemoryHandler, flushing means just sending the buffered
982 records to the target, if there is one. Override if you want
986 for record
in self
.buffer:
987 self
.target
.handle(record
)
992 Flush, set the target to None and lose the buffer.
996 BufferingHandler
.close(self
)