Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 1 | # Copyright 2001-2012 by Vinay Sajip. All Rights Reserved. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 2 | # |
| 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. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 16 | |
| 17 | """ |
Vinay Sajip | 3f74284 | 2004-02-28 16:07:46 +0000 | [diff] [blame] | 18 | Additional handlers for the logging package for Python. The core package is |
Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 19 | based on PEP 282 and comments thereto in comp.lang.python. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 20 | |
Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 21 | Copyright (C) 2001-2012 Vinay Sajip. All Rights Reserved. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 22 | |
Vinay Sajip | 6268cbc | 2009-01-21 00:19:28 +0000 | [diff] [blame] | 23 | To use, simply 'import logging.handlers' and log away! |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 24 | """ |
| 25 | |
Vinay Sajip | 66b8b08 | 2012-04-24 23:25:30 +0100 | [diff] [blame] | 26 | import errno, logging, socket, os, pickle, struct, time, re |
Florent Xicluna | 5252f9f | 2011-11-07 19:43:05 +0100 | [diff] [blame] | 27 | from codecs import BOM_UTF8 |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 28 | from stat import ST_DEV, ST_INO, ST_MTIME |
Vinay Sajip | e723e96 | 2011-04-15 22:27:17 +0100 | [diff] [blame] | 29 | import queue |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 30 | try: |
| 31 | import threading |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 32 | except ImportError: #pragma: no cover |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 33 | threading = None |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 34 | |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 35 | # |
| 36 | # Some constants... |
| 37 | # |
| 38 | |
| 39 | DEFAULT_TCP_LOGGING_PORT = 9020 |
| 40 | DEFAULT_UDP_LOGGING_PORT = 9021 |
| 41 | DEFAULT_HTTP_LOGGING_PORT = 9022 |
| 42 | DEFAULT_SOAP_LOGGING_PORT = 9023 |
| 43 | SYSLOG_UDP_PORT = 514 |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 44 | SYSLOG_TCP_PORT = 514 |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 45 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 46 | _MIDNIGHT = 24 * 60 * 60 # number of seconds in a day |
| 47 | |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 48 | class BaseRotatingHandler(logging.FileHandler): |
| 49 | """ |
| 50 | Base class for handlers that rotate log files at a certain point. |
| 51 | Not meant to be instantiated directly. Instead, use RotatingFileHandler |
| 52 | or TimedRotatingFileHandler. |
| 53 | """ |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 54 | def __init__(self, filename, mode, encoding=None, delay=False): |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 55 | """ |
| 56 | Use the specified filename for streamed logging |
| 57 | """ |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 58 | logging.FileHandler.__init__(self, filename, mode, encoding, delay) |
Vinay Sajip | 4600f11 | 2005-03-13 09:56:36 +0000 | [diff] [blame] | 59 | self.mode = mode |
| 60 | self.encoding = encoding |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 61 | self.namer = None |
| 62 | self.rotator = None |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 63 | |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 64 | def emit(self, record): |
| 65 | """ |
| 66 | Emit a record. |
| 67 | |
| 68 | Output the record to the file, catering for rollover as described |
| 69 | in doRollover(). |
| 70 | """ |
Vinay Sajip | 3970c11 | 2004-07-08 10:24:04 +0000 | [diff] [blame] | 71 | try: |
| 72 | if self.shouldRollover(record): |
| 73 | self.doRollover() |
| 74 | logging.FileHandler.emit(self, record) |
Vinay Sajip | 8cf4eb1 | 2012-10-09 08:06:13 +0100 | [diff] [blame] | 75 | except Exception: |
Vinay Sajip | 3970c11 | 2004-07-08 10:24:04 +0000 | [diff] [blame] | 76 | self.handleError(record) |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 77 | |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 78 | def rotation_filename(self, default_name): |
| 79 | """ |
| 80 | Modify the filename of a log file when rotating. |
| 81 | |
| 82 | This is provided so that a custom filename can be provided. |
| 83 | |
| 84 | The default implementation calls the 'namer' attribute of the |
| 85 | handler, if it's callable, passing the default name to |
| 86 | it. If the attribute isn't callable (the default is None), the name |
| 87 | is returned unchanged. |
| 88 | |
| 89 | :param default_name: The default name for the log file. |
| 90 | """ |
| 91 | if not callable(self.namer): |
| 92 | result = default_name |
| 93 | else: |
| 94 | result = self.namer(default_name) |
| 95 | return result |
| 96 | |
| 97 | def rotate(self, source, dest): |
| 98 | """ |
| 99 | When rotating, rotate the current log. |
| 100 | |
| 101 | The default implementation calls the 'rotator' attribute of the |
| 102 | handler, if it's callable, passing the source and dest arguments to |
| 103 | it. If the attribute isn't callable (the default is None), the source |
| 104 | is simply renamed to the destination. |
| 105 | |
| 106 | :param source: The source filename. This is normally the base |
| 107 | filename, e.g. 'test.log' |
| 108 | :param dest: The destination filename. This is normally |
| 109 | what the source is rotated to, e.g. 'test.log.1'. |
| 110 | """ |
| 111 | if not callable(self.rotator): |
| 112 | os.rename(source, dest) |
| 113 | else: |
| 114 | self.rotator(source, dest) |
| 115 | |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 116 | class RotatingFileHandler(BaseRotatingHandler): |
| 117 | """ |
| 118 | Handler for logging to a set of files, which switches from one file |
| 119 | to the next when the current file reaches a certain size. |
| 120 | """ |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 121 | def __init__(self, filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=False): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 122 | """ |
| 123 | Open the specified file and use it as the stream for logging. |
| 124 | |
| 125 | By default, the file grows indefinitely. You can specify particular |
| 126 | values of maxBytes and backupCount to allow the file to rollover at |
| 127 | a predetermined size. |
| 128 | |
| 129 | Rollover occurs whenever the current log file is nearly maxBytes in |
| 130 | length. If backupCount is >= 1, the system will successively create |
| 131 | new files with the same pathname as the base file, but with extensions |
| 132 | ".1", ".2" etc. appended to it. For example, with a backupCount of 5 |
| 133 | and a base file name of "app.log", you would get "app.log", |
| 134 | "app.log.1", "app.log.2", ... through to "app.log.5". The file being |
| 135 | written to is always "app.log" - when it gets filled up, it is closed |
| 136 | and renamed to "app.log.1", and if files "app.log.1", "app.log.2" etc. |
| 137 | exist, then they are renamed to "app.log.2", "app.log.3" etc. |
| 138 | respectively. |
| 139 | |
| 140 | If maxBytes is zero, rollover never occurs. |
| 141 | """ |
Vinay Sajip | 89994b2 | 2010-08-22 18:11:02 +0000 | [diff] [blame] | 142 | # If rotation/rollover is wanted, it doesn't make sense to use another |
| 143 | # mode. If for example 'w' were specified, then if there were multiple |
| 144 | # runs of the calling application, the logs from previous runs would be |
| 145 | # lost if the 'w' is respected, because the log file would be truncated |
| 146 | # on each run. |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 147 | if maxBytes > 0: |
Vinay Sajip | 89994b2 | 2010-08-22 18:11:02 +0000 | [diff] [blame] | 148 | mode = 'a' |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 149 | BaseRotatingHandler.__init__(self, filename, mode, encoding, delay) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 150 | self.maxBytes = maxBytes |
| 151 | self.backupCount = backupCount |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 152 | |
| 153 | def doRollover(self): |
| 154 | """ |
| 155 | Do a rollover, as described in __init__(). |
| 156 | """ |
Vinay Sajip | 6268cbc | 2009-01-21 00:19:28 +0000 | [diff] [blame] | 157 | if self.stream: |
| 158 | self.stream.close() |
Vinay Sajip | 01241d6 | 2011-01-21 23:35:57 +0000 | [diff] [blame] | 159 | self.stream = None |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 160 | if self.backupCount > 0: |
| 161 | for i in range(self.backupCount - 1, 0, -1): |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 162 | sfn = self.rotation_filename("%s.%d" % (self.baseFilename, i)) |
| 163 | dfn = self.rotation_filename("%s.%d" % (self.baseFilename, |
| 164 | i + 1)) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 165 | if os.path.exists(sfn): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 166 | if os.path.exists(dfn): |
| 167 | os.remove(dfn) |
| 168 | os.rename(sfn, dfn) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 169 | dfn = self.rotation_filename(self.baseFilename + ".1") |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 170 | if os.path.exists(dfn): |
| 171 | os.remove(dfn) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 172 | self.rotate(self.baseFilename, dfn) |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 173 | self.stream = self._open() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 174 | |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 175 | def shouldRollover(self, record): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 176 | """ |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 177 | Determine if rollover should occur. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 178 | |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 179 | Basically, see if the supplied record would cause the file to exceed |
| 180 | the size limit we have. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 181 | """ |
Vinay Sajip | 6268cbc | 2009-01-21 00:19:28 +0000 | [diff] [blame] | 182 | if self.stream is None: # delay was set... |
| 183 | self.stream = self._open() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 184 | if self.maxBytes > 0: # are we rolling over? |
| 185 | msg = "%s\n" % self.format(record) |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 186 | self.stream.seek(0, 2) #due to non-posix-compliant Windows feature |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 187 | if self.stream.tell() + len(msg) >= self.maxBytes: |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 188 | return 1 |
| 189 | return 0 |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 190 | |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 191 | class TimedRotatingFileHandler(BaseRotatingHandler): |
| 192 | """ |
| 193 | Handler for logging to a file, rotating the log file at certain timed |
| 194 | intervals. |
| 195 | |
| 196 | If backupCount is > 0, when rollover is done, no more than backupCount |
| 197 | files are kept - the oldest ones are deleted. |
| 198 | """ |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 199 | def __init__(self, filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False): |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 200 | BaseRotatingHandler.__init__(self, filename, 'a', encoding, delay) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 201 | self.when = when.upper() |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 202 | self.backupCount = backupCount |
Benjamin Peterson | a37cfc6 | 2008-05-26 13:48:34 +0000 | [diff] [blame] | 203 | self.utc = utc |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 204 | # Calculate the real rollover interval, which is just the number of |
| 205 | # seconds between rollovers. Also set the filename suffix used when |
| 206 | # a rollover occurs. Current 'when' events supported: |
| 207 | # S - Seconds |
| 208 | # M - Minutes |
| 209 | # H - Hours |
| 210 | # D - Days |
| 211 | # midnight - roll over at midnight |
| 212 | # W{0-6} - roll over on a certain day; 0 - Monday |
| 213 | # |
| 214 | # Case of the 'when' specifier is not important; lower or upper case |
| 215 | # will work. |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 216 | if self.when == 'S': |
| 217 | self.interval = 1 # one second |
| 218 | self.suffix = "%Y-%m-%d_%H-%M-%S" |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 219 | self.extMatch = r"^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2}(\.\w+)?$" |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 220 | elif self.when == 'M': |
| 221 | self.interval = 60 # one minute |
| 222 | self.suffix = "%Y-%m-%d_%H-%M" |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 223 | self.extMatch = r"^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}(\.\w+)?$" |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 224 | elif self.when == 'H': |
| 225 | self.interval = 60 * 60 # one hour |
| 226 | self.suffix = "%Y-%m-%d_%H" |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 227 | self.extMatch = r"^\d{4}-\d{2}-\d{2}_\d{2}(\.\w+)?$" |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 228 | elif self.when == 'D' or self.when == 'MIDNIGHT': |
| 229 | self.interval = 60 * 60 * 24 # one day |
| 230 | self.suffix = "%Y-%m-%d" |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 231 | self.extMatch = r"^\d{4}-\d{2}-\d{2}(\.\w+)?$" |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 232 | elif self.when.startswith('W'): |
| 233 | self.interval = 60 * 60 * 24 * 7 # one week |
| 234 | if len(self.when) != 2: |
| 235 | raise ValueError("You must specify a day for weekly rollover from 0 to 6 (0 is Monday): %s" % self.when) |
| 236 | if self.when[1] < '0' or self.when[1] > '6': |
| 237 | raise ValueError("Invalid day specified for weekly rollover: %s" % self.when) |
| 238 | self.dayOfWeek = int(self.when[1]) |
| 239 | self.suffix = "%Y-%m-%d" |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 240 | self.extMatch = r"^\d{4}-\d{2}-\d{2}(\.\w+)?$" |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 241 | else: |
| 242 | raise ValueError("Invalid rollover interval specified: %s" % self.when) |
| 243 | |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 244 | self.extMatch = re.compile(self.extMatch, re.ASCII) |
Vinay Sajip | e7d4066 | 2004-10-03 19:12:07 +0000 | [diff] [blame] | 245 | self.interval = self.interval * interval # multiply by units requested |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 246 | if os.path.exists(filename): |
| 247 | t = os.stat(filename)[ST_MTIME] |
| 248 | else: |
| 249 | t = int(time.time()) |
| 250 | self.rolloverAt = self.computeRollover(t) |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 251 | |
Vinay Sajip | affbd87 | 2009-06-11 10:11:47 +0000 | [diff] [blame] | 252 | def computeRollover(self, currentTime): |
| 253 | """ |
| 254 | Work out the rollover time based on the specified time. |
| 255 | """ |
| 256 | result = currentTime + self.interval |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 257 | # If we are rolling over at midnight or weekly, then the interval is already known. |
| 258 | # What we need to figure out is WHEN the next interval is. In other words, |
| 259 | # if you are rolling over at midnight, then your base interval is 1 day, |
| 260 | # but you want to start that one day clock at midnight, not now. So, we |
| 261 | # have to fudge the rolloverAt value in order to trigger the first rollover |
| 262 | # at the right time. After that, the regular interval will take care of |
| 263 | # the rest. Note that this code doesn't care about leap seconds. :) |
| 264 | if self.when == 'MIDNIGHT' or self.when.startswith('W'): |
| 265 | # This could be done with less code, but I wanted it to be clear |
Vinay Sajip | affbd87 | 2009-06-11 10:11:47 +0000 | [diff] [blame] | 266 | if self.utc: |
Benjamin Peterson | a37cfc6 | 2008-05-26 13:48:34 +0000 | [diff] [blame] | 267 | t = time.gmtime(currentTime) |
| 268 | else: |
| 269 | t = time.localtime(currentTime) |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 270 | currentHour = t[3] |
| 271 | currentMinute = t[4] |
| 272 | currentSecond = t[5] |
| 273 | # r is the number of seconds left between now and midnight |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 274 | r = _MIDNIGHT - ((currentHour * 60 + currentMinute) * 60 + |
| 275 | currentSecond) |
Vinay Sajip | affbd87 | 2009-06-11 10:11:47 +0000 | [diff] [blame] | 276 | result = currentTime + r |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 277 | # If we are rolling over on a certain day, add in the number of days until |
| 278 | # the next rollover, but offset by 1 since we just calculated the time |
| 279 | # until the next day starts. There are three cases: |
| 280 | # Case 1) The day to rollover is today; in this case, do nothing |
| 281 | # Case 2) The day to rollover is further in the interval (i.e., today is |
| 282 | # day 2 (Wednesday) and rollover is on day 6 (Sunday). Days to |
| 283 | # next rollover is simply 6 - 2 - 1, or 3. |
| 284 | # Case 3) The day to rollover is behind us in the interval (i.e., today |
| 285 | # is day 5 (Saturday) and rollover is on day 3 (Thursday). |
| 286 | # Days to rollover is 6 - 5 + 3, or 4. In this case, it's the |
| 287 | # number of days left in the current week (1) plus the number |
| 288 | # of days in the next week until the rollover day (3). |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 289 | # The calculations described in 2) and 3) above need to have a day added. |
| 290 | # This is because the above time calculation takes us to midnight on this |
| 291 | # day, i.e. the start of the next day. |
Vinay Sajip | affbd87 | 2009-06-11 10:11:47 +0000 | [diff] [blame] | 292 | if self.when.startswith('W'): |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 293 | day = t[6] # 0 is Monday |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 294 | if day != self.dayOfWeek: |
| 295 | if day < self.dayOfWeek: |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 296 | daysToWait = self.dayOfWeek - day |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 297 | else: |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 298 | daysToWait = 6 - day + self.dayOfWeek + 1 |
Vinay Sajip | affbd87 | 2009-06-11 10:11:47 +0000 | [diff] [blame] | 299 | newRolloverAt = result + (daysToWait * (60 * 60 * 24)) |
| 300 | if not self.utc: |
Benjamin Peterson | a37cfc6 | 2008-05-26 13:48:34 +0000 | [diff] [blame] | 301 | dstNow = t[-1] |
| 302 | dstAtRollover = time.localtime(newRolloverAt)[-1] |
| 303 | if dstNow != dstAtRollover: |
| 304 | if not dstNow: # DST kicks in before next rollover, so we need to deduct an hour |
Vinay Sajip | 27f4897 | 2012-03-13 12:10:33 +0000 | [diff] [blame] | 305 | addend = -3600 |
Benjamin Peterson | a37cfc6 | 2008-05-26 13:48:34 +0000 | [diff] [blame] | 306 | else: # DST bows out before next rollover, so we need to add an hour |
Vinay Sajip | 27f4897 | 2012-03-13 12:10:33 +0000 | [diff] [blame] | 307 | addend = 3600 |
| 308 | newRolloverAt += addend |
Vinay Sajip | affbd87 | 2009-06-11 10:11:47 +0000 | [diff] [blame] | 309 | result = newRolloverAt |
| 310 | return result |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 311 | |
| 312 | def shouldRollover(self, record): |
| 313 | """ |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 314 | Determine if rollover should occur. |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 315 | |
| 316 | record is not used, as we are just comparing times, but it is needed so |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 317 | the method signatures are the same |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 318 | """ |
| 319 | t = int(time.time()) |
| 320 | if t >= self.rolloverAt: |
| 321 | return 1 |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 322 | return 0 |
| 323 | |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 324 | def getFilesToDelete(self): |
| 325 | """ |
| 326 | Determine the files to delete when rolling over. |
| 327 | |
| 328 | More specific than the earlier method, which just used glob.glob(). |
| 329 | """ |
| 330 | dirName, baseName = os.path.split(self.baseFilename) |
| 331 | fileNames = os.listdir(dirName) |
| 332 | result = [] |
| 333 | prefix = baseName + "." |
| 334 | plen = len(prefix) |
| 335 | for fileName in fileNames: |
| 336 | if fileName[:plen] == prefix: |
| 337 | suffix = fileName[plen:] |
| 338 | if self.extMatch.match(suffix): |
Benjamin Peterson | a37cfc6 | 2008-05-26 13:48:34 +0000 | [diff] [blame] | 339 | result.append(os.path.join(dirName, fileName)) |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 340 | result.sort() |
| 341 | if len(result) < self.backupCount: |
| 342 | result = [] |
| 343 | else: |
| 344 | result = result[:len(result) - self.backupCount] |
| 345 | return result |
| 346 | |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 347 | def doRollover(self): |
| 348 | """ |
| 349 | do a rollover; in this case, a date/time stamp is appended to the filename |
| 350 | when the rollover happens. However, you want the file to be named for the |
| 351 | start of the interval, not the current time. If there is a backup count, |
| 352 | then we have to get a list of matching filenames, sort them and remove |
| 353 | the one with the oldest suffix. |
| 354 | """ |
Vinay Sajip | 6268cbc | 2009-01-21 00:19:28 +0000 | [diff] [blame] | 355 | if self.stream: |
| 356 | self.stream.close() |
Vinay Sajip | 01241d6 | 2011-01-21 23:35:57 +0000 | [diff] [blame] | 357 | self.stream = None |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 358 | # get the time that this sequence started at and make it a TimeTuple |
Vinay Sajip | 27f4897 | 2012-03-13 12:10:33 +0000 | [diff] [blame] | 359 | currentTime = int(time.time()) |
| 360 | dstNow = time.localtime(currentTime)[-1] |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 361 | t = self.rolloverAt - self.interval |
Benjamin Peterson | a37cfc6 | 2008-05-26 13:48:34 +0000 | [diff] [blame] | 362 | if self.utc: |
| 363 | timeTuple = time.gmtime(t) |
| 364 | else: |
| 365 | timeTuple = time.localtime(t) |
Vinay Sajip | 27f4897 | 2012-03-13 12:10:33 +0000 | [diff] [blame] | 366 | dstThen = timeTuple[-1] |
| 367 | if dstNow != dstThen: |
| 368 | if dstNow: |
| 369 | addend = 3600 |
| 370 | else: |
| 371 | addend = -3600 |
| 372 | timeTuple = time.localtime(t + addend) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 373 | dfn = self.rotation_filename(self.baseFilename + "." + |
| 374 | time.strftime(self.suffix, timeTuple)) |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 375 | if os.path.exists(dfn): |
| 376 | os.remove(dfn) |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 377 | self.rotate(self.baseFilename, dfn) |
Vinay Sajip | 17c52d8 | 2004-07-03 11:48:34 +0000 | [diff] [blame] | 378 | if self.backupCount > 0: |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 379 | for s in self.getFilesToDelete(): |
| 380 | os.remove(s) |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 381 | self.stream = self._open() |
Vinay Sajip | affbd87 | 2009-06-11 10:11:47 +0000 | [diff] [blame] | 382 | newRolloverAt = self.computeRollover(currentTime) |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 383 | while newRolloverAt <= currentTime: |
| 384 | newRolloverAt = newRolloverAt + self.interval |
| 385 | #If DST changes and midnight or weekly rollover, adjust for this. |
Benjamin Peterson | a37cfc6 | 2008-05-26 13:48:34 +0000 | [diff] [blame] | 386 | if (self.when == 'MIDNIGHT' or self.when.startswith('W')) and not self.utc: |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 387 | dstAtRollover = time.localtime(newRolloverAt)[-1] |
| 388 | if dstNow != dstAtRollover: |
| 389 | if not dstNow: # DST kicks in before next rollover, so we need to deduct an hour |
Vinay Sajip | 27f4897 | 2012-03-13 12:10:33 +0000 | [diff] [blame] | 390 | addend = -3600 |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 391 | else: # DST bows out before next rollover, so we need to add an hour |
Vinay Sajip | 27f4897 | 2012-03-13 12:10:33 +0000 | [diff] [blame] | 392 | addend = 3600 |
| 393 | newRolloverAt += addend |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 394 | self.rolloverAt = newRolloverAt |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 395 | |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 396 | class WatchedFileHandler(logging.FileHandler): |
| 397 | """ |
| 398 | A handler for logging to a file, which watches the file |
| 399 | to see if it has changed while in use. This can happen because of |
| 400 | usage of programs such as newsyslog and logrotate which perform |
| 401 | log file rotation. This handler, intended for use under Unix, |
| 402 | watches the file to see if it has changed since the last emit. |
| 403 | (A file has changed if its device or inode have changed.) |
| 404 | If it has changed, the old file stream is closed, and the file |
| 405 | opened to get a new stream. |
| 406 | |
| 407 | This handler is not appropriate for use under Windows, because |
| 408 | under Windows open files cannot be moved or renamed - logging |
| 409 | opens the files with exclusive locks - and so there is no need |
| 410 | for such a handler. Furthermore, ST_INO is not supported under |
| 411 | Windows; stat always returns zero for this value. |
| 412 | |
| 413 | This handler is based on a suggestion and patch by Chad J. |
| 414 | Schroeder. |
| 415 | """ |
Vinay Sajip | 23b94d0 | 2012-01-04 12:02:26 +0000 | [diff] [blame] | 416 | def __init__(self, filename, mode='a', encoding=None, delay=False): |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 417 | logging.FileHandler.__init__(self, filename, mode, encoding, delay) |
Vinay Sajip | 66b8b08 | 2012-04-24 23:25:30 +0100 | [diff] [blame] | 418 | self.dev, self.ino = -1, -1 |
| 419 | self._statstream() |
| 420 | |
| 421 | def _statstream(self): |
| 422 | if self.stream: |
| 423 | sres = os.fstat(self.stream.fileno()) |
| 424 | self.dev, self.ino = sres[ST_DEV], sres[ST_INO] |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 425 | |
| 426 | def emit(self, record): |
| 427 | """ |
| 428 | Emit a record. |
| 429 | |
| 430 | First check if the underlying file has changed, and if it |
| 431 | has, close the old stream and reopen the file to get the |
| 432 | current stream. |
| 433 | """ |
Vinay Sajip | 66b8b08 | 2012-04-24 23:25:30 +0100 | [diff] [blame] | 434 | # Reduce the chance of race conditions by stat'ing by path only |
| 435 | # once and then fstat'ing our new fd if we opened a new log stream. |
| 436 | # See issue #14632: Thanks to John Mulligan for the problem report |
| 437 | # and patch. |
| 438 | try: |
| 439 | # stat the file by path, checking for existence |
| 440 | sres = os.stat(self.baseFilename) |
Giampaolo Rodola' | 0166a28 | 2013-02-12 15:14:17 +0100 | [diff] [blame] | 441 | except FileNotFoundError: |
| 442 | sres = None |
Vinay Sajip | 66b8b08 | 2012-04-24 23:25:30 +0100 | [diff] [blame] | 443 | # compare file system stat with that of our stream file handle |
| 444 | if not sres or sres[ST_DEV] != self.dev or sres[ST_INO] != self.ino: |
| 445 | if self.stream is not None: |
| 446 | # we have an open file handle, clean it up |
| 447 | self.stream.flush() |
| 448 | self.stream.close() |
| 449 | # open a new file handle and get new stat info from that fd |
| 450 | self.stream = self._open() |
| 451 | self._statstream() |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 452 | logging.FileHandler.emit(self, record) |
| 453 | |
Vinay Sajip | 66b8b08 | 2012-04-24 23:25:30 +0100 | [diff] [blame] | 454 | |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 455 | class SocketHandler(logging.Handler): |
| 456 | """ |
| 457 | A handler class which writes logging records, in pickle format, to |
| 458 | a streaming socket. The socket is kept open across logging calls. |
| 459 | If the peer resets it, an attempt is made to reconnect on the next call. |
Raymond Hettinger | 6f3eaa6 | 2003-06-27 21:43:39 +0000 | [diff] [blame] | 460 | The pickle which is sent is that of the LogRecord's attribute dictionary |
| 461 | (__dict__), so that the receiver does not need to have the logging module |
| 462 | installed in order to process the logging event. |
| 463 | |
| 464 | To unpickle the record at the receiving end into a LogRecord, use the |
| 465 | makeLogRecord function. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 466 | """ |
| 467 | |
| 468 | def __init__(self, host, port): |
| 469 | """ |
| 470 | Initializes the handler with a specific host address and port. |
| 471 | |
Vinay Sajip | de19e08 | 2011-04-30 21:52:26 +0100 | [diff] [blame] | 472 | When the attribute *closeOnError* is set to True - if a socket error |
| 473 | occurs, the socket is silently closed and then reopened on the next |
| 474 | logging call. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 475 | """ |
| 476 | logging.Handler.__init__(self) |
| 477 | self.host = host |
| 478 | self.port = port |
| 479 | self.sock = None |
Vinay Sajip | de19e08 | 2011-04-30 21:52:26 +0100 | [diff] [blame] | 480 | self.closeOnError = False |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 481 | self.retryTime = None |
| 482 | # |
| 483 | # Exponential backoff parameters. |
| 484 | # |
| 485 | self.retryStart = 1.0 |
| 486 | self.retryMax = 30.0 |
| 487 | self.retryFactor = 2.0 |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 488 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 489 | def makeSocket(self, timeout=1): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 490 | """ |
| 491 | A factory method which allows subclasses to define the precise |
| 492 | type of socket they want. |
| 493 | """ |
Giampaolo Rodola' | 35eeb30 | 2012-10-15 16:57:37 +0200 | [diff] [blame] | 494 | return socket.create_connection((self.host, self.port), timeout=timeout) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 495 | |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 496 | def createSocket(self): |
| 497 | """ |
| 498 | Try to create a socket, using an exponential backoff with |
| 499 | a max retry time. Thanks to Robert Olson for the original patch |
| 500 | (SF #815911) which has been slightly refactored. |
| 501 | """ |
| 502 | now = time.time() |
| 503 | # Either retryTime is None, in which case this |
| 504 | # is the first time back after a disconnect, or |
| 505 | # we've waited long enough. |
| 506 | if self.retryTime is None: |
Vinay Sajip | de19e08 | 2011-04-30 21:52:26 +0100 | [diff] [blame] | 507 | attempt = True |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 508 | else: |
Tim Peters | 4e0e1b6 | 2004-07-07 20:54:48 +0000 | [diff] [blame] | 509 | attempt = (now >= self.retryTime) |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 510 | if attempt: |
| 511 | try: |
| 512 | self.sock = self.makeSocket() |
| 513 | self.retryTime = None # next time, no delay before trying |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 514 | except OSError: |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 515 | #Creation failed, so set the retry time and return. |
| 516 | if self.retryTime is None: |
| 517 | self.retryPeriod = self.retryStart |
| 518 | else: |
| 519 | self.retryPeriod = self.retryPeriod * self.retryFactor |
| 520 | if self.retryPeriod > self.retryMax: |
| 521 | self.retryPeriod = self.retryMax |
| 522 | self.retryTime = now + self.retryPeriod |
| 523 | |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 524 | def send(self, s): |
| 525 | """ |
| 526 | Send a pickled string to the socket. |
| 527 | |
| 528 | This function allows for partial sends which can happen when the |
| 529 | network is busy. |
| 530 | """ |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 531 | if self.sock is None: |
| 532 | self.createSocket() |
| 533 | #self.sock can be None either because we haven't reached the retry |
| 534 | #time yet, or because we have reached the retry time and retried, |
| 535 | #but are still unable to connect. |
| 536 | if self.sock: |
| 537 | try: |
Giampaolo Rodola' | f9de90a | 2012-10-26 18:32:24 +0200 | [diff] [blame] | 538 | self.sock.sendall(s) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 539 | except OSError: #pragma: no cover |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 540 | self.sock.close() |
| 541 | self.sock = None # so we can call createSocket next time |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 542 | |
| 543 | def makePickle(self, record): |
| 544 | """ |
| 545 | Pickles the record in binary format with a length prefix, and |
| 546 | returns it ready for transmission across the socket. |
| 547 | """ |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 548 | ei = record.exc_info |
| 549 | if ei: |
Vinay Sajip | 6f5e54e | 2012-03-29 20:17:18 +0100 | [diff] [blame] | 550 | # just to get traceback text into record.exc_text ... |
| 551 | dummy = self.format(record) |
| 552 | # See issue #14436: If msg or args are objects, they may not be |
| 553 | # available on the receiving end. So we convert the msg % args |
| 554 | # to a string, save it as msg and zap the args. |
| 555 | d = dict(record.__dict__) |
| 556 | d['msg'] = record.getMessage() |
| 557 | d['args'] = None |
| 558 | d['exc_info'] = None |
| 559 | s = pickle.dumps(d, 1) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 560 | slen = struct.pack(">L", len(s)) |
| 561 | return slen + s |
| 562 | |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 563 | def handleError(self, record): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 564 | """ |
| 565 | Handle an error during logging. |
| 566 | |
| 567 | An error has occurred during logging. Most likely cause - |
| 568 | connection lost. Close the socket so that we can retry on the |
| 569 | next event. |
| 570 | """ |
| 571 | if self.closeOnError and self.sock: |
| 572 | self.sock.close() |
| 573 | self.sock = None #try to reconnect next time |
| 574 | else: |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 575 | logging.Handler.handleError(self, record) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 576 | |
| 577 | def emit(self, record): |
| 578 | """ |
| 579 | Emit a record. |
| 580 | |
| 581 | Pickles the record and writes it to the socket in binary format. |
| 582 | If there is an error with the socket, silently drop the packet. |
| 583 | If there was a problem with the socket, re-establishes the |
| 584 | socket. |
| 585 | """ |
| 586 | try: |
| 587 | s = self.makePickle(record) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 588 | self.send(s) |
Vinay Sajip | 8cf4eb1 | 2012-10-09 08:06:13 +0100 | [diff] [blame] | 589 | except Exception: |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 590 | self.handleError(record) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 591 | |
| 592 | def close(self): |
| 593 | """ |
| 594 | Closes the socket. |
| 595 | """ |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 596 | self.acquire() |
| 597 | try: |
Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 598 | if self.sock: |
| 599 | self.sock.close() |
| 600 | self.sock = None |
| 601 | logging.Handler.close(self) |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 602 | finally: |
| 603 | self.release() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 604 | |
| 605 | class DatagramHandler(SocketHandler): |
| 606 | """ |
| 607 | A handler class which writes logging records, in pickle format, to |
Raymond Hettinger | 6f3eaa6 | 2003-06-27 21:43:39 +0000 | [diff] [blame] | 608 | a datagram socket. The pickle which is sent is that of the LogRecord's |
| 609 | attribute dictionary (__dict__), so that the receiver does not need to |
| 610 | have the logging module installed in order to process the logging event. |
| 611 | |
| 612 | To unpickle the record at the receiving end into a LogRecord, use the |
| 613 | makeLogRecord function. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 614 | |
| 615 | """ |
| 616 | def __init__(self, host, port): |
| 617 | """ |
| 618 | Initializes the handler with a specific host address and port. |
| 619 | """ |
| 620 | SocketHandler.__init__(self, host, port) |
Vinay Sajip | de19e08 | 2011-04-30 21:52:26 +0100 | [diff] [blame] | 621 | self.closeOnError = False |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 622 | |
| 623 | def makeSocket(self): |
| 624 | """ |
| 625 | The factory method of SocketHandler is here overridden to create |
| 626 | a UDP socket (SOCK_DGRAM). |
| 627 | """ |
| 628 | s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) |
| 629 | return s |
| 630 | |
| 631 | def send(self, s): |
| 632 | """ |
| 633 | Send a pickled string to a socket. |
| 634 | |
| 635 | This function no longer allows for partial sends which can happen |
| 636 | when the network is busy - UDP does not guarantee delivery and |
| 637 | can deliver packets out of sequence. |
| 638 | """ |
Vinay Sajip | fb15417 | 2004-08-24 09:36:23 +0000 | [diff] [blame] | 639 | if self.sock is None: |
| 640 | self.createSocket() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 641 | self.sock.sendto(s, (self.host, self.port)) |
| 642 | |
| 643 | class SysLogHandler(logging.Handler): |
| 644 | """ |
| 645 | A handler class which sends formatted logging records to a syslog |
| 646 | server. Based on Sam Rushing's syslog module: |
| 647 | http://www.nightmare.com/squirl/python-ext/misc/syslog.py |
| 648 | Contributed by Nicolas Untz (after which minor refactoring changes |
| 649 | have been made). |
| 650 | """ |
| 651 | |
| 652 | # from <linux/sys/syslog.h>: |
| 653 | # ====================================================================== |
| 654 | # priorities/facilities are encoded into a single 32-bit quantity, where |
| 655 | # the bottom 3 bits are the priority (0-7) and the top 28 bits are the |
| 656 | # facility (0-big number). Both the priorities and the facilities map |
| 657 | # roughly one-to-one to strings in the syslogd(8) source code. This |
| 658 | # mapping is included in this file. |
| 659 | # |
| 660 | # priorities (these are ordered) |
| 661 | |
| 662 | LOG_EMERG = 0 # system is unusable |
| 663 | LOG_ALERT = 1 # action must be taken immediately |
| 664 | LOG_CRIT = 2 # critical conditions |
| 665 | LOG_ERR = 3 # error conditions |
| 666 | LOG_WARNING = 4 # warning conditions |
| 667 | LOG_NOTICE = 5 # normal but significant condition |
| 668 | LOG_INFO = 6 # informational |
| 669 | LOG_DEBUG = 7 # debug-level messages |
| 670 | |
| 671 | # facility codes |
| 672 | LOG_KERN = 0 # kernel messages |
| 673 | LOG_USER = 1 # random user-level messages |
| 674 | LOG_MAIL = 2 # mail system |
| 675 | LOG_DAEMON = 3 # system daemons |
| 676 | LOG_AUTH = 4 # security/authorization messages |
| 677 | LOG_SYSLOG = 5 # messages generated internally by syslogd |
| 678 | LOG_LPR = 6 # line printer subsystem |
| 679 | LOG_NEWS = 7 # network news subsystem |
| 680 | LOG_UUCP = 8 # UUCP subsystem |
| 681 | LOG_CRON = 9 # clock daemon |
Benjamin Peterson | 22005fc | 2010-04-11 16:25:06 +0000 | [diff] [blame] | 682 | LOG_AUTHPRIV = 10 # security/authorization messages (private) |
| 683 | LOG_FTP = 11 # FTP daemon |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 684 | |
| 685 | # other codes through 15 reserved for system use |
| 686 | LOG_LOCAL0 = 16 # reserved for local use |
| 687 | LOG_LOCAL1 = 17 # reserved for local use |
| 688 | LOG_LOCAL2 = 18 # reserved for local use |
| 689 | LOG_LOCAL3 = 19 # reserved for local use |
| 690 | LOG_LOCAL4 = 20 # reserved for local use |
| 691 | LOG_LOCAL5 = 21 # reserved for local use |
| 692 | LOG_LOCAL6 = 22 # reserved for local use |
| 693 | LOG_LOCAL7 = 23 # reserved for local use |
| 694 | |
| 695 | priority_names = { |
| 696 | "alert": LOG_ALERT, |
| 697 | "crit": LOG_CRIT, |
| 698 | "critical": LOG_CRIT, |
| 699 | "debug": LOG_DEBUG, |
| 700 | "emerg": LOG_EMERG, |
| 701 | "err": LOG_ERR, |
| 702 | "error": LOG_ERR, # DEPRECATED |
| 703 | "info": LOG_INFO, |
| 704 | "notice": LOG_NOTICE, |
| 705 | "panic": LOG_EMERG, # DEPRECATED |
| 706 | "warn": LOG_WARNING, # DEPRECATED |
| 707 | "warning": LOG_WARNING, |
| 708 | } |
| 709 | |
| 710 | facility_names = { |
| 711 | "auth": LOG_AUTH, |
| 712 | "authpriv": LOG_AUTHPRIV, |
| 713 | "cron": LOG_CRON, |
| 714 | "daemon": LOG_DAEMON, |
Benjamin Peterson | 22005fc | 2010-04-11 16:25:06 +0000 | [diff] [blame] | 715 | "ftp": LOG_FTP, |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 716 | "kern": LOG_KERN, |
| 717 | "lpr": LOG_LPR, |
| 718 | "mail": LOG_MAIL, |
| 719 | "news": LOG_NEWS, |
| 720 | "security": LOG_AUTH, # DEPRECATED |
| 721 | "syslog": LOG_SYSLOG, |
| 722 | "user": LOG_USER, |
| 723 | "uucp": LOG_UUCP, |
| 724 | "local0": LOG_LOCAL0, |
| 725 | "local1": LOG_LOCAL1, |
| 726 | "local2": LOG_LOCAL2, |
| 727 | "local3": LOG_LOCAL3, |
| 728 | "local4": LOG_LOCAL4, |
| 729 | "local5": LOG_LOCAL5, |
| 730 | "local6": LOG_LOCAL6, |
| 731 | "local7": LOG_LOCAL7, |
| 732 | } |
| 733 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 734 | #The map below appears to be trivially lowercasing the key. However, |
| 735 | #there's more to it than meets the eye - in some locales, lowercasing |
| 736 | #gives unexpected results. See SF #1524081: in the Turkish locale, |
| 737 | #"INFO".lower() != "info" |
| 738 | priority_map = { |
| 739 | "DEBUG" : "debug", |
| 740 | "INFO" : "info", |
| 741 | "WARNING" : "warning", |
| 742 | "ERROR" : "error", |
| 743 | "CRITICAL" : "critical" |
| 744 | } |
| 745 | |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 746 | def __init__(self, address=('localhost', SYSLOG_UDP_PORT), |
| 747 | facility=LOG_USER, socktype=socket.SOCK_DGRAM): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 748 | """ |
| 749 | Initialize a handler. |
| 750 | |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 751 | If address is specified as a string, a UNIX socket is used. To log to a |
| 752 | local syslogd, "SysLogHandler(address="/dev/log")" can be used. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 753 | If facility is not specified, LOG_USER is used. |
| 754 | """ |
| 755 | logging.Handler.__init__(self) |
| 756 | |
| 757 | self.address = address |
| 758 | self.facility = facility |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 759 | self.socktype = socktype |
| 760 | |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 761 | if isinstance(address, str): |
Vinay Sajip | 5a35b06 | 2011-04-27 11:31:14 +0100 | [diff] [blame] | 762 | self.unixsocket = True |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 763 | self._connect_unixsocket(address) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 764 | else: |
Vinay Sajip | 5a35b06 | 2011-04-27 11:31:14 +0100 | [diff] [blame] | 765 | self.unixsocket = False |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 766 | self.socket = socket.socket(socket.AF_INET, socktype) |
| 767 | if socktype == socket.SOCK_STREAM: |
| 768 | self.socket.connect(address) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 769 | self.formatter = None |
| 770 | |
Vinay Sajip | a1974c1 | 2005-01-13 08:23:56 +0000 | [diff] [blame] | 771 | def _connect_unixsocket(self, address): |
Vinay Sajip | b5ca932 | 2012-10-09 08:19:25 +0100 | [diff] [blame] | 772 | self.socket = socket.socket(socket.AF_UNIX, self.socktype) |
Vinay Sajip | a1974c1 | 2005-01-13 08:23:56 +0000 | [diff] [blame] | 773 | try: |
| 774 | self.socket.connect(address) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 775 | except OSError: |
Vinay Sajip | a1974c1 | 2005-01-13 08:23:56 +0000 | [diff] [blame] | 776 | self.socket.close() |
Vinay Sajip | b5ca932 | 2012-10-09 08:19:25 +0100 | [diff] [blame] | 777 | raise |
Vinay Sajip | a1974c1 | 2005-01-13 08:23:56 +0000 | [diff] [blame] | 778 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 779 | def encodePriority(self, facility, priority): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 780 | """ |
| 781 | Encode the facility and priority. You can pass in strings or |
| 782 | integers - if strings are passed, the facility_names and |
| 783 | priority_names mapping dictionaries are used to convert them to |
| 784 | integers. |
| 785 | """ |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 786 | if isinstance(facility, str): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 787 | facility = self.facility_names[facility] |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 788 | if isinstance(priority, str): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 789 | priority = self.priority_names[priority] |
| 790 | return (facility << 3) | priority |
| 791 | |
| 792 | def close (self): |
| 793 | """ |
| 794 | Closes the socket. |
| 795 | """ |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 796 | self.acquire() |
| 797 | try: |
Vinay Sajip | 57c2237 | 2012-02-23 20:03:49 +0000 | [diff] [blame] | 798 | self.socket.close() |
Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 799 | logging.Handler.close(self) |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 800 | finally: |
| 801 | self.release() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 802 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 803 | def mapPriority(self, levelName): |
| 804 | """ |
| 805 | Map a logging level name to a key in the priority_names map. |
| 806 | This is useful in two scenarios: when custom levels are being |
| 807 | used, and in the case where you can't do a straightforward |
| 808 | mapping by lowercasing the logging level name because of locale- |
| 809 | specific issues (see SF #1524081). |
| 810 | """ |
| 811 | return self.priority_map.get(levelName, "warning") |
| 812 | |
Vinay Sajip | 2353e35 | 2011-06-27 15:40:06 +0100 | [diff] [blame] | 813 | ident = '' # prepended to all messages |
Vinay Sajip | 8168d10 | 2011-06-09 16:50:49 +0100 | [diff] [blame] | 814 | append_nul = True # some old syslog daemons expect a NUL terminator |
| 815 | |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 816 | def emit(self, record): |
| 817 | """ |
| 818 | Emit a record. |
| 819 | |
| 820 | The record is formatted, and then sent to the syslog server. If |
| 821 | exception information is present, it is NOT sent to the server. |
| 822 | """ |
Vinay Sajip | 8168d10 | 2011-06-09 16:50:49 +0100 | [diff] [blame] | 823 | msg = self.format(record) |
Vinay Sajip | 2353e35 | 2011-06-27 15:40:06 +0100 | [diff] [blame] | 824 | if self.ident: |
| 825 | msg = self.ident + msg |
Vinay Sajip | 8168d10 | 2011-06-09 16:50:49 +0100 | [diff] [blame] | 826 | if self.append_nul: |
| 827 | msg += '\000' |
Victor Stinner | 765531d | 2013-03-26 01:11:54 +0100 | [diff] [blame] | 828 | |
| 829 | # We need to convert record level to lowercase, maybe this will |
| 830 | # change in the future. |
Vinay Sajip | 467d12f | 2010-08-19 22:20:22 +0000 | [diff] [blame] | 831 | prio = '<%d>' % self.encodePriority(self.facility, |
| 832 | self.mapPriority(record.levelname)) |
| 833 | prio = prio.encode('utf-8') |
Vinay Sajip | 609364a | 2010-08-30 18:31:13 +0000 | [diff] [blame] | 834 | # Message is a string. Convert to bytes as required by RFC 5424 |
Vinay Sajip | 42ead48 | 2009-10-21 20:22:14 +0000 | [diff] [blame] | 835 | msg = msg.encode('utf-8') |
Vinay Sajip | 467d12f | 2010-08-19 22:20:22 +0000 | [diff] [blame] | 836 | msg = prio + msg |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 837 | try: |
| 838 | if self.unixsocket: |
Vinay Sajip | a1974c1 | 2005-01-13 08:23:56 +0000 | [diff] [blame] | 839 | try: |
| 840 | self.socket.send(msg) |
Andrew Svetlov | 0832af6 | 2012-12-18 23:10:48 +0200 | [diff] [blame] | 841 | except OSError: |
Vinay Sajip | a1974c1 | 2005-01-13 08:23:56 +0000 | [diff] [blame] | 842 | self._connect_unixsocket(self.address) |
| 843 | self.socket.send(msg) |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 844 | elif self.socktype == socket.SOCK_DGRAM: |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 845 | self.socket.sendto(msg, self.address) |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 846 | else: |
| 847 | self.socket.sendall(msg) |
Vinay Sajip | 8cf4eb1 | 2012-10-09 08:06:13 +0100 | [diff] [blame] | 848 | except Exception: |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 849 | self.handleError(record) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 850 | |
| 851 | class SMTPHandler(logging.Handler): |
| 852 | """ |
| 853 | A handler class which sends an SMTP email for each logging event. |
| 854 | """ |
Vinay Sajip | 540f215 | 2009-12-06 17:57:11 +0000 | [diff] [blame] | 855 | def __init__(self, mailhost, fromaddr, toaddrs, subject, |
Vinay Sajip | 26308da | 2012-04-22 18:16:14 +0100 | [diff] [blame] | 856 | credentials=None, secure=None, timeout=5.0): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 857 | """ |
| 858 | Initialize the handler. |
| 859 | |
| 860 | Initialize the instance with the from and to addresses and subject |
| 861 | line of the email. To specify a non-standard SMTP port, use the |
Guido van Rossum | 360e4b8 | 2007-05-14 22:51:27 +0000 | [diff] [blame] | 862 | (host, port) tuple format for the mailhost argument. To specify |
| 863 | authentication credentials, supply a (username, password) tuple |
Vinay Sajip | 25fcd22 | 2009-12-06 18:05:04 +0000 | [diff] [blame] | 864 | for the credentials argument. To specify the use of a secure |
| 865 | protocol (TLS), pass in a tuple for the secure argument. This will |
| 866 | only be used when authentication credentials are supplied. The tuple |
| 867 | will be either an empty tuple, or a single-value tuple with the name |
| 868 | of a keyfile, or a 2-value tuple with the names of the keyfile and |
| 869 | certificate file. (This tuple is passed to the `starttls` method). |
Vinay Sajip | 17160fd | 2012-03-15 12:02:08 +0000 | [diff] [blame] | 870 | A timeout in seconds can be specified for the SMTP connection (the |
| 871 | default is one second). |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 872 | """ |
| 873 | logging.Handler.__init__(self) |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 874 | if isinstance(mailhost, tuple): |
Guido van Rossum | 360e4b8 | 2007-05-14 22:51:27 +0000 | [diff] [blame] | 875 | self.mailhost, self.mailport = mailhost |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 876 | else: |
Guido van Rossum | 360e4b8 | 2007-05-14 22:51:27 +0000 | [diff] [blame] | 877 | self.mailhost, self.mailport = mailhost, None |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 878 | if isinstance(credentials, tuple): |
Guido van Rossum | 360e4b8 | 2007-05-14 22:51:27 +0000 | [diff] [blame] | 879 | self.username, self.password = credentials |
| 880 | else: |
| 881 | self.username = None |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 882 | self.fromaddr = fromaddr |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 883 | if isinstance(toaddrs, str): |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 884 | toaddrs = [toaddrs] |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 885 | self.toaddrs = toaddrs |
| 886 | self.subject = subject |
Vinay Sajip | 540f215 | 2009-12-06 17:57:11 +0000 | [diff] [blame] | 887 | self.secure = secure |
Vinay Sajip | 17160fd | 2012-03-15 12:02:08 +0000 | [diff] [blame] | 888 | self.timeout = timeout |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 889 | |
| 890 | def getSubject(self, record): |
| 891 | """ |
| 892 | Determine the subject for the email. |
| 893 | |
| 894 | If you want to specify a subject line which is record-dependent, |
| 895 | override this method. |
| 896 | """ |
| 897 | return self.subject |
| 898 | |
| 899 | def emit(self, record): |
| 900 | """ |
| 901 | Emit a record. |
| 902 | |
| 903 | Format the record and send it to the specified addressees. |
| 904 | """ |
| 905 | try: |
| 906 | import smtplib |
Vinay Sajip | db81c4c | 2010-02-25 23:13:06 +0000 | [diff] [blame] | 907 | from email.utils import formatdate |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 908 | port = self.mailport |
| 909 | if not port: |
| 910 | port = smtplib.SMTP_PORT |
Vinay Sajip | 17160fd | 2012-03-15 12:02:08 +0000 | [diff] [blame] | 911 | smtp = smtplib.SMTP(self.mailhost, port, timeout=self.timeout) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 912 | msg = self.format(record) |
Neal Norwitz | f297bd1 | 2003-04-23 03:49:43 +0000 | [diff] [blame] | 913 | msg = "From: %s\r\nTo: %s\r\nSubject: %s\r\nDate: %s\r\n\r\n%s" % ( |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 914 | self.fromaddr, |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 915 | ",".join(self.toaddrs), |
Neal Norwitz | f297bd1 | 2003-04-23 03:49:43 +0000 | [diff] [blame] | 916 | self.getSubject(record), |
Martin v. Löwis | 318a12e | 2004-08-18 12:27:40 +0000 | [diff] [blame] | 917 | formatdate(), msg) |
Guido van Rossum | 360e4b8 | 2007-05-14 22:51:27 +0000 | [diff] [blame] | 918 | if self.username: |
Vinay Sajip | 25fcd22 | 2009-12-06 18:05:04 +0000 | [diff] [blame] | 919 | if self.secure is not None: |
Vinay Sajip | 540f215 | 2009-12-06 17:57:11 +0000 | [diff] [blame] | 920 | smtp.ehlo() |
Vinay Sajip | 25fcd22 | 2009-12-06 18:05:04 +0000 | [diff] [blame] | 921 | smtp.starttls(*self.secure) |
Vinay Sajip | 540f215 | 2009-12-06 17:57:11 +0000 | [diff] [blame] | 922 | smtp.ehlo() |
Guido van Rossum | 360e4b8 | 2007-05-14 22:51:27 +0000 | [diff] [blame] | 923 | smtp.login(self.username, self.password) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 924 | smtp.sendmail(self.fromaddr, self.toaddrs, msg) |
| 925 | smtp.quit() |
Vinay Sajip | 8cf4eb1 | 2012-10-09 08:06:13 +0100 | [diff] [blame] | 926 | except Exception: |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 927 | self.handleError(record) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 928 | |
| 929 | class NTEventLogHandler(logging.Handler): |
| 930 | """ |
| 931 | A handler class which sends events to the NT Event Log. Adds a |
| 932 | registry entry for the specified application name. If no dllname is |
| 933 | provided, win32service.pyd (which contains some basic message |
| 934 | placeholders) is used. Note that use of these placeholders will make |
| 935 | your event logs big, as the entire message source is held in the log. |
| 936 | If you want slimmer logs, you have to pass in the name of your own DLL |
| 937 | which contains the message definitions you want to use in the event log. |
| 938 | """ |
| 939 | def __init__(self, appname, dllname=None, logtype="Application"): |
| 940 | logging.Handler.__init__(self) |
| 941 | try: |
| 942 | import win32evtlogutil, win32evtlog |
| 943 | self.appname = appname |
| 944 | self._welu = win32evtlogutil |
| 945 | if not dllname: |
| 946 | dllname = os.path.split(self._welu.__file__) |
| 947 | dllname = os.path.split(dllname[0]) |
| 948 | dllname = os.path.join(dllname[0], r'win32service.pyd') |
| 949 | self.dllname = dllname |
| 950 | self.logtype = logtype |
| 951 | self._welu.AddSourceToRegistry(appname, dllname, logtype) |
| 952 | self.deftype = win32evtlog.EVENTLOG_ERROR_TYPE |
| 953 | self.typemap = { |
| 954 | logging.DEBUG : win32evtlog.EVENTLOG_INFORMATION_TYPE, |
| 955 | logging.INFO : win32evtlog.EVENTLOG_INFORMATION_TYPE, |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 956 | logging.WARNING : win32evtlog.EVENTLOG_WARNING_TYPE, |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 957 | logging.ERROR : win32evtlog.EVENTLOG_ERROR_TYPE, |
| 958 | logging.CRITICAL: win32evtlog.EVENTLOG_ERROR_TYPE, |
| 959 | } |
| 960 | except ImportError: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 961 | print("The Python Win32 extensions for NT (service, event "\ |
| 962 | "logging) appear not to be available.") |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 963 | self._welu = None |
| 964 | |
| 965 | def getMessageID(self, record): |
| 966 | """ |
| 967 | Return the message ID for the event record. If you are using your |
| 968 | own messages, you could do this by having the msg passed to the |
| 969 | logger being an ID rather than a formatting string. Then, in here, |
| 970 | you could use a dictionary lookup to get the message ID. This |
| 971 | version returns 1, which is the base message ID in win32service.pyd. |
| 972 | """ |
| 973 | return 1 |
| 974 | |
| 975 | def getEventCategory(self, record): |
| 976 | """ |
| 977 | Return the event category for the record. |
| 978 | |
| 979 | Override this if you want to specify your own categories. This version |
| 980 | returns 0. |
| 981 | """ |
| 982 | return 0 |
| 983 | |
| 984 | def getEventType(self, record): |
| 985 | """ |
| 986 | Return the event type for the record. |
| 987 | |
| 988 | Override this if you want to specify your own types. This version does |
| 989 | a mapping using the handler's typemap attribute, which is set up in |
| 990 | __init__() to a dictionary which contains mappings for DEBUG, INFO, |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 991 | WARNING, ERROR and CRITICAL. If you are using your own levels you will |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 992 | either need to override this method or place a suitable dictionary in |
| 993 | the handler's typemap attribute. |
| 994 | """ |
| 995 | return self.typemap.get(record.levelno, self.deftype) |
| 996 | |
| 997 | def emit(self, record): |
| 998 | """ |
| 999 | Emit a record. |
| 1000 | |
| 1001 | Determine the message ID, event category and event type. Then |
| 1002 | log the message in the NT event log. |
| 1003 | """ |
| 1004 | if self._welu: |
| 1005 | try: |
| 1006 | id = self.getMessageID(record) |
| 1007 | cat = self.getEventCategory(record) |
| 1008 | type = self.getEventType(record) |
| 1009 | msg = self.format(record) |
| 1010 | self._welu.ReportEvent(self.appname, id, cat, type, [msg]) |
Vinay Sajip | 8cf4eb1 | 2012-10-09 08:06:13 +0100 | [diff] [blame] | 1011 | except Exception: |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 1012 | self.handleError(record) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1013 | |
| 1014 | def close(self): |
| 1015 | """ |
| 1016 | Clean up this handler. |
| 1017 | |
| 1018 | You can remove the application name from the registry as a |
| 1019 | source of event log entries. However, if you do this, you will |
| 1020 | not be able to see the events as you intended in the Event Log |
| 1021 | Viewer - it needs to be able to access the registry to get the |
| 1022 | DLL name. |
| 1023 | """ |
| 1024 | #self._welu.RemoveSourceFromRegistry(self.appname, self.logtype) |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 1025 | logging.Handler.close(self) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1026 | |
| 1027 | class HTTPHandler(logging.Handler): |
| 1028 | """ |
| 1029 | A class which sends records to a Web server, using either GET or |
| 1030 | POST semantics. |
| 1031 | """ |
Vinay Sajip | af9d10a | 2010-09-13 20:40:30 +0000 | [diff] [blame] | 1032 | def __init__(self, host, url, method="GET", secure=False, credentials=None): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1033 | """ |
| 1034 | Initialize the instance with the host, the request URL, and the method |
| 1035 | ("GET" or "POST") |
| 1036 | """ |
| 1037 | logging.Handler.__init__(self) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1038 | method = method.upper() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1039 | if method not in ["GET", "POST"]: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 1040 | raise ValueError("method must be GET or POST") |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1041 | self.host = host |
| 1042 | self.url = url |
| 1043 | self.method = method |
Vinay Sajip | af9d10a | 2010-09-13 20:40:30 +0000 | [diff] [blame] | 1044 | self.secure = secure |
| 1045 | self.credentials = credentials |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1046 | |
Neal Norwitz | f297bd1 | 2003-04-23 03:49:43 +0000 | [diff] [blame] | 1047 | def mapLogRecord(self, record): |
| 1048 | """ |
| 1049 | Default implementation of mapping the log record into a dict |
Vinay Sajip | 48cfe38 | 2004-02-20 13:17:27 +0000 | [diff] [blame] | 1050 | that is sent as the CGI data. Overwrite in your class. |
Vinay Sajip | af9d10a | 2010-09-13 20:40:30 +0000 | [diff] [blame] | 1051 | Contributed by Franz Glasner. |
Neal Norwitz | f297bd1 | 2003-04-23 03:49:43 +0000 | [diff] [blame] | 1052 | """ |
| 1053 | return record.__dict__ |
| 1054 | |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1055 | def emit(self, record): |
| 1056 | """ |
| 1057 | Emit a record. |
| 1058 | |
Senthil Kumaran | 30e86a4 | 2010-08-09 20:01:35 +0000 | [diff] [blame] | 1059 | Send the record to the Web server as a percent-encoded dictionary |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1060 | """ |
| 1061 | try: |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 1062 | import http.client, urllib.parse |
Vinay Sajip | b793506 | 2005-10-11 13:15:31 +0000 | [diff] [blame] | 1063 | host = self.host |
Vinay Sajip | af9d10a | 2010-09-13 20:40:30 +0000 | [diff] [blame] | 1064 | if self.secure: |
| 1065 | h = http.client.HTTPSConnection(host) |
| 1066 | else: |
| 1067 | h = http.client.HTTPConnection(host) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1068 | url = self.url |
Georg Brandl | 029986a | 2008-06-23 11:44:14 +0000 | [diff] [blame] | 1069 | data = urllib.parse.urlencode(self.mapLogRecord(record)) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1070 | if self.method == "GET": |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1071 | if (url.find('?') >= 0): |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1072 | sep = '&' |
| 1073 | else: |
| 1074 | sep = '?' |
| 1075 | url = url + "%c%s" % (sep, data) |
| 1076 | h.putrequest(self.method, url) |
Vinay Sajip | b793506 | 2005-10-11 13:15:31 +0000 | [diff] [blame] | 1077 | # support multiple hosts on one IP address... |
| 1078 | # need to strip optional :port from host, if present |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1079 | i = host.find(":") |
Vinay Sajip | b793506 | 2005-10-11 13:15:31 +0000 | [diff] [blame] | 1080 | if i >= 0: |
| 1081 | host = host[:i] |
| 1082 | h.putheader("Host", host) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1083 | if self.method == "POST": |
Vinay Sajip | b793506 | 2005-10-11 13:15:31 +0000 | [diff] [blame] | 1084 | h.putheader("Content-type", |
| 1085 | "application/x-www-form-urlencoded") |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1086 | h.putheader("Content-length", str(len(data))) |
Vinay Sajip | af9d10a | 2010-09-13 20:40:30 +0000 | [diff] [blame] | 1087 | if self.credentials: |
| 1088 | import base64 |
| 1089 | s = ('u%s:%s' % self.credentials).encode('utf-8') |
| 1090 | s = 'Basic ' + base64.b64encode(s).strip() |
| 1091 | h.putheader('Authorization', s) |
Vinay Sajip | 0372e10 | 2011-05-05 12:59:14 +0100 | [diff] [blame] | 1092 | h.endheaders() |
| 1093 | if self.method == "POST": |
| 1094 | h.send(data.encode('utf-8')) |
Vinay Sajip | af9d10a | 2010-09-13 20:40:30 +0000 | [diff] [blame] | 1095 | h.getresponse() #can't do anything with the result |
Vinay Sajip | 8cf4eb1 | 2012-10-09 08:06:13 +0100 | [diff] [blame] | 1096 | except Exception: |
Neal Norwitz | 6fa635d | 2003-02-18 14:20:07 +0000 | [diff] [blame] | 1097 | self.handleError(record) |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1098 | |
| 1099 | class BufferingHandler(logging.Handler): |
| 1100 | """ |
| 1101 | A handler class which buffers logging records in memory. Whenever each |
| 1102 | record is added to the buffer, a check is made to see if the buffer should |
| 1103 | be flushed. If it should, then flush() is expected to do what's needed. |
| 1104 | """ |
| 1105 | def __init__(self, capacity): |
| 1106 | """ |
| 1107 | Initialize the handler with the buffer size. |
| 1108 | """ |
| 1109 | logging.Handler.__init__(self) |
| 1110 | self.capacity = capacity |
| 1111 | self.buffer = [] |
| 1112 | |
| 1113 | def shouldFlush(self, record): |
| 1114 | """ |
| 1115 | Should the handler flush its buffer? |
| 1116 | |
| 1117 | Returns true if the buffer is up to capacity. This method can be |
| 1118 | overridden to implement custom flushing strategies. |
| 1119 | """ |
| 1120 | return (len(self.buffer) >= self.capacity) |
| 1121 | |
| 1122 | def emit(self, record): |
| 1123 | """ |
| 1124 | Emit a record. |
| 1125 | |
| 1126 | Append the record. If shouldFlush() tells us to, call flush() to process |
| 1127 | the buffer. |
| 1128 | """ |
| 1129 | self.buffer.append(record) |
| 1130 | if self.shouldFlush(record): |
| 1131 | self.flush() |
| 1132 | |
| 1133 | def flush(self): |
| 1134 | """ |
| 1135 | Override to implement custom flushing behaviour. |
| 1136 | |
| 1137 | This version just zaps the buffer to empty. |
| 1138 | """ |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 1139 | self.acquire() |
| 1140 | try: |
Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 1141 | self.buffer = [] |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 1142 | finally: |
| 1143 | self.release() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1144 | |
Vinay Sajip | f42d95e | 2004-02-21 22:14:34 +0000 | [diff] [blame] | 1145 | def close(self): |
| 1146 | """ |
| 1147 | Close the handler. |
| 1148 | |
| 1149 | This version just flushes and chains to the parent class' close(). |
| 1150 | """ |
| 1151 | self.flush() |
| 1152 | logging.Handler.close(self) |
| 1153 | |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1154 | class MemoryHandler(BufferingHandler): |
| 1155 | """ |
| 1156 | A handler class which buffers logging records in memory, periodically |
| 1157 | flushing them to a target handler. Flushing occurs whenever the buffer |
| 1158 | is full, or when an event of a certain severity or greater is seen. |
| 1159 | """ |
| 1160 | def __init__(self, capacity, flushLevel=logging.ERROR, target=None): |
| 1161 | """ |
| 1162 | Initialize the handler with the buffer size, the level at which |
| 1163 | flushing should occur and an optional target. |
| 1164 | |
| 1165 | Note that without a target being set either here or via setTarget(), |
| 1166 | a MemoryHandler is no use to anyone! |
| 1167 | """ |
| 1168 | BufferingHandler.__init__(self, capacity) |
| 1169 | self.flushLevel = flushLevel |
| 1170 | self.target = target |
| 1171 | |
| 1172 | def shouldFlush(self, record): |
| 1173 | """ |
| 1174 | Check for buffer full or a record at the flushLevel or higher. |
| 1175 | """ |
| 1176 | return (len(self.buffer) >= self.capacity) or \ |
| 1177 | (record.levelno >= self.flushLevel) |
| 1178 | |
| 1179 | def setTarget(self, target): |
| 1180 | """ |
| 1181 | Set the target handler for this handler. |
| 1182 | """ |
| 1183 | self.target = target |
| 1184 | |
| 1185 | def flush(self): |
| 1186 | """ |
| 1187 | For a MemoryHandler, flushing means just sending the buffered |
| 1188 | records to the target, if there is one. Override if you want |
| 1189 | different behaviour. |
Vinay Sajip | c84f016 | 2010-09-21 11:25:39 +0000 | [diff] [blame] | 1190 | |
| 1191 | The record buffer is also cleared by this operation. |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1192 | """ |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 1193 | self.acquire() |
| 1194 | try: |
Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 1195 | if self.target: |
| 1196 | for record in self.buffer: |
| 1197 | self.target.handle(record) |
| 1198 | self.buffer = [] |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 1199 | finally: |
| 1200 | self.release() |
Guido van Rossum | 57102f8 | 2002-11-13 16:15:58 +0000 | [diff] [blame] | 1201 | |
| 1202 | def close(self): |
| 1203 | """ |
| 1204 | Flush, set the target to None and lose the buffer. |
| 1205 | """ |
| 1206 | self.flush() |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 1207 | self.acquire() |
| 1208 | try: |
Vinay Sajip | 0abf61d | 2012-02-23 19:45:52 +0000 | [diff] [blame] | 1209 | self.target = None |
| 1210 | BufferingHandler.close(self) |
Vinay Sajip | f050903 | 2012-02-23 20:49:08 +0000 | [diff] [blame] | 1211 | finally: |
| 1212 | self.release() |
Vinay Sajip | 121a1c4 | 2010-09-08 10:46:15 +0000 | [diff] [blame] | 1213 | |
| 1214 | |
| 1215 | class QueueHandler(logging.Handler): |
| 1216 | """ |
| 1217 | This handler sends events to a queue. Typically, it would be used together |
| 1218 | with a multiprocessing Queue to centralise logging to file in one process |
| 1219 | (in a multi-process application), so as to avoid file write contention |
| 1220 | between processes. |
| 1221 | |
| 1222 | This code is new in Python 3.2, but this class can be copy pasted into |
| 1223 | user code for use with earlier Python versions. |
| 1224 | """ |
| 1225 | |
| 1226 | def __init__(self, queue): |
| 1227 | """ |
| 1228 | Initialise an instance, using the passed queue. |
| 1229 | """ |
| 1230 | logging.Handler.__init__(self) |
| 1231 | self.queue = queue |
| 1232 | |
| 1233 | def enqueue(self, record): |
| 1234 | """ |
| 1235 | Enqueue a record. |
| 1236 | |
| 1237 | The base implementation uses put_nowait. You may want to override |
| 1238 | this method if you want to use blocking, timeouts or custom queue |
| 1239 | implementations. |
| 1240 | """ |
| 1241 | self.queue.put_nowait(record) |
| 1242 | |
Vinay Sajip | 0258ce8 | 2010-09-22 20:34:53 +0000 | [diff] [blame] | 1243 | def prepare(self, record): |
| 1244 | """ |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1245 | Prepares a record for queuing. The object returned by this method is |
| 1246 | enqueued. |
Vinay Sajip | 0258ce8 | 2010-09-22 20:34:53 +0000 | [diff] [blame] | 1247 | |
| 1248 | The base implementation formats the record to merge the message |
| 1249 | and arguments, and removes unpickleable items from the record |
| 1250 | in-place. |
| 1251 | |
| 1252 | You might want to override this method if you want to convert |
| 1253 | the record to a dict or JSON string, or send a modified copy |
| 1254 | of the record while leaving the original intact. |
| 1255 | """ |
| 1256 | # The format operation gets traceback text into record.exc_text |
| 1257 | # (if there's exception data), and also puts the message into |
| 1258 | # record.message. We can then use this to replace the original |
| 1259 | # msg + args, as these might be unpickleable. We also zap the |
| 1260 | # exc_info attribute, as it's no longer needed and, if not None, |
| 1261 | # will typically not be pickleable. |
| 1262 | self.format(record) |
| 1263 | record.msg = record.message |
| 1264 | record.args = None |
| 1265 | record.exc_info = None |
| 1266 | return record |
| 1267 | |
Vinay Sajip | 121a1c4 | 2010-09-08 10:46:15 +0000 | [diff] [blame] | 1268 | def emit(self, record): |
| 1269 | """ |
| 1270 | Emit a record. |
| 1271 | |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1272 | Writes the LogRecord to the queue, preparing it for pickling first. |
Vinay Sajip | 121a1c4 | 2010-09-08 10:46:15 +0000 | [diff] [blame] | 1273 | """ |
| 1274 | try: |
Vinay Sajip | 0258ce8 | 2010-09-22 20:34:53 +0000 | [diff] [blame] | 1275 | self.enqueue(self.prepare(record)) |
Vinay Sajip | 8cf4eb1 | 2012-10-09 08:06:13 +0100 | [diff] [blame] | 1276 | except Exception: |
Vinay Sajip | 121a1c4 | 2010-09-08 10:46:15 +0000 | [diff] [blame] | 1277 | self.handleError(record) |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1278 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1279 | if threading: |
| 1280 | class QueueListener(object): |
| 1281 | """ |
| 1282 | This class implements an internal threaded listener which watches for |
| 1283 | LogRecords being added to a queue, removes them and passes them to a |
| 1284 | list of handlers for processing. |
| 1285 | """ |
| 1286 | _sentinel = None |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1287 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1288 | def __init__(self, queue, *handlers): |
| 1289 | """ |
| 1290 | Initialise an instance with the specified queue and |
| 1291 | handlers. |
| 1292 | """ |
| 1293 | self.queue = queue |
| 1294 | self.handlers = handlers |
| 1295 | self._stop = threading.Event() |
| 1296 | self._thread = None |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1297 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1298 | def dequeue(self, block): |
| 1299 | """ |
| 1300 | Dequeue a record and return it, optionally blocking. |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1301 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1302 | The base implementation uses get. You may want to override this method |
| 1303 | if you want to use timeouts or work with custom queue implementations. |
| 1304 | """ |
| 1305 | return self.queue.get(block) |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1306 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1307 | def start(self): |
| 1308 | """ |
| 1309 | Start the listener. |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1310 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1311 | This starts up a background thread to monitor the queue for |
| 1312 | LogRecords to process. |
| 1313 | """ |
| 1314 | self._thread = t = threading.Thread(target=self._monitor) |
| 1315 | t.setDaemon(True) |
| 1316 | t.start() |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1317 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1318 | def prepare(self , record): |
| 1319 | """ |
| 1320 | Prepare a record for handling. |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1321 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1322 | This method just returns the passed-in record. You may want to |
| 1323 | override this method if you need to do any custom marshalling or |
| 1324 | manipulation of the record before passing it to the handlers. |
| 1325 | """ |
| 1326 | return record |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1327 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1328 | def handle(self, record): |
| 1329 | """ |
| 1330 | Handle a record. |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1331 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1332 | This just loops through the handlers offering them the record |
| 1333 | to handle. |
| 1334 | """ |
| 1335 | record = self.prepare(record) |
| 1336 | for handler in self.handlers: |
| 1337 | handler.handle(record) |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1338 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1339 | def _monitor(self): |
| 1340 | """ |
| 1341 | Monitor the queue for records, and ask the handler |
| 1342 | to deal with them. |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1343 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1344 | This method runs on a separate, internal thread. |
| 1345 | The thread will terminate if it sees a sentinel object in the queue. |
| 1346 | """ |
| 1347 | q = self.queue |
| 1348 | has_task_done = hasattr(q, 'task_done') |
| 1349 | while not self._stop.isSet(): |
| 1350 | try: |
| 1351 | record = self.dequeue(True) |
| 1352 | if record is self._sentinel: |
| 1353 | break |
| 1354 | self.handle(record) |
| 1355 | if has_task_done: |
| 1356 | q.task_done() |
| 1357 | except queue.Empty: |
| 1358 | pass |
| 1359 | # There might still be records in the queue. |
| 1360 | while True: |
| 1361 | try: |
| 1362 | record = self.dequeue(False) |
| 1363 | if record is self._sentinel: |
| 1364 | break |
| 1365 | self.handle(record) |
| 1366 | if has_task_done: |
| 1367 | q.task_done() |
| 1368 | except queue.Empty: |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1369 | break |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1370 | |
Victor Stinner | 59bec36 | 2011-05-02 16:14:16 +0200 | [diff] [blame] | 1371 | def enqueue_sentinel(self): |
| 1372 | """ |
| 1373 | This is used to enqueue the sentinel record. |
Vinay Sajip | aa7c179 | 2011-02-25 15:56:55 +0000 | [diff] [blame] | 1374 | |
Victor Stinner | 59bec36 | 2011-05-02 16:14:16 +0200 | [diff] [blame] | 1375 | The base implementation uses put_nowait. You may want to override this |
| 1376 | method if you want to use timeouts or work with custom queue |
| 1377 | implementations. |
| 1378 | """ |
| 1379 | self.queue.put_nowait(self._sentinel) |
Vinay Sajip | aa7c179 | 2011-02-25 15:56:55 +0000 | [diff] [blame] | 1380 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1381 | def stop(self): |
| 1382 | """ |
| 1383 | Stop the listener. |
Vinay Sajip | 0637d49 | 2010-09-23 08:15:54 +0000 | [diff] [blame] | 1384 | |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1385 | This asks the thread to terminate, and then waits for it to do so. |
| 1386 | Note that if you don't call this before your application exits, there |
| 1387 | may be some records still left on the queue, which won't be processed. |
| 1388 | """ |
| 1389 | self._stop.set() |
Victor Stinner | 59bec36 | 2011-05-02 16:14:16 +0200 | [diff] [blame] | 1390 | self.enqueue_sentinel() |
Victor Stinner | cafa2ef | 2011-05-02 16:11:28 +0200 | [diff] [blame] | 1391 | self._thread.join() |
| 1392 | self._thread = None |