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