Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`logging` --- Logging facility for Python |
| 2 | ============================================== |
| 3 | |
| 4 | .. module:: logging |
| 5 | :synopsis: Flexible error logging system for applications. |
| 6 | |
| 7 | |
| 8 | .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> |
| 9 | .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> |
| 10 | |
| 11 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 12 | .. index:: pair: Errors; logging |
| 13 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | This module defines functions and classes which implement a flexible error |
| 15 | logging system for applications. |
| 16 | |
| 17 | Logging is performed by calling methods on instances of the :class:`Logger` |
| 18 | class (hereafter called :dfn:`loggers`). Each instance has a name, and they are |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 19 | conceptually arranged in a namespace hierarchy using dots (periods) as |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 20 | separators. For example, a logger named "scan" is the parent of loggers |
| 21 | "scan.text", "scan.html" and "scan.pdf". Logger names can be anything you want, |
| 22 | and indicate the area of an application in which a logged message originates. |
| 23 | |
| 24 | Logged messages also have levels of importance associated with them. The default |
| 25 | levels provided are :const:`DEBUG`, :const:`INFO`, :const:`WARNING`, |
| 26 | :const:`ERROR` and :const:`CRITICAL`. As a convenience, you indicate the |
| 27 | importance of a logged message by calling an appropriate method of |
| 28 | :class:`Logger`. The methods are :meth:`debug`, :meth:`info`, :meth:`warning`, |
| 29 | :meth:`error` and :meth:`critical`, which mirror the default levels. You are not |
| 30 | constrained to use these levels: you can specify your own and use a more general |
| 31 | :class:`Logger` method, :meth:`log`, which takes an explicit level argument. |
| 32 | |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 33 | |
| 34 | Logging tutorial |
| 35 | ---------------- |
| 36 | |
| 37 | The key benefit of having the logging API provided by a standard library module |
| 38 | is that all Python modules can participate in logging, so your application log |
| 39 | can include messages from third-party modules. |
| 40 | |
| 41 | It is, of course, possible to log messages with different verbosity levels or to |
| 42 | different destinations. Support for writing log messages to files, HTTP |
| 43 | GET/POST locations, email via SMTP, generic sockets, or OS-specific logging |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 44 | mechanisms are all supported by the standard module. You can also create your |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 45 | own log destination class if you have special requirements not met by any of the |
| 46 | built-in classes. |
| 47 | |
| 48 | Simple examples |
| 49 | ^^^^^^^^^^^^^^^ |
| 50 | |
| 51 | .. sectionauthor:: Doug Hellmann |
| 52 | .. (see <http://blog.doughellmann.com/2007/05/pymotw-logging.html>) |
| 53 | |
| 54 | Most applications are probably going to want to log to a file, so let's start |
| 55 | with that case. Using the :func:`basicConfig` function, we can set up the |
| 56 | default handler so that debug messages are written to a file:: |
| 57 | |
| 58 | import logging |
| 59 | LOG_FILENAME = '/tmp/logging_example.out' |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 60 | logging.basicConfig(filename=LOG_FILENAME,level=logging.DEBUG) |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 61 | |
| 62 | logging.debug('This message should go to the log file') |
| 63 | |
| 64 | And now if we open the file and look at what we have, we should find the log |
| 65 | message:: |
| 66 | |
| 67 | DEBUG:root:This message should go to the log file |
| 68 | |
| 69 | If you run the script repeatedly, the additional log messages are appended to |
Eric Smith | 5c01a8d | 2009-06-04 18:20:51 +0000 | [diff] [blame] | 70 | the file. To create a new file each time, you can pass a *filemode* argument to |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 71 | :func:`basicConfig` with a value of ``'w'``. Rather than managing the file size |
| 72 | yourself, though, it is simpler to use a :class:`RotatingFileHandler`:: |
| 73 | |
| 74 | import glob |
| 75 | import logging |
| 76 | import logging.handlers |
| 77 | |
| 78 | LOG_FILENAME = '/tmp/logging_rotatingfile_example.out' |
| 79 | |
| 80 | # Set up a specific logger with our desired output level |
| 81 | my_logger = logging.getLogger('MyLogger') |
| 82 | my_logger.setLevel(logging.DEBUG) |
| 83 | |
| 84 | # Add the log message handler to the logger |
| 85 | handler = logging.handlers.RotatingFileHandler( |
| 86 | LOG_FILENAME, maxBytes=20, backupCount=5) |
| 87 | |
| 88 | my_logger.addHandler(handler) |
| 89 | |
| 90 | # Log some messages |
| 91 | for i in range(20): |
| 92 | my_logger.debug('i = %d' % i) |
| 93 | |
| 94 | # See what files are created |
| 95 | logfiles = glob.glob('%s*' % LOG_FILENAME) |
| 96 | |
| 97 | for filename in logfiles: |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 98 | print(filename) |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 99 | |
| 100 | The result should be 6 separate files, each with part of the log history for the |
| 101 | application:: |
| 102 | |
| 103 | /tmp/logging_rotatingfile_example.out |
| 104 | /tmp/logging_rotatingfile_example.out.1 |
| 105 | /tmp/logging_rotatingfile_example.out.2 |
| 106 | /tmp/logging_rotatingfile_example.out.3 |
| 107 | /tmp/logging_rotatingfile_example.out.4 |
| 108 | /tmp/logging_rotatingfile_example.out.5 |
| 109 | |
| 110 | The most current file is always :file:`/tmp/logging_rotatingfile_example.out`, |
| 111 | and each time it reaches the size limit it is renamed with the suffix |
| 112 | ``.1``. Each of the existing backup files is renamed to increment the suffix |
Eric Smith | 5c01a8d | 2009-06-04 18:20:51 +0000 | [diff] [blame] | 113 | (``.1`` becomes ``.2``, etc.) and the ``.6`` file is erased. |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 114 | |
| 115 | Obviously this example sets the log length much much too small as an extreme |
| 116 | example. You would want to set *maxBytes* to an appropriate value. |
| 117 | |
| 118 | Another useful feature of the logging API is the ability to produce different |
| 119 | messages at different log levels. This allows you to instrument your code with |
| 120 | debug messages, for example, but turning the log level down so that those debug |
| 121 | messages are not written for your production system. The default levels are |
Vinay Sajip | b6d065f | 2009-10-28 23:28:16 +0000 | [diff] [blame] | 122 | ``NOTSET``, ``DEBUG``, ``INFO``, ``WARNING``, ``ERROR`` and ``CRITICAL``. |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 123 | |
| 124 | The logger, handler, and log message call each specify a level. The log message |
| 125 | is only emitted if the handler and logger are configured to emit messages of |
| 126 | that level or lower. For example, if a message is ``CRITICAL``, and the logger |
| 127 | is set to ``ERROR``, the message is emitted. If a message is a ``WARNING``, and |
| 128 | the logger is set to produce only ``ERROR``\s, the message is not emitted:: |
| 129 | |
| 130 | import logging |
| 131 | import sys |
| 132 | |
| 133 | LEVELS = {'debug': logging.DEBUG, |
| 134 | 'info': logging.INFO, |
| 135 | 'warning': logging.WARNING, |
| 136 | 'error': logging.ERROR, |
| 137 | 'critical': logging.CRITICAL} |
| 138 | |
| 139 | if len(sys.argv) > 1: |
| 140 | level_name = sys.argv[1] |
| 141 | level = LEVELS.get(level_name, logging.NOTSET) |
| 142 | logging.basicConfig(level=level) |
| 143 | |
| 144 | logging.debug('This is a debug message') |
| 145 | logging.info('This is an info message') |
| 146 | logging.warning('This is a warning message') |
| 147 | logging.error('This is an error message') |
| 148 | logging.critical('This is a critical error message') |
| 149 | |
| 150 | Run the script with an argument like 'debug' or 'warning' to see which messages |
| 151 | show up at different levels:: |
| 152 | |
| 153 | $ python logging_level_example.py debug |
| 154 | DEBUG:root:This is a debug message |
| 155 | INFO:root:This is an info message |
| 156 | WARNING:root:This is a warning message |
| 157 | ERROR:root:This is an error message |
| 158 | CRITICAL:root:This is a critical error message |
| 159 | |
| 160 | $ python logging_level_example.py info |
| 161 | INFO:root:This is an info message |
| 162 | WARNING:root:This is a warning message |
| 163 | ERROR:root:This is an error message |
| 164 | CRITICAL:root:This is a critical error message |
| 165 | |
| 166 | You will notice that these log messages all have ``root`` embedded in them. The |
| 167 | logging module supports a hierarchy of loggers with different names. An easy |
| 168 | way to tell where a specific log message comes from is to use a separate logger |
| 169 | object for each of your modules. Each new logger "inherits" the configuration |
| 170 | of its parent, and log messages sent to a logger include the name of that |
| 171 | logger. Optionally, each logger can be configured differently, so that messages |
| 172 | from different modules are handled in different ways. Let's look at a simple |
| 173 | example of how to log from different modules so it is easy to trace the source |
| 174 | of the message:: |
| 175 | |
| 176 | import logging |
| 177 | |
| 178 | logging.basicConfig(level=logging.WARNING) |
| 179 | |
| 180 | logger1 = logging.getLogger('package1.module1') |
| 181 | logger2 = logging.getLogger('package2.module2') |
| 182 | |
| 183 | logger1.warning('This message comes from one module') |
| 184 | logger2.warning('And this message comes from another module') |
| 185 | |
| 186 | And the output:: |
| 187 | |
| 188 | $ python logging_modules_example.py |
| 189 | WARNING:package1.module1:This message comes from one module |
| 190 | WARNING:package2.module2:And this message comes from another module |
| 191 | |
| 192 | There are many more options for configuring logging, including different log |
| 193 | message formatting options, having messages delivered to multiple destinations, |
| 194 | and changing the configuration of a long-running application on the fly using a |
| 195 | socket interface. All of these options are covered in depth in the library |
| 196 | module documentation. |
| 197 | |
| 198 | Loggers |
| 199 | ^^^^^^^ |
| 200 | |
| 201 | The logging library takes a modular approach and offers the several categories |
| 202 | of components: loggers, handlers, filters, and formatters. Loggers expose the |
| 203 | interface that application code directly uses. Handlers send the log records to |
| 204 | the appropriate destination. Filters provide a finer grained facility for |
| 205 | determining which log records to send on to a handler. Formatters specify the |
| 206 | layout of the resultant log record. |
| 207 | |
| 208 | :class:`Logger` objects have a threefold job. First, they expose several |
| 209 | methods to application code so that applications can log messages at runtime. |
| 210 | Second, logger objects determine which log messages to act upon based upon |
| 211 | severity (the default filtering facility) or filter objects. Third, logger |
| 212 | objects pass along relevant log messages to all interested log handlers. |
| 213 | |
| 214 | The most widely used methods on logger objects fall into two categories: |
| 215 | configuration and message sending. |
| 216 | |
| 217 | * :meth:`Logger.setLevel` specifies the lowest-severity log message a logger |
| 218 | will handle, where debug is the lowest built-in severity level and critical is |
| 219 | the highest built-in severity. For example, if the severity level is info, |
| 220 | the logger will handle only info, warning, error, and critical messages and |
| 221 | will ignore debug messages. |
| 222 | |
| 223 | * :meth:`Logger.addFilter` and :meth:`Logger.removeFilter` add and remove filter |
| 224 | objects from the logger object. This tutorial does not address filters. |
| 225 | |
| 226 | With the logger object configured, the following methods create log messages: |
| 227 | |
| 228 | * :meth:`Logger.debug`, :meth:`Logger.info`, :meth:`Logger.warning`, |
| 229 | :meth:`Logger.error`, and :meth:`Logger.critical` all create log records with |
| 230 | a message and a level that corresponds to their respective method names. The |
| 231 | message is actually a format string, which may contain the standard string |
| 232 | substitution syntax of :const:`%s`, :const:`%d`, :const:`%f`, and so on. The |
| 233 | rest of their arguments is a list of objects that correspond with the |
| 234 | substitution fields in the message. With regard to :const:`**kwargs`, the |
| 235 | logging methods care only about a keyword of :const:`exc_info` and use it to |
| 236 | determine whether to log exception information. |
| 237 | |
| 238 | * :meth:`Logger.exception` creates a log message similar to |
| 239 | :meth:`Logger.error`. The difference is that :meth:`Logger.exception` dumps a |
| 240 | stack trace along with it. Call this method only from an exception handler. |
| 241 | |
| 242 | * :meth:`Logger.log` takes a log level as an explicit argument. This is a |
| 243 | little more verbose for logging messages than using the log level convenience |
| 244 | methods listed above, but this is how to log at custom log levels. |
| 245 | |
Christian Heimes | dcca98d | 2008-02-25 13:19:43 +0000 | [diff] [blame] | 246 | :func:`getLogger` returns a reference to a logger instance with the specified |
| 247 | if it it is provided, or ``root`` if not. The names are period-separated |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 248 | hierarchical structures. Multiple calls to :func:`getLogger` with the same name |
| 249 | will return a reference to the same logger object. Loggers that are further |
| 250 | down in the hierarchical list are children of loggers higher up in the list. |
| 251 | For example, given a logger with a name of ``foo``, loggers with names of |
| 252 | ``foo.bar``, ``foo.bar.baz``, and ``foo.bam`` are all children of ``foo``. |
| 253 | Child loggers propagate messages up to their parent loggers. Because of this, |
| 254 | it is unnecessary to define and configure all the loggers an application uses. |
| 255 | It is sufficient to configure a top-level logger and create child loggers as |
| 256 | needed. |
| 257 | |
| 258 | |
| 259 | Handlers |
| 260 | ^^^^^^^^ |
| 261 | |
| 262 | :class:`Handler` objects are responsible for dispatching the appropriate log |
| 263 | messages (based on the log messages' severity) to the handler's specified |
| 264 | destination. Logger objects can add zero or more handler objects to themselves |
| 265 | with an :func:`addHandler` method. As an example scenario, an application may |
| 266 | want to send all log messages to a log file, all log messages of error or higher |
| 267 | to stdout, and all messages of critical to an email address. This scenario |
Christian Heimes | c3f30c4 | 2008-02-22 16:37:40 +0000 | [diff] [blame] | 268 | requires three individual handlers where each handler is responsible for sending |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 269 | messages of a specific severity to a specific location. |
| 270 | |
| 271 | The standard library includes quite a few handler types; this tutorial uses only |
| 272 | :class:`StreamHandler` and :class:`FileHandler` in its examples. |
| 273 | |
| 274 | There are very few methods in a handler for application developers to concern |
| 275 | themselves with. The only handler methods that seem relevant for application |
| 276 | developers who are using the built-in handler objects (that is, not creating |
| 277 | custom handlers) are the following configuration methods: |
| 278 | |
| 279 | * The :meth:`Handler.setLevel` method, just as in logger objects, specifies the |
| 280 | lowest severity that will be dispatched to the appropriate destination. Why |
| 281 | are there two :func:`setLevel` methods? The level set in the logger |
| 282 | determines which severity of messages it will pass to its handlers. The level |
| 283 | set in each handler determines which messages that handler will send on. |
| 284 | :func:`setFormatter` selects a Formatter object for this handler to use. |
| 285 | |
| 286 | * :func:`addFilter` and :func:`removeFilter` respectively configure and |
| 287 | deconfigure filter objects on handlers. |
| 288 | |
| 289 | Application code should not directly instantiate and use handlers. Instead, the |
| 290 | :class:`Handler` class is a base class that defines the interface that all |
| 291 | Handlers should have and establishes some default behavior that child classes |
| 292 | can use (or override). |
| 293 | |
| 294 | |
| 295 | Formatters |
| 296 | ^^^^^^^^^^ |
| 297 | |
| 298 | Formatter objects configure the final order, structure, and contents of the log |
Christian Heimes | dcca98d | 2008-02-25 13:19:43 +0000 | [diff] [blame] | 299 | message. Unlike the base :class:`logging.Handler` class, application code may |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 300 | instantiate formatter classes, although you could likely subclass the formatter |
| 301 | if your application needs special behavior. The constructor takes two optional |
| 302 | arguments: a message format string and a date format string. If there is no |
| 303 | message format string, the default is to use the raw message. If there is no |
| 304 | date format string, the default date format is:: |
| 305 | |
| 306 | %Y-%m-%d %H:%M:%S |
| 307 | |
| 308 | with the milliseconds tacked on at the end. |
| 309 | |
| 310 | The message format string uses ``%(<dictionary key>)s`` styled string |
| 311 | substitution; the possible keys are documented in :ref:`formatter-objects`. |
| 312 | |
| 313 | The following message format string will log the time in a human-readable |
| 314 | format, the severity of the message, and the contents of the message, in that |
| 315 | order:: |
| 316 | |
| 317 | "%(asctime)s - %(levelname)s - %(message)s" |
| 318 | |
| 319 | |
| 320 | Configuring Logging |
| 321 | ^^^^^^^^^^^^^^^^^^^ |
| 322 | |
| 323 | Programmers can configure logging either by creating loggers, handlers, and |
| 324 | formatters explicitly in a main module with the configuration methods listed |
| 325 | above (using Python code), or by creating a logging config file. The following |
| 326 | code is an example of configuring a very simple logger, a console handler, and a |
| 327 | simple formatter in a Python module:: |
| 328 | |
| 329 | import logging |
| 330 | |
| 331 | # create logger |
| 332 | logger = logging.getLogger("simple_example") |
| 333 | logger.setLevel(logging.DEBUG) |
| 334 | # create console handler and set level to debug |
| 335 | ch = logging.StreamHandler() |
| 336 | ch.setLevel(logging.DEBUG) |
| 337 | # create formatter |
| 338 | formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") |
| 339 | # add formatter to ch |
| 340 | ch.setFormatter(formatter) |
| 341 | # add ch to logger |
| 342 | logger.addHandler(ch) |
| 343 | |
| 344 | # "application" code |
| 345 | logger.debug("debug message") |
| 346 | logger.info("info message") |
| 347 | logger.warn("warn message") |
| 348 | logger.error("error message") |
| 349 | logger.critical("critical message") |
| 350 | |
| 351 | Running this module from the command line produces the following output:: |
| 352 | |
| 353 | $ python simple_logging_module.py |
| 354 | 2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message |
| 355 | 2005-03-19 15:10:26,620 - simple_example - INFO - info message |
| 356 | 2005-03-19 15:10:26,695 - simple_example - WARNING - warn message |
| 357 | 2005-03-19 15:10:26,697 - simple_example - ERROR - error message |
| 358 | 2005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message |
| 359 | |
| 360 | The following Python module creates a logger, handler, and formatter nearly |
| 361 | identical to those in the example listed above, with the only difference being |
| 362 | the names of the objects:: |
| 363 | |
| 364 | import logging |
| 365 | import logging.config |
| 366 | |
| 367 | logging.config.fileConfig("logging.conf") |
| 368 | |
| 369 | # create logger |
| 370 | logger = logging.getLogger("simpleExample") |
| 371 | |
| 372 | # "application" code |
| 373 | logger.debug("debug message") |
| 374 | logger.info("info message") |
| 375 | logger.warn("warn message") |
| 376 | logger.error("error message") |
| 377 | logger.critical("critical message") |
| 378 | |
| 379 | Here is the logging.conf file:: |
| 380 | |
| 381 | [loggers] |
| 382 | keys=root,simpleExample |
| 383 | |
| 384 | [handlers] |
| 385 | keys=consoleHandler |
| 386 | |
| 387 | [formatters] |
| 388 | keys=simpleFormatter |
| 389 | |
| 390 | [logger_root] |
| 391 | level=DEBUG |
| 392 | handlers=consoleHandler |
| 393 | |
| 394 | [logger_simpleExample] |
| 395 | level=DEBUG |
| 396 | handlers=consoleHandler |
| 397 | qualname=simpleExample |
| 398 | propagate=0 |
| 399 | |
| 400 | [handler_consoleHandler] |
| 401 | class=StreamHandler |
| 402 | level=DEBUG |
| 403 | formatter=simpleFormatter |
| 404 | args=(sys.stdout,) |
| 405 | |
| 406 | [formatter_simpleFormatter] |
| 407 | format=%(asctime)s - %(name)s - %(levelname)s - %(message)s |
| 408 | datefmt= |
| 409 | |
| 410 | The output is nearly identical to that of the non-config-file-based example:: |
| 411 | |
| 412 | $ python simple_logging_config.py |
| 413 | 2005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message |
| 414 | 2005-03-19 15:38:55,979 - simpleExample - INFO - info message |
| 415 | 2005-03-19 15:38:56,054 - simpleExample - WARNING - warn message |
| 416 | 2005-03-19 15:38:56,055 - simpleExample - ERROR - error message |
| 417 | 2005-03-19 15:38:56,130 - simpleExample - CRITICAL - critical message |
| 418 | |
| 419 | You can see that the config file approach has a few advantages over the Python |
| 420 | code approach, mainly separation of configuration and code and the ability of |
| 421 | noncoders to easily modify the logging properties. |
| 422 | |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 423 | Note that the class names referenced in config files need to be either relative |
| 424 | to the logging module, or absolute values which can be resolved using normal |
| 425 | import mechanisms. Thus, you could use either `handlers.WatchedFileHandler` |
| 426 | (relative to the logging module) or `mypackage.mymodule.MyHandler` (for a |
| 427 | class defined in package `mypackage` and module `mymodule`, where `mypackage` |
| 428 | is available on the Python import path). |
| 429 | |
Vinay Sajip | 26a2d5e | 2009-01-10 13:37:26 +0000 | [diff] [blame] | 430 | .. _library-config: |
Vinay Sajip | 30bf122 | 2009-01-10 19:23:34 +0000 | [diff] [blame] | 431 | |
Benjamin Peterson | 3e4f055 | 2008-09-02 00:31:15 +0000 | [diff] [blame] | 432 | Configuring Logging for a Library |
| 433 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 434 | |
| 435 | When developing a library which uses logging, some consideration needs to be |
| 436 | given to its configuration. If the using application does not use logging, and |
| 437 | library code makes logging calls, then a one-off message "No handlers could be |
| 438 | found for logger X.Y.Z" is printed to the console. This message is intended |
| 439 | to catch mistakes in logging configuration, but will confuse an application |
| 440 | developer who is not aware of logging by the library. |
| 441 | |
| 442 | In addition to documenting how a library uses logging, a good way to configure |
| 443 | library logging so that it does not cause a spurious message is to add a |
| 444 | handler which does nothing. This avoids the message being printed, since a |
| 445 | handler will be found: it just doesn't produce any output. If the library user |
| 446 | configures logging for application use, presumably that configuration will add |
| 447 | some handlers, and if levels are suitably configured then logging calls made |
| 448 | in library code will send output to those handlers, as normal. |
| 449 | |
| 450 | A do-nothing handler can be simply defined as follows:: |
| 451 | |
| 452 | import logging |
| 453 | |
| 454 | class NullHandler(logging.Handler): |
| 455 | def emit(self, record): |
| 456 | pass |
| 457 | |
| 458 | An instance of this handler should be added to the top-level logger of the |
| 459 | logging namespace used by the library. If all logging by a library *foo* is |
| 460 | done using loggers with names matching "foo.x.y", then the code:: |
| 461 | |
| 462 | import logging |
| 463 | |
| 464 | h = NullHandler() |
| 465 | logging.getLogger("foo").addHandler(h) |
| 466 | |
| 467 | should have the desired effect. If an organisation produces a number of |
| 468 | libraries, then the logger name specified can be "orgname.foo" rather than |
| 469 | just "foo". |
| 470 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 471 | .. versionadded:: 3.1 |
| 472 | |
| 473 | The :class:`NullHandler` class was not present in previous versions, but is now |
| 474 | included, so that it need not be defined in library code. |
| 475 | |
| 476 | |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 477 | |
| 478 | Logging Levels |
| 479 | -------------- |
| 480 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 481 | The numeric values of logging levels are given in the following table. These are |
| 482 | primarily of interest if you want to define your own levels, and need them to |
| 483 | have specific values relative to the predefined levels. If you define a level |
| 484 | with the same numeric value, it overwrites the predefined value; the predefined |
| 485 | name is lost. |
| 486 | |
| 487 | +--------------+---------------+ |
| 488 | | Level | Numeric value | |
| 489 | +==============+===============+ |
| 490 | | ``CRITICAL`` | 50 | |
| 491 | +--------------+---------------+ |
| 492 | | ``ERROR`` | 40 | |
| 493 | +--------------+---------------+ |
| 494 | | ``WARNING`` | 30 | |
| 495 | +--------------+---------------+ |
| 496 | | ``INFO`` | 20 | |
| 497 | +--------------+---------------+ |
| 498 | | ``DEBUG`` | 10 | |
| 499 | +--------------+---------------+ |
| 500 | | ``NOTSET`` | 0 | |
| 501 | +--------------+---------------+ |
| 502 | |
| 503 | Levels can also be associated with loggers, being set either by the developer or |
| 504 | through loading a saved logging configuration. When a logging method is called |
| 505 | on a logger, the logger compares its own level with the level associated with |
| 506 | the method call. If the logger's level is higher than the method call's, no |
| 507 | logging message is actually generated. This is the basic mechanism controlling |
| 508 | the verbosity of logging output. |
| 509 | |
| 510 | Logging messages are encoded as instances of the :class:`LogRecord` class. When |
| 511 | a logger decides to actually log an event, a :class:`LogRecord` instance is |
| 512 | created from the logging message. |
| 513 | |
| 514 | Logging messages are subjected to a dispatch mechanism through the use of |
| 515 | :dfn:`handlers`, which are instances of subclasses of the :class:`Handler` |
| 516 | class. Handlers are responsible for ensuring that a logged message (in the form |
| 517 | of a :class:`LogRecord`) ends up in a particular location (or set of locations) |
| 518 | which is useful for the target audience for that message (such as end users, |
| 519 | support desk staff, system administrators, developers). Handlers are passed |
| 520 | :class:`LogRecord` instances intended for particular destinations. Each logger |
| 521 | can have zero, one or more handlers associated with it (via the |
| 522 | :meth:`addHandler` method of :class:`Logger`). In addition to any handlers |
| 523 | directly associated with a logger, *all handlers associated with all ancestors |
| 524 | of the logger* are called to dispatch the message. |
| 525 | |
| 526 | Just as for loggers, handlers can have levels associated with them. A handler's |
| 527 | level acts as a filter in the same way as a logger's level does. If a handler |
| 528 | decides to actually dispatch an event, the :meth:`emit` method is used to send |
| 529 | the message to its destination. Most user-defined subclasses of :class:`Handler` |
| 530 | will need to override this :meth:`emit`. |
| 531 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 532 | Useful Handlers |
| 533 | --------------- |
| 534 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 535 | In addition to the base :class:`Handler` class, many useful subclasses are |
| 536 | provided: |
| 537 | |
| 538 | #. :class:`StreamHandler` instances send error messages to streams (file-like |
| 539 | objects). |
| 540 | |
| 541 | #. :class:`FileHandler` instances send error messages to disk files. |
| 542 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 543 | .. module:: logging.handlers |
Vinay Sajip | 30bf122 | 2009-01-10 19:23:34 +0000 | [diff] [blame] | 544 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 545 | #. :class:`BaseRotatingHandler` is the base class for handlers that |
| 546 | rotate log files at a certain point. It is not meant to be instantiated |
| 547 | directly. Instead, use :class:`RotatingFileHandler` or |
| 548 | :class:`TimedRotatingFileHandler`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 549 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 550 | #. :class:`RotatingFileHandler` instances send error messages to disk |
| 551 | files, with support for maximum log file sizes and log file rotation. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 552 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 553 | #. :class:`TimedRotatingFileHandler` instances send error messages to |
| 554 | disk files, rotating the log file at certain timed intervals. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 555 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 556 | #. :class:`SocketHandler` instances send error messages to TCP/IP |
| 557 | sockets. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 558 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 559 | #. :class:`DatagramHandler` instances send error messages to UDP |
| 560 | sockets. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 561 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 562 | #. :class:`SMTPHandler` instances send error messages to a designated |
| 563 | email address. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 564 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 565 | #. :class:`SysLogHandler` instances send error messages to a Unix |
| 566 | syslog daemon, possibly on a remote machine. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 567 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 568 | #. :class:`NTEventLogHandler` instances send error messages to a |
| 569 | Windows NT/2000/XP event log. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 570 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 571 | #. :class:`MemoryHandler` instances send error messages to a buffer |
| 572 | in memory, which is flushed whenever specific criteria are met. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 573 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 574 | #. :class:`HTTPHandler` instances send error messages to an HTTP |
| 575 | server using either ``GET`` or ``POST`` semantics. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 576 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 577 | #. :class:`WatchedFileHandler` instances watch the file they are |
| 578 | logging to. If the file changes, it is closed and reopened using the file |
| 579 | name. This handler is only useful on Unix-like systems; Windows does not |
| 580 | support the underlying mechanism used. |
Vinay Sajip | 30bf122 | 2009-01-10 19:23:34 +0000 | [diff] [blame] | 581 | |
| 582 | .. currentmodule:: logging |
| 583 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 584 | #. :class:`NullHandler` instances do nothing with error messages. They are used |
| 585 | by library developers who want to use logging, but want to avoid the "No |
| 586 | handlers could be found for logger XXX" message which can be displayed if |
Vinay Sajip | 26a2d5e | 2009-01-10 13:37:26 +0000 | [diff] [blame] | 587 | the library user has not configured logging. See :ref:`library-config` for |
| 588 | more information. |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 589 | |
| 590 | .. versionadded:: 3.1 |
| 591 | |
| 592 | The :class:`NullHandler` class was not present in previous versions. |
| 593 | |
Vinay Sajip | a17775f | 2008-12-30 07:32:59 +0000 | [diff] [blame] | 594 | The :class:`NullHandler`, :class:`StreamHandler` and :class:`FileHandler` |
| 595 | classes are defined in the core logging package. The other handlers are |
| 596 | defined in a sub- module, :mod:`logging.handlers`. (There is also another |
| 597 | sub-module, :mod:`logging.config`, for configuration functionality.) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 598 | |
| 599 | Logged messages are formatted for presentation through instances of the |
| 600 | :class:`Formatter` class. They are initialized with a format string suitable for |
| 601 | use with the % operator and a dictionary. |
| 602 | |
| 603 | For formatting multiple messages in a batch, instances of |
| 604 | :class:`BufferingFormatter` can be used. In addition to the format string (which |
| 605 | is applied to each message in the batch), there is provision for header and |
| 606 | trailer format strings. |
| 607 | |
| 608 | When filtering based on logger level and/or handler level is not enough, |
| 609 | instances of :class:`Filter` can be added to both :class:`Logger` and |
| 610 | :class:`Handler` instances (through their :meth:`addFilter` method). Before |
| 611 | deciding to process a message further, both loggers and handlers consult all |
| 612 | their filters for permission. If any filter returns a false value, the message |
| 613 | is not processed further. |
| 614 | |
| 615 | The basic :class:`Filter` functionality allows filtering by specific logger |
| 616 | name. If this feature is used, messages sent to the named logger and its |
| 617 | children are allowed through the filter, and all others dropped. |
| 618 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 619 | Module-Level Functions |
| 620 | ---------------------- |
| 621 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 622 | In addition to the classes described above, there are a number of module- level |
| 623 | functions. |
| 624 | |
| 625 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 626 | .. function:: getLogger(name=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 627 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 628 | Return a logger with the specified name or, if name is ``None``, return a |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 629 | logger which is the root logger of the hierarchy. If specified, the name is |
| 630 | typically a dot-separated hierarchical name like *"a"*, *"a.b"* or *"a.b.c.d"*. |
| 631 | Choice of these names is entirely up to the developer who is using logging. |
| 632 | |
| 633 | All calls to this function with a given name return the same logger instance. |
| 634 | This means that logger instances never need to be passed between different parts |
| 635 | of an application. |
| 636 | |
| 637 | |
| 638 | .. function:: getLoggerClass() |
| 639 | |
| 640 | Return either the standard :class:`Logger` class, or the last class passed to |
| 641 | :func:`setLoggerClass`. This function may be called from within a new class |
| 642 | definition, to ensure that installing a customised :class:`Logger` class will |
| 643 | not undo customisations already applied by other code. For example:: |
| 644 | |
| 645 | class MyLogger(logging.getLoggerClass()): |
| 646 | # ... override behaviour here |
| 647 | |
| 648 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 649 | .. function:: debug(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 650 | |
| 651 | Logs a message with level :const:`DEBUG` on the root logger. The *msg* is the |
| 652 | message format string, and the *args* are the arguments which are merged into |
| 653 | *msg* using the string formatting operator. (Note that this means that you can |
| 654 | use keywords in the format string, together with a single dictionary argument.) |
| 655 | |
| 656 | There are two keyword arguments in *kwargs* which are inspected: *exc_info* |
| 657 | which, if it does not evaluate as false, causes exception information to be |
| 658 | added to the logging message. If an exception tuple (in the format returned by |
| 659 | :func:`sys.exc_info`) is provided, it is used; otherwise, :func:`sys.exc_info` |
| 660 | is called to get the exception information. |
| 661 | |
| 662 | The other optional keyword argument is *extra* which can be used to pass a |
| 663 | dictionary which is used to populate the __dict__ of the LogRecord created for |
| 664 | the logging event with user-defined attributes. These custom attributes can then |
| 665 | be used as you like. For example, they could be incorporated into logged |
| 666 | messages. For example:: |
| 667 | |
| 668 | FORMAT = "%(asctime)-15s %(clientip)s %(user)-8s %(message)s" |
| 669 | logging.basicConfig(format=FORMAT) |
| 670 | d = {'clientip': '192.168.0.1', 'user': 'fbloggs'} |
| 671 | logging.warning("Protocol problem: %s", "connection reset", extra=d) |
| 672 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 673 | would print something like :: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 674 | |
| 675 | 2006-02-08 22:20:02,165 192.168.0.1 fbloggs Protocol problem: connection reset |
| 676 | |
| 677 | The keys in the dictionary passed in *extra* should not clash with the keys used |
| 678 | by the logging system. (See the :class:`Formatter` documentation for more |
| 679 | information on which keys are used by the logging system.) |
| 680 | |
| 681 | If you choose to use these attributes in logged messages, you need to exercise |
| 682 | some care. In the above example, for instance, the :class:`Formatter` has been |
| 683 | set up with a format string which expects 'clientip' and 'user' in the attribute |
| 684 | dictionary of the LogRecord. If these are missing, the message will not be |
| 685 | logged because a string formatting exception will occur. So in this case, you |
| 686 | always need to pass the *extra* dictionary with these keys. |
| 687 | |
| 688 | While this might be annoying, this feature is intended for use in specialized |
| 689 | circumstances, such as multi-threaded servers where the same code executes in |
| 690 | many contexts, and interesting conditions which arise are dependent on this |
| 691 | context (such as remote client IP address and authenticated user name, in the |
| 692 | above example). In such circumstances, it is likely that specialized |
| 693 | :class:`Formatter`\ s would be used with particular :class:`Handler`\ s. |
| 694 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 695 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 696 | .. function:: info(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 697 | |
| 698 | Logs a message with level :const:`INFO` on the root logger. The arguments are |
| 699 | interpreted as for :func:`debug`. |
| 700 | |
| 701 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 702 | .. function:: warning(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 703 | |
| 704 | Logs a message with level :const:`WARNING` on the root logger. The arguments are |
| 705 | interpreted as for :func:`debug`. |
| 706 | |
| 707 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 708 | .. function:: error(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 709 | |
| 710 | Logs a message with level :const:`ERROR` on the root logger. The arguments are |
| 711 | interpreted as for :func:`debug`. |
| 712 | |
| 713 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 714 | .. function:: critical(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 715 | |
| 716 | Logs a message with level :const:`CRITICAL` on the root logger. The arguments |
| 717 | are interpreted as for :func:`debug`. |
| 718 | |
| 719 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 720 | .. function:: exception(msg, *args) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 721 | |
| 722 | Logs a message with level :const:`ERROR` on the root logger. The arguments are |
| 723 | interpreted as for :func:`debug`. Exception info is added to the logging |
| 724 | message. This function should only be called from an exception handler. |
| 725 | |
| 726 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 727 | .. function:: log(level, msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 728 | |
| 729 | Logs a message with level *level* on the root logger. The other arguments are |
| 730 | interpreted as for :func:`debug`. |
| 731 | |
| 732 | |
| 733 | .. function:: disable(lvl) |
| 734 | |
| 735 | Provides an overriding level *lvl* for all loggers which takes precedence over |
| 736 | the logger's own level. When the need arises to temporarily throttle logging |
Benjamin Peterson | 886af96 | 2010-03-21 23:13:07 +0000 | [diff] [blame^] | 737 | output down across the whole application, this function can be useful. Its |
| 738 | effect is to disable all logging calls of severity *lvl* and below, so that |
| 739 | if you call it with a value of INFO, then all INFO and DEBUG events would be |
| 740 | discarded, whereas those of severity WARNING and above would be processed |
| 741 | according to the logger's effective level. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 742 | |
| 743 | |
| 744 | .. function:: addLevelName(lvl, levelName) |
| 745 | |
| 746 | Associates level *lvl* with text *levelName* in an internal dictionary, which is |
| 747 | used to map numeric levels to a textual representation, for example when a |
| 748 | :class:`Formatter` formats a message. This function can also be used to define |
| 749 | your own levels. The only constraints are that all levels used must be |
| 750 | registered using this function, levels should be positive integers and they |
| 751 | should increase in increasing order of severity. |
| 752 | |
| 753 | |
| 754 | .. function:: getLevelName(lvl) |
| 755 | |
| 756 | Returns the textual representation of logging level *lvl*. If the level is one |
| 757 | of the predefined levels :const:`CRITICAL`, :const:`ERROR`, :const:`WARNING`, |
| 758 | :const:`INFO` or :const:`DEBUG` then you get the corresponding string. If you |
| 759 | have associated levels with names using :func:`addLevelName` then the name you |
| 760 | have associated with *lvl* is returned. If a numeric value corresponding to one |
| 761 | of the defined levels is passed in, the corresponding string representation is |
| 762 | returned. Otherwise, the string "Level %s" % lvl is returned. |
| 763 | |
| 764 | |
| 765 | .. function:: makeLogRecord(attrdict) |
| 766 | |
| 767 | Creates and returns a new :class:`LogRecord` instance whose attributes are |
| 768 | defined by *attrdict*. This function is useful for taking a pickled |
| 769 | :class:`LogRecord` attribute dictionary, sent over a socket, and reconstituting |
| 770 | it as a :class:`LogRecord` instance at the receiving end. |
| 771 | |
| 772 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 773 | .. function:: basicConfig(**kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 774 | |
| 775 | Does basic configuration for the logging system by creating a |
| 776 | :class:`StreamHandler` with a default :class:`Formatter` and adding it to the |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 777 | root logger. The functions :func:`debug`, :func:`info`, :func:`warning`, |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 778 | :func:`error` and :func:`critical` will call :func:`basicConfig` automatically |
| 779 | if no handlers are defined for the root logger. |
| 780 | |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 781 | This function does nothing if the root logger already has handlers |
| 782 | configured for it. |
| 783 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 784 | The following keyword arguments are supported. |
| 785 | |
| 786 | +--------------+---------------------------------------------+ |
| 787 | | Format | Description | |
| 788 | +==============+=============================================+ |
| 789 | | ``filename`` | Specifies that a FileHandler be created, | |
| 790 | | | using the specified filename, rather than a | |
| 791 | | | StreamHandler. | |
| 792 | +--------------+---------------------------------------------+ |
| 793 | | ``filemode`` | Specifies the mode to open the file, if | |
| 794 | | | filename is specified (if filemode is | |
| 795 | | | unspecified, it defaults to 'a'). | |
| 796 | +--------------+---------------------------------------------+ |
| 797 | | ``format`` | Use the specified format string for the | |
| 798 | | | handler. | |
| 799 | +--------------+---------------------------------------------+ |
| 800 | | ``datefmt`` | Use the specified date/time format. | |
| 801 | +--------------+---------------------------------------------+ |
| 802 | | ``level`` | Set the root logger level to the specified | |
| 803 | | | level. | |
| 804 | +--------------+---------------------------------------------+ |
| 805 | | ``stream`` | Use the specified stream to initialize the | |
| 806 | | | StreamHandler. Note that this argument is | |
| 807 | | | incompatible with 'filename' - if both are | |
| 808 | | | present, 'stream' is ignored. | |
| 809 | +--------------+---------------------------------------------+ |
| 810 | |
| 811 | |
| 812 | .. function:: shutdown() |
| 813 | |
| 814 | Informs the logging system to perform an orderly shutdown by flushing and |
Christian Heimes | b186d00 | 2008-03-18 15:15:01 +0000 | [diff] [blame] | 815 | closing all handlers. This should be called at application exit and no |
| 816 | further use of the logging system should be made after this call. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 817 | |
| 818 | |
| 819 | .. function:: setLoggerClass(klass) |
| 820 | |
| 821 | Tells the logging system to use the class *klass* when instantiating a logger. |
| 822 | The class should define :meth:`__init__` such that only a name argument is |
| 823 | required, and the :meth:`__init__` should call :meth:`Logger.__init__`. This |
| 824 | function is typically called before any loggers are instantiated by applications |
| 825 | which need to use custom logger behavior. |
| 826 | |
| 827 | |
| 828 | .. seealso:: |
| 829 | |
| 830 | :pep:`282` - A Logging System |
| 831 | The proposal which described this feature for inclusion in the Python standard |
| 832 | library. |
| 833 | |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 834 | `Original Python logging package <http://www.red-dove.com/python_logging.html>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 835 | This is the original source for the :mod:`logging` package. The version of the |
| 836 | package available from this site is suitable for use with Python 1.5.2, 2.1.x |
| 837 | and 2.2.x, which do not include the :mod:`logging` package in the standard |
| 838 | library. |
| 839 | |
| 840 | |
| 841 | Logger Objects |
| 842 | -------------- |
| 843 | |
| 844 | Loggers have the following attributes and methods. Note that Loggers are never |
| 845 | instantiated directly, but always through the module-level function |
| 846 | ``logging.getLogger(name)``. |
| 847 | |
| 848 | |
| 849 | .. attribute:: Logger.propagate |
| 850 | |
| 851 | If this evaluates to false, logging messages are not passed by this logger or by |
| 852 | child loggers to higher level (ancestor) loggers. The constructor sets this |
| 853 | attribute to 1. |
| 854 | |
| 855 | |
| 856 | .. method:: Logger.setLevel(lvl) |
| 857 | |
| 858 | Sets the threshold for this logger to *lvl*. Logging messages which are less |
| 859 | severe than *lvl* will be ignored. When a logger is created, the level is set to |
| 860 | :const:`NOTSET` (which causes all messages to be processed when the logger is |
| 861 | the root logger, or delegation to the parent when the logger is a non-root |
| 862 | logger). Note that the root logger is created with level :const:`WARNING`. |
| 863 | |
| 864 | The term "delegation to the parent" means that if a logger has a level of |
| 865 | NOTSET, its chain of ancestor loggers is traversed until either an ancestor with |
| 866 | a level other than NOTSET is found, or the root is reached. |
| 867 | |
| 868 | If an ancestor is found with a level other than NOTSET, then that ancestor's |
| 869 | level is treated as the effective level of the logger where the ancestor search |
| 870 | began, and is used to determine how a logging event is handled. |
| 871 | |
| 872 | If the root is reached, and it has a level of NOTSET, then all messages will be |
| 873 | processed. Otherwise, the root's level will be used as the effective level. |
| 874 | |
| 875 | |
| 876 | .. method:: Logger.isEnabledFor(lvl) |
| 877 | |
| 878 | Indicates if a message of severity *lvl* would be processed by this logger. |
| 879 | This method checks first the module-level level set by |
| 880 | ``logging.disable(lvl)`` and then the logger's effective level as determined |
| 881 | by :meth:`getEffectiveLevel`. |
| 882 | |
| 883 | |
| 884 | .. method:: Logger.getEffectiveLevel() |
| 885 | |
| 886 | Indicates the effective level for this logger. If a value other than |
| 887 | :const:`NOTSET` has been set using :meth:`setLevel`, it is returned. Otherwise, |
| 888 | the hierarchy is traversed towards the root until a value other than |
| 889 | :const:`NOTSET` is found, and that value is returned. |
| 890 | |
| 891 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 892 | .. method:: Logger.debug(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 893 | |
| 894 | Logs a message with level :const:`DEBUG` on this logger. The *msg* is the |
| 895 | message format string, and the *args* are the arguments which are merged into |
| 896 | *msg* using the string formatting operator. (Note that this means that you can |
| 897 | use keywords in the format string, together with a single dictionary argument.) |
| 898 | |
| 899 | There are two keyword arguments in *kwargs* which are inspected: *exc_info* |
| 900 | which, if it does not evaluate as false, causes exception information to be |
| 901 | added to the logging message. If an exception tuple (in the format returned by |
| 902 | :func:`sys.exc_info`) is provided, it is used; otherwise, :func:`sys.exc_info` |
| 903 | is called to get the exception information. |
| 904 | |
| 905 | The other optional keyword argument is *extra* which can be used to pass a |
| 906 | dictionary which is used to populate the __dict__ of the LogRecord created for |
| 907 | the logging event with user-defined attributes. These custom attributes can then |
| 908 | be used as you like. For example, they could be incorporated into logged |
| 909 | messages. For example:: |
| 910 | |
| 911 | FORMAT = "%(asctime)-15s %(clientip)s %(user)-8s %(message)s" |
| 912 | logging.basicConfig(format=FORMAT) |
Georg Brandl | 9afde1c | 2007-11-01 20:32:30 +0000 | [diff] [blame] | 913 | d = { 'clientip' : '192.168.0.1', 'user' : 'fbloggs' } |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 914 | logger = logging.getLogger("tcpserver") |
| 915 | logger.warning("Protocol problem: %s", "connection reset", extra=d) |
| 916 | |
| 917 | would print something like :: |
| 918 | |
| 919 | 2006-02-08 22:20:02,165 192.168.0.1 fbloggs Protocol problem: connection reset |
| 920 | |
| 921 | The keys in the dictionary passed in *extra* should not clash with the keys used |
| 922 | by the logging system. (See the :class:`Formatter` documentation for more |
| 923 | information on which keys are used by the logging system.) |
| 924 | |
| 925 | If you choose to use these attributes in logged messages, you need to exercise |
| 926 | some care. In the above example, for instance, the :class:`Formatter` has been |
| 927 | set up with a format string which expects 'clientip' and 'user' in the attribute |
| 928 | dictionary of the LogRecord. If these are missing, the message will not be |
| 929 | logged because a string formatting exception will occur. So in this case, you |
| 930 | always need to pass the *extra* dictionary with these keys. |
| 931 | |
| 932 | While this might be annoying, this feature is intended for use in specialized |
| 933 | circumstances, such as multi-threaded servers where the same code executes in |
| 934 | many contexts, and interesting conditions which arise are dependent on this |
| 935 | context (such as remote client IP address and authenticated user name, in the |
| 936 | above example). In such circumstances, it is likely that specialized |
| 937 | :class:`Formatter`\ s would be used with particular :class:`Handler`\ s. |
| 938 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 939 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 940 | .. method:: Logger.info(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 941 | |
| 942 | Logs a message with level :const:`INFO` on this logger. The arguments are |
| 943 | interpreted as for :meth:`debug`. |
| 944 | |
| 945 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 946 | .. method:: Logger.warning(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 947 | |
| 948 | Logs a message with level :const:`WARNING` on this logger. The arguments are |
| 949 | interpreted as for :meth:`debug`. |
| 950 | |
| 951 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 952 | .. method:: Logger.error(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 953 | |
| 954 | Logs a message with level :const:`ERROR` on this logger. The arguments are |
| 955 | interpreted as for :meth:`debug`. |
| 956 | |
| 957 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 958 | .. method:: Logger.critical(msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 959 | |
| 960 | Logs a message with level :const:`CRITICAL` on this logger. The arguments are |
| 961 | interpreted as for :meth:`debug`. |
| 962 | |
| 963 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 964 | .. method:: Logger.log(lvl, msg, *args, **kwargs) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 965 | |
| 966 | Logs a message with integer level *lvl* on this logger. The other arguments are |
| 967 | interpreted as for :meth:`debug`. |
| 968 | |
| 969 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 970 | .. method:: Logger.exception(msg, *args) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 971 | |
| 972 | Logs a message with level :const:`ERROR` on this logger. The arguments are |
| 973 | interpreted as for :meth:`debug`. Exception info is added to the logging |
| 974 | message. This method should only be called from an exception handler. |
| 975 | |
| 976 | |
| 977 | .. method:: Logger.addFilter(filt) |
| 978 | |
| 979 | Adds the specified filter *filt* to this logger. |
| 980 | |
| 981 | |
| 982 | .. method:: Logger.removeFilter(filt) |
| 983 | |
| 984 | Removes the specified filter *filt* from this logger. |
| 985 | |
| 986 | |
| 987 | .. method:: Logger.filter(record) |
| 988 | |
| 989 | Applies this logger's filters to the record and returns a true value if the |
| 990 | record is to be processed. |
| 991 | |
| 992 | |
| 993 | .. method:: Logger.addHandler(hdlr) |
| 994 | |
| 995 | Adds the specified handler *hdlr* to this logger. |
| 996 | |
| 997 | |
| 998 | .. method:: Logger.removeHandler(hdlr) |
| 999 | |
| 1000 | Removes the specified handler *hdlr* from this logger. |
| 1001 | |
| 1002 | |
| 1003 | .. method:: Logger.findCaller() |
| 1004 | |
| 1005 | Finds the caller's source filename and line number. Returns the filename, line |
| 1006 | number and function name as a 3-element tuple. |
| 1007 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1008 | |
| 1009 | .. method:: Logger.handle(record) |
| 1010 | |
| 1011 | Handles a record by passing it to all handlers associated with this logger and |
| 1012 | its ancestors (until a false value of *propagate* is found). This method is used |
| 1013 | for unpickled records received from a socket, as well as those created locally. |
Georg Brandl | 502d9a5 | 2009-07-26 15:02:41 +0000 | [diff] [blame] | 1014 | Logger-level filtering is applied using :meth:`~Logger.filter`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1015 | |
| 1016 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1017 | .. method:: Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info, func=None, extra=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1018 | |
| 1019 | This is a factory method which can be overridden in subclasses to create |
| 1020 | specialized :class:`LogRecord` instances. |
| 1021 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1022 | |
| 1023 | .. _minimal-example: |
| 1024 | |
| 1025 | Basic example |
| 1026 | ------------- |
| 1027 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1028 | The :mod:`logging` package provides a lot of flexibility, and its configuration |
| 1029 | can appear daunting. This section demonstrates that simple use of the logging |
| 1030 | package is possible. |
| 1031 | |
| 1032 | The simplest example shows logging to the console:: |
| 1033 | |
| 1034 | import logging |
| 1035 | |
| 1036 | logging.debug('A debug message') |
| 1037 | logging.info('Some information') |
| 1038 | logging.warning('A shot across the bows') |
| 1039 | |
| 1040 | If you run the above script, you'll see this:: |
| 1041 | |
| 1042 | WARNING:root:A shot across the bows |
| 1043 | |
| 1044 | Because no particular logger was specified, the system used the root logger. The |
| 1045 | debug and info messages didn't appear because by default, the root logger is |
| 1046 | configured to only handle messages with a severity of WARNING or above. The |
| 1047 | message format is also a configuration default, as is the output destination of |
| 1048 | the messages - ``sys.stderr``. The severity level, the message format and |
| 1049 | destination can be easily changed, as shown in the example below:: |
| 1050 | |
| 1051 | import logging |
| 1052 | |
| 1053 | logging.basicConfig(level=logging.DEBUG, |
| 1054 | format='%(asctime)s %(levelname)s %(message)s', |
| 1055 | filename='/tmp/myapp.log', |
| 1056 | filemode='w') |
| 1057 | logging.debug('A debug message') |
| 1058 | logging.info('Some information') |
| 1059 | logging.warning('A shot across the bows') |
| 1060 | |
| 1061 | The :meth:`basicConfig` method is used to change the configuration defaults, |
| 1062 | which results in output (written to ``/tmp/myapp.log``) which should look |
| 1063 | something like the following:: |
| 1064 | |
| 1065 | 2004-07-02 13:00:08,743 DEBUG A debug message |
| 1066 | 2004-07-02 13:00:08,743 INFO Some information |
| 1067 | 2004-07-02 13:00:08,743 WARNING A shot across the bows |
| 1068 | |
| 1069 | This time, all messages with a severity of DEBUG or above were handled, and the |
| 1070 | format of the messages was also changed, and output went to the specified file |
| 1071 | rather than the console. |
| 1072 | |
Georg Brandl | 81ac1ce | 2007-08-31 17:17:17 +0000 | [diff] [blame] | 1073 | .. XXX logging should probably be updated for new string formatting! |
Georg Brandl | 4b49131 | 2007-08-31 09:22:56 +0000 | [diff] [blame] | 1074 | |
| 1075 | Formatting uses the old Python string formatting - see section |
| 1076 | :ref:`old-string-formatting`. The format string takes the following common |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1077 | specifiers. For a complete list of specifiers, consult the :class:`Formatter` |
| 1078 | documentation. |
| 1079 | |
| 1080 | +-------------------+-----------------------------------------------+ |
| 1081 | | Format | Description | |
| 1082 | +===================+===============================================+ |
| 1083 | | ``%(name)s`` | Name of the logger (logging channel). | |
| 1084 | +-------------------+-----------------------------------------------+ |
| 1085 | | ``%(levelname)s`` | Text logging level for the message | |
| 1086 | | | (``'DEBUG'``, ``'INFO'``, ``'WARNING'``, | |
| 1087 | | | ``'ERROR'``, ``'CRITICAL'``). | |
| 1088 | +-------------------+-----------------------------------------------+ |
| 1089 | | ``%(asctime)s`` | Human-readable time when the | |
| 1090 | | | :class:`LogRecord` was created. By default | |
| 1091 | | | this is of the form "2003-07-08 16:49:45,896" | |
| 1092 | | | (the numbers after the comma are millisecond | |
| 1093 | | | portion of the time). | |
| 1094 | +-------------------+-----------------------------------------------+ |
| 1095 | | ``%(message)s`` | The logged message. | |
| 1096 | +-------------------+-----------------------------------------------+ |
| 1097 | |
| 1098 | To change the date/time format, you can pass an additional keyword parameter, |
| 1099 | *datefmt*, as in the following:: |
| 1100 | |
| 1101 | import logging |
| 1102 | |
| 1103 | logging.basicConfig(level=logging.DEBUG, |
| 1104 | format='%(asctime)s %(levelname)-8s %(message)s', |
| 1105 | datefmt='%a, %d %b %Y %H:%M:%S', |
| 1106 | filename='/temp/myapp.log', |
| 1107 | filemode='w') |
| 1108 | logging.debug('A debug message') |
| 1109 | logging.info('Some information') |
| 1110 | logging.warning('A shot across the bows') |
| 1111 | |
| 1112 | which would result in output like :: |
| 1113 | |
| 1114 | Fri, 02 Jul 2004 13:06:18 DEBUG A debug message |
| 1115 | Fri, 02 Jul 2004 13:06:18 INFO Some information |
| 1116 | Fri, 02 Jul 2004 13:06:18 WARNING A shot across the bows |
| 1117 | |
| 1118 | The date format string follows the requirements of :func:`strftime` - see the |
| 1119 | documentation for the :mod:`time` module. |
| 1120 | |
| 1121 | If, instead of sending logging output to the console or a file, you'd rather use |
| 1122 | a file-like object which you have created separately, you can pass it to |
| 1123 | :func:`basicConfig` using the *stream* keyword argument. Note that if both |
| 1124 | *stream* and *filename* keyword arguments are passed, the *stream* argument is |
| 1125 | ignored. |
| 1126 | |
| 1127 | Of course, you can put variable information in your output. To do this, simply |
| 1128 | have the message be a format string and pass in additional arguments containing |
| 1129 | the variable information, as in the following example:: |
| 1130 | |
| 1131 | import logging |
| 1132 | |
| 1133 | logging.basicConfig(level=logging.DEBUG, |
| 1134 | format='%(asctime)s %(levelname)-8s %(message)s', |
| 1135 | datefmt='%a, %d %b %Y %H:%M:%S', |
| 1136 | filename='/temp/myapp.log', |
| 1137 | filemode='w') |
| 1138 | logging.error('Pack my box with %d dozen %s', 5, 'liquor jugs') |
| 1139 | |
| 1140 | which would result in :: |
| 1141 | |
| 1142 | Wed, 21 Jul 2004 15:35:16 ERROR Pack my box with 5 dozen liquor jugs |
| 1143 | |
| 1144 | |
| 1145 | .. _multiple-destinations: |
| 1146 | |
| 1147 | Logging to multiple destinations |
| 1148 | -------------------------------- |
| 1149 | |
| 1150 | Let's say you want to log to console and file with different message formats and |
| 1151 | in differing circumstances. Say you want to log messages with levels of DEBUG |
| 1152 | and higher to file, and those messages at level INFO and higher to the console. |
| 1153 | Let's also assume that the file should contain timestamps, but the console |
| 1154 | messages should not. Here's how you can achieve this:: |
| 1155 | |
| 1156 | import logging |
| 1157 | |
| 1158 | # set up logging to file - see previous section for more details |
| 1159 | logging.basicConfig(level=logging.DEBUG, |
| 1160 | format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s', |
| 1161 | datefmt='%m-%d %H:%M', |
| 1162 | filename='/temp/myapp.log', |
| 1163 | filemode='w') |
| 1164 | # define a Handler which writes INFO messages or higher to the sys.stderr |
| 1165 | console = logging.StreamHandler() |
| 1166 | console.setLevel(logging.INFO) |
| 1167 | # set a format which is simpler for console use |
| 1168 | formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s') |
| 1169 | # tell the handler to use this format |
| 1170 | console.setFormatter(formatter) |
| 1171 | # add the handler to the root logger |
| 1172 | logging.getLogger('').addHandler(console) |
| 1173 | |
| 1174 | # Now, we can log to the root logger, or any other logger. First the root... |
| 1175 | logging.info('Jackdaws love my big sphinx of quartz.') |
| 1176 | |
| 1177 | # Now, define a couple of other loggers which might represent areas in your |
| 1178 | # application: |
| 1179 | |
| 1180 | logger1 = logging.getLogger('myapp.area1') |
| 1181 | logger2 = logging.getLogger('myapp.area2') |
| 1182 | |
| 1183 | logger1.debug('Quick zephyrs blow, vexing daft Jim.') |
| 1184 | logger1.info('How quickly daft jumping zebras vex.') |
| 1185 | logger2.warning('Jail zesty vixen who grabbed pay from quack.') |
| 1186 | logger2.error('The five boxing wizards jump quickly.') |
| 1187 | |
| 1188 | When you run this, on the console you will see :: |
| 1189 | |
| 1190 | root : INFO Jackdaws love my big sphinx of quartz. |
| 1191 | myapp.area1 : INFO How quickly daft jumping zebras vex. |
| 1192 | myapp.area2 : WARNING Jail zesty vixen who grabbed pay from quack. |
| 1193 | myapp.area2 : ERROR The five boxing wizards jump quickly. |
| 1194 | |
| 1195 | and in the file you will see something like :: |
| 1196 | |
| 1197 | 10-22 22:19 root INFO Jackdaws love my big sphinx of quartz. |
| 1198 | 10-22 22:19 myapp.area1 DEBUG Quick zephyrs blow, vexing daft Jim. |
| 1199 | 10-22 22:19 myapp.area1 INFO How quickly daft jumping zebras vex. |
| 1200 | 10-22 22:19 myapp.area2 WARNING Jail zesty vixen who grabbed pay from quack. |
| 1201 | 10-22 22:19 myapp.area2 ERROR The five boxing wizards jump quickly. |
| 1202 | |
| 1203 | As you can see, the DEBUG message only shows up in the file. The other messages |
| 1204 | are sent to both destinations. |
| 1205 | |
| 1206 | This example uses console and file handlers, but you can use any number and |
| 1207 | combination of handlers you choose. |
| 1208 | |
Vinay Sajip | 3ee22ec | 2009-08-20 22:05:10 +0000 | [diff] [blame] | 1209 | .. _logging-exceptions: |
| 1210 | |
| 1211 | Exceptions raised during logging |
| 1212 | -------------------------------- |
| 1213 | |
| 1214 | The logging package is designed to swallow exceptions which occur while logging |
| 1215 | in production. This is so that errors which occur while handling logging events |
| 1216 | - such as logging misconfiguration, network or other similar errors - do not |
| 1217 | cause the application using logging to terminate prematurely. |
| 1218 | |
| 1219 | :class:`SystemExit` and :class:`KeyboardInterrupt` exceptions are never |
| 1220 | swallowed. Other exceptions which occur during the :meth:`emit` method of a |
| 1221 | :class:`Handler` subclass are passed to its :meth:`handleError` method. |
| 1222 | |
| 1223 | The default implementation of :meth:`handleError` in :class:`Handler` checks |
Georg Brandl | ef871f6 | 2010-03-12 10:06:40 +0000 | [diff] [blame] | 1224 | to see if a module-level variable, :data:`raiseExceptions`, is set. If set, a |
| 1225 | traceback is printed to :data:`sys.stderr`. If not set, the exception is swallowed. |
Vinay Sajip | 3ee22ec | 2009-08-20 22:05:10 +0000 | [diff] [blame] | 1226 | |
Georg Brandl | ef871f6 | 2010-03-12 10:06:40 +0000 | [diff] [blame] | 1227 | **Note:** The default value of :data:`raiseExceptions` is ``True``. This is because |
Vinay Sajip | 3ee22ec | 2009-08-20 22:05:10 +0000 | [diff] [blame] | 1228 | during development, you typically want to be notified of any exceptions that |
Georg Brandl | ef871f6 | 2010-03-12 10:06:40 +0000 | [diff] [blame] | 1229 | occur. It's advised that you set :data:`raiseExceptions` to ``False`` for production |
Vinay Sajip | 3ee22ec | 2009-08-20 22:05:10 +0000 | [diff] [blame] | 1230 | usage. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1231 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1232 | .. _context-info: |
| 1233 | |
| 1234 | Adding contextual information to your logging output |
| 1235 | ---------------------------------------------------- |
| 1236 | |
| 1237 | Sometimes you want logging output to contain contextual information in |
| 1238 | addition to the parameters passed to the logging call. For example, in a |
| 1239 | networked application, it may be desirable to log client-specific information |
| 1240 | in the log (e.g. remote client's username, or IP address). Although you could |
| 1241 | use the *extra* parameter to achieve this, it's not always convenient to pass |
| 1242 | the information in this way. While it might be tempting to create |
| 1243 | :class:`Logger` instances on a per-connection basis, this is not a good idea |
| 1244 | because these instances are not garbage collected. While this is not a problem |
| 1245 | in practice, when the number of :class:`Logger` instances is dependent on the |
| 1246 | level of granularity you want to use in logging an application, it could |
| 1247 | be hard to manage if the number of :class:`Logger` instances becomes |
| 1248 | effectively unbounded. |
| 1249 | |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 1250 | An easy way in which you can pass contextual information to be output along |
| 1251 | with logging event information is to use the :class:`LoggerAdapter` class. |
| 1252 | This class is designed to look like a :class:`Logger`, so that you can call |
| 1253 | :meth:`debug`, :meth:`info`, :meth:`warning`, :meth:`error`, |
| 1254 | :meth:`exception`, :meth:`critical` and :meth:`log`. These methods have the |
| 1255 | same signatures as their counterparts in :class:`Logger`, so you can use the |
| 1256 | two types of instances interchangeably. |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1257 | |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 1258 | When you create an instance of :class:`LoggerAdapter`, you pass it a |
| 1259 | :class:`Logger` instance and a dict-like object which contains your contextual |
| 1260 | information. When you call one of the logging methods on an instance of |
| 1261 | :class:`LoggerAdapter`, it delegates the call to the underlying instance of |
| 1262 | :class:`Logger` passed to its constructor, and arranges to pass the contextual |
| 1263 | information in the delegated call. Here's a snippet from the code of |
| 1264 | :class:`LoggerAdapter`:: |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1265 | |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 1266 | def debug(self, msg, *args, **kwargs): |
| 1267 | """ |
| 1268 | Delegate a debug call to the underlying logger, after adding |
| 1269 | contextual information from this adapter instance. |
| 1270 | """ |
| 1271 | msg, kwargs = self.process(msg, kwargs) |
| 1272 | self.logger.debug(msg, *args, **kwargs) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1273 | |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 1274 | The :meth:`process` method of :class:`LoggerAdapter` is where the contextual |
| 1275 | information is added to the logging output. It's passed the message and |
| 1276 | keyword arguments of the logging call, and it passes back (potentially) |
| 1277 | modified versions of these to use in the call to the underlying logger. The |
| 1278 | default implementation of this method leaves the message alone, but inserts |
| 1279 | an "extra" key in the keyword argument whose value is the dict-like object |
| 1280 | passed to the constructor. Of course, if you had passed an "extra" keyword |
| 1281 | argument in the call to the adapter, it will be silently overwritten. |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1282 | |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 1283 | The advantage of using "extra" is that the values in the dict-like object are |
| 1284 | merged into the :class:`LogRecord` instance's __dict__, allowing you to use |
| 1285 | customized strings with your :class:`Formatter` instances which know about |
| 1286 | the keys of the dict-like object. If you need a different method, e.g. if you |
| 1287 | want to prepend or append the contextual information to the message string, |
| 1288 | you just need to subclass :class:`LoggerAdapter` and override :meth:`process` |
| 1289 | to do what you need. Here's an example script which uses this class, which |
| 1290 | also illustrates what dict-like behaviour is needed from an arbitrary |
| 1291 | "dict-like" object for use in the constructor:: |
| 1292 | |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 1293 | import logging |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 1294 | |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 1295 | class ConnInfo: |
| 1296 | """ |
| 1297 | An example class which shows how an arbitrary class can be used as |
| 1298 | the 'extra' context information repository passed to a LoggerAdapter. |
| 1299 | """ |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 1300 | |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 1301 | def __getitem__(self, name): |
| 1302 | """ |
| 1303 | To allow this instance to look like a dict. |
| 1304 | """ |
| 1305 | from random import choice |
| 1306 | if name == "ip": |
| 1307 | result = choice(["127.0.0.1", "192.168.0.1"]) |
| 1308 | elif name == "user": |
| 1309 | result = choice(["jim", "fred", "sheila"]) |
| 1310 | else: |
| 1311 | result = self.__dict__.get(name, "?") |
| 1312 | return result |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 1313 | |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 1314 | def __iter__(self): |
| 1315 | """ |
| 1316 | To allow iteration over keys, which will be merged into |
| 1317 | the LogRecord dict before formatting and output. |
| 1318 | """ |
| 1319 | keys = ["ip", "user"] |
| 1320 | keys.extend(self.__dict__.keys()) |
| 1321 | return keys.__iter__() |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 1322 | |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 1323 | if __name__ == "__main__": |
| 1324 | from random import choice |
| 1325 | levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL) |
| 1326 | a1 = logging.LoggerAdapter(logging.getLogger("a.b.c"), |
| 1327 | { "ip" : "123.231.231.123", "user" : "sheila" }) |
| 1328 | logging.basicConfig(level=logging.DEBUG, |
| 1329 | format="%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s") |
| 1330 | a1.debug("A debug message") |
| 1331 | a1.info("An info message with %s", "some parameters") |
| 1332 | a2 = logging.LoggerAdapter(logging.getLogger("d.e.f"), ConnInfo()) |
| 1333 | for x in range(10): |
| 1334 | lvl = choice(levels) |
| 1335 | lvlname = logging.getLevelName(lvl) |
| 1336 | a2.log(lvl, "A message at %s level with %d %s", lvlname, 2, "parameters") |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 1337 | |
| 1338 | When this script is run, the output should look something like this:: |
| 1339 | |
Christian Heimes | 587c2bf | 2008-01-19 16:21:02 +0000 | [diff] [blame] | 1340 | 2008-01-18 14:49:54,023 a.b.c DEBUG IP: 123.231.231.123 User: sheila A debug message |
| 1341 | 2008-01-18 14:49:54,023 a.b.c INFO IP: 123.231.231.123 User: sheila An info message with some parameters |
| 1342 | 2008-01-18 14:49:54,023 d.e.f CRITICAL IP: 192.168.0.1 User: jim A message at CRITICAL level with 2 parameters |
| 1343 | 2008-01-18 14:49:54,033 d.e.f INFO IP: 192.168.0.1 User: jim A message at INFO level with 2 parameters |
| 1344 | 2008-01-18 14:49:54,033 d.e.f WARNING IP: 192.168.0.1 User: sheila A message at WARNING level with 2 parameters |
| 1345 | 2008-01-18 14:49:54,033 d.e.f ERROR IP: 127.0.0.1 User: fred A message at ERROR level with 2 parameters |
| 1346 | 2008-01-18 14:49:54,033 d.e.f ERROR IP: 127.0.0.1 User: sheila A message at ERROR level with 2 parameters |
| 1347 | 2008-01-18 14:49:54,033 d.e.f WARNING IP: 192.168.0.1 User: sheila A message at WARNING level with 2 parameters |
| 1348 | 2008-01-18 14:49:54,033 d.e.f WARNING IP: 192.168.0.1 User: jim A message at WARNING level with 2 parameters |
| 1349 | 2008-01-18 14:49:54,033 d.e.f INFO IP: 192.168.0.1 User: fred A message at INFO level with 2 parameters |
| 1350 | 2008-01-18 14:49:54,033 d.e.f WARNING IP: 192.168.0.1 User: sheila A message at WARNING level with 2 parameters |
| 1351 | 2008-01-18 14:49:54,033 d.e.f WARNING IP: 127.0.0.1 User: jim A message at WARNING level with 2 parameters |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 1352 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 1353 | |
Vinay Sajip | a7471bf | 2009-08-15 23:23:37 +0000 | [diff] [blame] | 1354 | Logging to a single file from multiple processes |
| 1355 | ------------------------------------------------ |
| 1356 | |
| 1357 | Although logging is thread-safe, and logging to a single file from multiple |
| 1358 | threads in a single process *is* supported, logging to a single file from |
| 1359 | *multiple processes* is *not* supported, because there is no standard way to |
| 1360 | serialize access to a single file across multiple processes in Python. If you |
| 1361 | need to log to a single file from multiple processes, the best way of doing |
| 1362 | this is to have all the processes log to a :class:`SocketHandler`, and have a |
| 1363 | separate process which implements a socket server which reads from the socket |
| 1364 | and logs to file. (If you prefer, you can dedicate one thread in one of the |
| 1365 | existing processes to perform this function.) The following section documents |
| 1366 | this approach in more detail and includes a working socket receiver which can |
| 1367 | be used as a starting point for you to adapt in your own applications. |
| 1368 | |
Vinay Sajip | 5a92b13 | 2009-08-15 23:35:08 +0000 | [diff] [blame] | 1369 | If you are using a recent version of Python which includes the |
| 1370 | :mod:`multiprocessing` module, you can write your own handler which uses the |
| 1371 | :class:`Lock` class from this module to serialize access to the file from |
| 1372 | your processes. The existing :class:`FileHandler` and subclasses do not make |
| 1373 | use of :mod:`multiprocessing` at present, though they may do so in the future. |
Vinay Sajip | 8c6b0a5 | 2009-08-17 13:17:47 +0000 | [diff] [blame] | 1374 | Note that at present, the :mod:`multiprocessing` module does not provide |
| 1375 | working lock functionality on all platforms (see |
| 1376 | http://bugs.python.org/issue3770). |
Vinay Sajip | 5a92b13 | 2009-08-15 23:35:08 +0000 | [diff] [blame] | 1377 | |
Benjamin Peterson | 8719ad5 | 2009-09-11 22:24:02 +0000 | [diff] [blame] | 1378 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1379 | .. _network-logging: |
| 1380 | |
| 1381 | Sending and receiving logging events across a network |
| 1382 | ----------------------------------------------------- |
| 1383 | |
| 1384 | Let's say you want to send logging events across a network, and handle them at |
| 1385 | the receiving end. A simple way of doing this is attaching a |
| 1386 | :class:`SocketHandler` instance to the root logger at the sending end:: |
| 1387 | |
| 1388 | import logging, logging.handlers |
| 1389 | |
| 1390 | rootLogger = logging.getLogger('') |
| 1391 | rootLogger.setLevel(logging.DEBUG) |
| 1392 | socketHandler = logging.handlers.SocketHandler('localhost', |
| 1393 | logging.handlers.DEFAULT_TCP_LOGGING_PORT) |
| 1394 | # don't bother with a formatter, since a socket handler sends the event as |
| 1395 | # an unformatted pickle |
| 1396 | rootLogger.addHandler(socketHandler) |
| 1397 | |
| 1398 | # Now, we can log to the root logger, or any other logger. First the root... |
| 1399 | logging.info('Jackdaws love my big sphinx of quartz.') |
| 1400 | |
| 1401 | # Now, define a couple of other loggers which might represent areas in your |
| 1402 | # application: |
| 1403 | |
| 1404 | logger1 = logging.getLogger('myapp.area1') |
| 1405 | logger2 = logging.getLogger('myapp.area2') |
| 1406 | |
| 1407 | logger1.debug('Quick zephyrs blow, vexing daft Jim.') |
| 1408 | logger1.info('How quickly daft jumping zebras vex.') |
| 1409 | logger2.warning('Jail zesty vixen who grabbed pay from quack.') |
| 1410 | logger2.error('The five boxing wizards jump quickly.') |
| 1411 | |
Alexandre Vassalotti | ce26195 | 2008-05-12 02:31:37 +0000 | [diff] [blame] | 1412 | At the receiving end, you can set up a receiver using the :mod:`socketserver` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1413 | module. Here is a basic working example:: |
| 1414 | |
Georg Brandl | a35f4b9 | 2009-05-31 16:41:59 +0000 | [diff] [blame] | 1415 | import pickle |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1416 | import logging |
| 1417 | import logging.handlers |
Alexandre Vassalotti | ce26195 | 2008-05-12 02:31:37 +0000 | [diff] [blame] | 1418 | import socketserver |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1419 | import struct |
| 1420 | |
| 1421 | |
Alexandre Vassalotti | ce26195 | 2008-05-12 02:31:37 +0000 | [diff] [blame] | 1422 | class LogRecordStreamHandler(socketserver.StreamRequestHandler): |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1423 | """Handler for a streaming logging request. |
| 1424 | |
| 1425 | This basically logs the record using whatever logging policy is |
| 1426 | configured locally. |
| 1427 | """ |
| 1428 | |
| 1429 | def handle(self): |
| 1430 | """ |
| 1431 | Handle multiple requests - each expected to be a 4-byte length, |
| 1432 | followed by the LogRecord in pickle format. Logs the record |
| 1433 | according to whatever policy is configured locally. |
| 1434 | """ |
Collin Winter | 4633448 | 2007-09-10 00:49:57 +0000 | [diff] [blame] | 1435 | while True: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1436 | chunk = self.connection.recv(4) |
| 1437 | if len(chunk) < 4: |
| 1438 | break |
| 1439 | slen = struct.unpack(">L", chunk)[0] |
| 1440 | chunk = self.connection.recv(slen) |
| 1441 | while len(chunk) < slen: |
| 1442 | chunk = chunk + self.connection.recv(slen - len(chunk)) |
| 1443 | obj = self.unPickle(chunk) |
| 1444 | record = logging.makeLogRecord(obj) |
| 1445 | self.handleLogRecord(record) |
| 1446 | |
| 1447 | def unPickle(self, data): |
Georg Brandl | a35f4b9 | 2009-05-31 16:41:59 +0000 | [diff] [blame] | 1448 | return pickle.loads(data) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1449 | |
| 1450 | def handleLogRecord(self, record): |
| 1451 | # if a name is specified, we use the named logger rather than the one |
| 1452 | # implied by the record. |
| 1453 | if self.server.logname is not None: |
| 1454 | name = self.server.logname |
| 1455 | else: |
| 1456 | name = record.name |
| 1457 | logger = logging.getLogger(name) |
| 1458 | # N.B. EVERY record gets logged. This is because Logger.handle |
| 1459 | # is normally called AFTER logger-level filtering. If you want |
| 1460 | # to do filtering, do it at the client end to save wasting |
| 1461 | # cycles and network bandwidth! |
| 1462 | logger.handle(record) |
| 1463 | |
Alexandre Vassalotti | ce26195 | 2008-05-12 02:31:37 +0000 | [diff] [blame] | 1464 | class LogRecordSocketReceiver(socketserver.ThreadingTCPServer): |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1465 | """simple TCP socket-based logging receiver suitable for testing. |
| 1466 | """ |
| 1467 | |
| 1468 | allow_reuse_address = 1 |
| 1469 | |
| 1470 | def __init__(self, host='localhost', |
| 1471 | port=logging.handlers.DEFAULT_TCP_LOGGING_PORT, |
| 1472 | handler=LogRecordStreamHandler): |
Alexandre Vassalotti | ce26195 | 2008-05-12 02:31:37 +0000 | [diff] [blame] | 1473 | socketserver.ThreadingTCPServer.__init__(self, (host, port), handler) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1474 | self.abort = 0 |
| 1475 | self.timeout = 1 |
| 1476 | self.logname = None |
| 1477 | |
| 1478 | def serve_until_stopped(self): |
| 1479 | import select |
| 1480 | abort = 0 |
| 1481 | while not abort: |
| 1482 | rd, wr, ex = select.select([self.socket.fileno()], |
| 1483 | [], [], |
| 1484 | self.timeout) |
| 1485 | if rd: |
| 1486 | self.handle_request() |
| 1487 | abort = self.abort |
| 1488 | |
| 1489 | def main(): |
| 1490 | logging.basicConfig( |
| 1491 | format="%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s") |
| 1492 | tcpserver = LogRecordSocketReceiver() |
Georg Brandl | 6911e3c | 2007-09-04 07:15:32 +0000 | [diff] [blame] | 1493 | print("About to start TCP server...") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1494 | tcpserver.serve_until_stopped() |
| 1495 | |
| 1496 | if __name__ == "__main__": |
| 1497 | main() |
| 1498 | |
| 1499 | First run the server, and then the client. On the client side, nothing is |
| 1500 | printed on the console; on the server side, you should see something like:: |
| 1501 | |
| 1502 | About to start TCP server... |
| 1503 | 59 root INFO Jackdaws love my big sphinx of quartz. |
| 1504 | 59 myapp.area1 DEBUG Quick zephyrs blow, vexing daft Jim. |
| 1505 | 69 myapp.area1 INFO How quickly daft jumping zebras vex. |
| 1506 | 69 myapp.area2 WARNING Jail zesty vixen who grabbed pay from quack. |
| 1507 | 69 myapp.area2 ERROR The five boxing wizards jump quickly. |
| 1508 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1509 | Using arbitrary objects as messages |
| 1510 | ----------------------------------- |
| 1511 | |
| 1512 | In the preceding sections and examples, it has been assumed that the message |
| 1513 | passed when logging the event is a string. However, this is not the only |
| 1514 | possibility. You can pass an arbitrary object as a message, and its |
| 1515 | :meth:`__str__` method will be called when the logging system needs to convert |
| 1516 | it to a string representation. In fact, if you want to, you can avoid |
| 1517 | computing a string representation altogether - for example, the |
| 1518 | :class:`SocketHandler` emits an event by pickling it and sending it over the |
| 1519 | wire. |
| 1520 | |
| 1521 | Optimization |
| 1522 | ------------ |
| 1523 | |
| 1524 | Formatting of message arguments is deferred until it cannot be avoided. |
| 1525 | However, computing the arguments passed to the logging method can also be |
| 1526 | expensive, and you may want to avoid doing it if the logger will just throw |
| 1527 | away your event. To decide what to do, you can call the :meth:`isEnabledFor` |
| 1528 | method which takes a level argument and returns true if the event would be |
| 1529 | created by the Logger for that level of call. You can write code like this:: |
| 1530 | |
| 1531 | if logger.isEnabledFor(logging.DEBUG): |
| 1532 | logger.debug("Message with %s, %s", expensive_func1(), |
| 1533 | expensive_func2()) |
| 1534 | |
| 1535 | so that if the logger's threshold is set above ``DEBUG``, the calls to |
| 1536 | :func:`expensive_func1` and :func:`expensive_func2` are never made. |
| 1537 | |
| 1538 | There are other optimizations which can be made for specific applications which |
| 1539 | need more precise control over what logging information is collected. Here's a |
| 1540 | list of things you can do to avoid processing during logging which you don't |
| 1541 | need: |
| 1542 | |
| 1543 | +-----------------------------------------------+----------------------------------------+ |
| 1544 | | What you don't want to collect | How to avoid collecting it | |
| 1545 | +===============================================+========================================+ |
| 1546 | | Information about where calls were made from. | Set ``logging._srcfile`` to ``None``. | |
| 1547 | +-----------------------------------------------+----------------------------------------+ |
| 1548 | | Threading information. | Set ``logging.logThreads`` to ``0``. | |
| 1549 | +-----------------------------------------------+----------------------------------------+ |
| 1550 | | Process information. | Set ``logging.logProcesses`` to ``0``. | |
| 1551 | +-----------------------------------------------+----------------------------------------+ |
| 1552 | |
| 1553 | Also note that the core logging module only includes the basic handlers. If |
| 1554 | you don't import :mod:`logging.handlers` and :mod:`logging.config`, they won't |
| 1555 | take up any memory. |
| 1556 | |
| 1557 | .. _handler: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1558 | |
| 1559 | Handler Objects |
| 1560 | --------------- |
| 1561 | |
| 1562 | Handlers have the following attributes and methods. Note that :class:`Handler` |
| 1563 | is never instantiated directly; this class acts as a base for more useful |
| 1564 | subclasses. However, the :meth:`__init__` method in subclasses needs to call |
| 1565 | :meth:`Handler.__init__`. |
| 1566 | |
| 1567 | |
| 1568 | .. method:: Handler.__init__(level=NOTSET) |
| 1569 | |
| 1570 | Initializes the :class:`Handler` instance by setting its level, setting the list |
| 1571 | of filters to the empty list and creating a lock (using :meth:`createLock`) for |
| 1572 | serializing access to an I/O mechanism. |
| 1573 | |
| 1574 | |
| 1575 | .. method:: Handler.createLock() |
| 1576 | |
| 1577 | Initializes a thread lock which can be used to serialize access to underlying |
| 1578 | I/O functionality which may not be threadsafe. |
| 1579 | |
| 1580 | |
| 1581 | .. method:: Handler.acquire() |
| 1582 | |
| 1583 | Acquires the thread lock created with :meth:`createLock`. |
| 1584 | |
| 1585 | |
| 1586 | .. method:: Handler.release() |
| 1587 | |
| 1588 | Releases the thread lock acquired with :meth:`acquire`. |
| 1589 | |
| 1590 | |
| 1591 | .. method:: Handler.setLevel(lvl) |
| 1592 | |
| 1593 | Sets the threshold for this handler to *lvl*. Logging messages which are less |
| 1594 | severe than *lvl* will be ignored. When a handler is created, the level is set |
| 1595 | to :const:`NOTSET` (which causes all messages to be processed). |
| 1596 | |
| 1597 | |
| 1598 | .. method:: Handler.setFormatter(form) |
| 1599 | |
| 1600 | Sets the :class:`Formatter` for this handler to *form*. |
| 1601 | |
| 1602 | |
| 1603 | .. method:: Handler.addFilter(filt) |
| 1604 | |
| 1605 | Adds the specified filter *filt* to this handler. |
| 1606 | |
| 1607 | |
| 1608 | .. method:: Handler.removeFilter(filt) |
| 1609 | |
| 1610 | Removes the specified filter *filt* from this handler. |
| 1611 | |
| 1612 | |
| 1613 | .. method:: Handler.filter(record) |
| 1614 | |
| 1615 | Applies this handler's filters to the record and returns a true value if the |
| 1616 | record is to be processed. |
| 1617 | |
| 1618 | |
| 1619 | .. method:: Handler.flush() |
| 1620 | |
| 1621 | Ensure all logging output has been flushed. This version does nothing and is |
| 1622 | intended to be implemented by subclasses. |
| 1623 | |
| 1624 | |
| 1625 | .. method:: Handler.close() |
| 1626 | |
Benjamin Peterson | 3e4f055 | 2008-09-02 00:31:15 +0000 | [diff] [blame] | 1627 | Tidy up any resources used by the handler. This version does no output but |
| 1628 | removes the handler from an internal list of handlers which is closed when |
| 1629 | :func:`shutdown` is called. Subclasses should ensure that this gets called |
| 1630 | from overridden :meth:`close` methods. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1631 | |
| 1632 | |
| 1633 | .. method:: Handler.handle(record) |
| 1634 | |
| 1635 | Conditionally emits the specified logging record, depending on filters which may |
| 1636 | have been added to the handler. Wraps the actual emission of the record with |
| 1637 | acquisition/release of the I/O thread lock. |
| 1638 | |
| 1639 | |
| 1640 | .. method:: Handler.handleError(record) |
| 1641 | |
| 1642 | This method should be called from handlers when an exception is encountered |
| 1643 | during an :meth:`emit` call. By default it does nothing, which means that |
| 1644 | exceptions get silently ignored. This is what is mostly wanted for a logging |
| 1645 | system - most users will not care about errors in the logging system, they are |
| 1646 | more interested in application errors. You could, however, replace this with a |
| 1647 | custom handler if you wish. The specified record is the one which was being |
| 1648 | processed when the exception occurred. |
| 1649 | |
| 1650 | |
| 1651 | .. method:: Handler.format(record) |
| 1652 | |
| 1653 | Do formatting for a record - if a formatter is set, use it. Otherwise, use the |
| 1654 | default formatter for the module. |
| 1655 | |
| 1656 | |
| 1657 | .. method:: Handler.emit(record) |
| 1658 | |
| 1659 | Do whatever it takes to actually log the specified logging record. This version |
| 1660 | is intended to be implemented by subclasses and so raises a |
| 1661 | :exc:`NotImplementedError`. |
| 1662 | |
| 1663 | |
| 1664 | StreamHandler |
| 1665 | ^^^^^^^^^^^^^ |
| 1666 | |
| 1667 | The :class:`StreamHandler` class, located in the core :mod:`logging` package, |
| 1668 | sends logging output to streams such as *sys.stdout*, *sys.stderr* or any |
| 1669 | file-like object (or, more precisely, any object which supports :meth:`write` |
| 1670 | and :meth:`flush` methods). |
| 1671 | |
| 1672 | |
Benjamin Peterson | 1baf465 | 2009-12-31 03:11:23 +0000 | [diff] [blame] | 1673 | .. currentmodule:: logging |
| 1674 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1675 | .. class:: StreamHandler(stream=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1676 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1677 | Returns a new instance of the :class:`StreamHandler` class. If *stream* is |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1678 | specified, the instance will use it for logging output; otherwise, *sys.stderr* |
| 1679 | will be used. |
| 1680 | |
| 1681 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1682 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1683 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1684 | If a formatter is specified, it is used to format the record. The record |
| 1685 | is then written to the stream with a trailing newline. If exception |
| 1686 | information is present, it is formatted using |
| 1687 | :func:`traceback.print_exception` and appended to the stream. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1688 | |
| 1689 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1690 | .. method:: flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1691 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1692 | Flushes the stream by calling its :meth:`flush` method. Note that the |
| 1693 | :meth:`close` method is inherited from :class:`Handler` and so does |
Benjamin Peterson | 3e4f055 | 2008-09-02 00:31:15 +0000 | [diff] [blame] | 1694 | no output, so an explicit :meth:`flush` call may be needed at times. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1695 | |
| 1696 | |
| 1697 | FileHandler |
| 1698 | ^^^^^^^^^^^ |
| 1699 | |
| 1700 | The :class:`FileHandler` class, located in the core :mod:`logging` package, |
| 1701 | sends logging output to a disk file. It inherits the output functionality from |
| 1702 | :class:`StreamHandler`. |
| 1703 | |
| 1704 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1705 | .. class:: FileHandler(filename, mode='a', encoding=None, delay=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1706 | |
| 1707 | Returns a new instance of the :class:`FileHandler` class. The specified file is |
| 1708 | opened and used as the stream for logging. If *mode* is not specified, |
| 1709 | :const:`'a'` is used. If *encoding* is not *None*, it is used to open the file |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 1710 | with that encoding. If *delay* is true, then file opening is deferred until the |
| 1711 | first call to :meth:`emit`. By default, the file grows indefinitely. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1712 | |
| 1713 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1714 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1715 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1716 | Closes the file. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1717 | |
| 1718 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1719 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1720 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1721 | Outputs the record to the file. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1722 | |
| 1723 | |
Vinay Sajip | aa672eb | 2009-01-02 18:53:45 +0000 | [diff] [blame] | 1724 | NullHandler |
| 1725 | ^^^^^^^^^^^ |
| 1726 | |
| 1727 | .. versionadded:: 3.1 |
| 1728 | |
| 1729 | The :class:`NullHandler` class, located in the core :mod:`logging` package, |
| 1730 | does not do any formatting or output. It is essentially a "no-op" handler |
| 1731 | for use by library developers. |
| 1732 | |
| 1733 | |
| 1734 | .. class:: NullHandler() |
| 1735 | |
| 1736 | Returns a new instance of the :class:`NullHandler` class. |
| 1737 | |
| 1738 | |
| 1739 | .. method:: emit(record) |
| 1740 | |
| 1741 | This method does nothing. |
| 1742 | |
Vinay Sajip | 26a2d5e | 2009-01-10 13:37:26 +0000 | [diff] [blame] | 1743 | See :ref:`library-config` for more information on how to use |
| 1744 | :class:`NullHandler`. |
Benjamin Peterson | 960cf0f | 2009-01-09 04:11:44 +0000 | [diff] [blame] | 1745 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1746 | WatchedFileHandler |
| 1747 | ^^^^^^^^^^^^^^^^^^ |
| 1748 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 1749 | .. currentmodule:: logging.handlers |
Vinay Sajip | aa672eb | 2009-01-02 18:53:45 +0000 | [diff] [blame] | 1750 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1751 | The :class:`WatchedFileHandler` class, located in the :mod:`logging.handlers` |
| 1752 | module, is a :class:`FileHandler` which watches the file it is logging to. If |
| 1753 | the file changes, it is closed and reopened using the file name. |
| 1754 | |
| 1755 | A file change can happen because of usage of programs such as *newsyslog* and |
| 1756 | *logrotate* which perform log file rotation. This handler, intended for use |
| 1757 | under Unix/Linux, watches the file to see if it has changed since the last emit. |
| 1758 | (A file is deemed to have changed if its device or inode have changed.) If the |
| 1759 | file has changed, the old file stream is closed, and the file opened to get a |
| 1760 | new stream. |
| 1761 | |
| 1762 | This handler is not appropriate for use under Windows, because under Windows |
| 1763 | open log files cannot be moved or renamed - logging opens the files with |
| 1764 | exclusive locks - and so there is no need for such a handler. Furthermore, |
| 1765 | *ST_INO* is not supported under Windows; :func:`stat` always returns zero for |
| 1766 | this value. |
| 1767 | |
| 1768 | |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 1769 | .. class:: WatchedFileHandler(filename[,mode[, encoding[, delay]]]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1770 | |
| 1771 | Returns a new instance of the :class:`WatchedFileHandler` class. The specified |
| 1772 | file is opened and used as the stream for logging. If *mode* is not specified, |
| 1773 | :const:`'a'` is used. If *encoding* is not *None*, it is used to open the file |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 1774 | with that encoding. If *delay* is true, then file opening is deferred until the |
| 1775 | first call to :meth:`emit`. By default, the file grows indefinitely. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1776 | |
| 1777 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1778 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1779 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1780 | Outputs the record to the file, but first checks to see if the file has |
| 1781 | changed. If it has, the existing stream is flushed and closed and the |
| 1782 | file opened again, before outputting the record to the file. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1783 | |
| 1784 | |
| 1785 | RotatingFileHandler |
| 1786 | ^^^^^^^^^^^^^^^^^^^ |
| 1787 | |
| 1788 | The :class:`RotatingFileHandler` class, located in the :mod:`logging.handlers` |
| 1789 | module, supports rotation of disk log files. |
| 1790 | |
| 1791 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1792 | .. class:: RotatingFileHandler(filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1793 | |
| 1794 | Returns a new instance of the :class:`RotatingFileHandler` class. The specified |
| 1795 | file is opened and used as the stream for logging. If *mode* is not specified, |
Christian Heimes | e7a15bb | 2008-01-24 16:21:45 +0000 | [diff] [blame] | 1796 | ``'a'`` is used. If *encoding* is not *None*, it is used to open the file |
| 1797 | with that encoding. If *delay* is true, then file opening is deferred until the |
| 1798 | first call to :meth:`emit`. By default, the file grows indefinitely. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1799 | |
| 1800 | You can use the *maxBytes* and *backupCount* values to allow the file to |
| 1801 | :dfn:`rollover` at a predetermined size. When the size is about to be exceeded, |
| 1802 | the file is closed and a new file is silently opened for output. Rollover occurs |
| 1803 | whenever the current log file is nearly *maxBytes* in length; if *maxBytes* is |
| 1804 | zero, rollover never occurs. If *backupCount* is non-zero, the system will save |
| 1805 | old log files by appending the extensions ".1", ".2" etc., to the filename. For |
| 1806 | example, with a *backupCount* of 5 and a base file name of :file:`app.log`, you |
| 1807 | would get :file:`app.log`, :file:`app.log.1`, :file:`app.log.2`, up to |
| 1808 | :file:`app.log.5`. The file being written to is always :file:`app.log`. When |
| 1809 | this file is filled, it is closed and renamed to :file:`app.log.1`, and if files |
| 1810 | :file:`app.log.1`, :file:`app.log.2`, etc. exist, then they are renamed to |
| 1811 | :file:`app.log.2`, :file:`app.log.3` etc. respectively. |
| 1812 | |
| 1813 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1814 | .. method:: doRollover() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1815 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1816 | Does a rollover, as described above. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1817 | |
| 1818 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1819 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1820 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1821 | Outputs the record to the file, catering for rollover as described |
| 1822 | previously. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1823 | |
| 1824 | |
| 1825 | TimedRotatingFileHandler |
| 1826 | ^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1827 | |
| 1828 | The :class:`TimedRotatingFileHandler` class, located in the |
| 1829 | :mod:`logging.handlers` module, supports rotation of disk log files at certain |
| 1830 | timed intervals. |
| 1831 | |
| 1832 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 1833 | .. class:: TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=0, utc=False) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1834 | |
| 1835 | Returns a new instance of the :class:`TimedRotatingFileHandler` class. The |
| 1836 | specified file is opened and used as the stream for logging. On rotating it also |
| 1837 | sets the filename suffix. Rotating happens based on the product of *when* and |
| 1838 | *interval*. |
| 1839 | |
| 1840 | You can use the *when* to specify the type of *interval*. The list of possible |
Georg Brandl | 0c77a82 | 2008-06-10 16:37:50 +0000 | [diff] [blame] | 1841 | values is below. Note that they are not case sensitive. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1842 | |
Christian Heimes | b558a2e | 2008-03-02 22:46:37 +0000 | [diff] [blame] | 1843 | +----------------+-----------------------+ |
| 1844 | | Value | Type of interval | |
| 1845 | +================+=======================+ |
| 1846 | | ``'S'`` | Seconds | |
| 1847 | +----------------+-----------------------+ |
| 1848 | | ``'M'`` | Minutes | |
| 1849 | +----------------+-----------------------+ |
| 1850 | | ``'H'`` | Hours | |
| 1851 | +----------------+-----------------------+ |
| 1852 | | ``'D'`` | Days | |
| 1853 | +----------------+-----------------------+ |
| 1854 | | ``'W'`` | Week day (0=Monday) | |
| 1855 | +----------------+-----------------------+ |
| 1856 | | ``'midnight'`` | Roll over at midnight | |
| 1857 | +----------------+-----------------------+ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1858 | |
Christian Heimes | b558a2e | 2008-03-02 22:46:37 +0000 | [diff] [blame] | 1859 | The system will save old log files by appending extensions to the filename. |
| 1860 | The extensions are date-and-time based, using the strftime format |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1861 | ``%Y-%m-%d_%H-%M-%S`` or a leading portion thereof, depending on the |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 1862 | rollover interval. |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 1863 | |
| 1864 | When computing the next rollover time for the first time (when the handler |
| 1865 | is created), the last modification time of an existing log file, or else |
| 1866 | the current time, is used to compute when the next rotation will occur. |
| 1867 | |
Georg Brandl | 0c77a82 | 2008-06-10 16:37:50 +0000 | [diff] [blame] | 1868 | If the *utc* argument is true, times in UTC will be used; otherwise |
| 1869 | local time is used. |
| 1870 | |
| 1871 | If *backupCount* is nonzero, at most *backupCount* files |
Benjamin Peterson | ad9d48d | 2008-04-02 21:49:44 +0000 | [diff] [blame] | 1872 | will be kept, and if more would be created when rollover occurs, the oldest |
| 1873 | one is deleted. The deletion logic uses the interval to determine which |
| 1874 | files to delete, so changing the interval may leave old files lying around. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1875 | |
| 1876 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1877 | .. method:: doRollover() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1878 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1879 | Does a rollover, as described above. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1880 | |
| 1881 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1882 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1883 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1884 | Outputs the record to the file, catering for rollover as described above. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1885 | |
| 1886 | |
| 1887 | SocketHandler |
| 1888 | ^^^^^^^^^^^^^ |
| 1889 | |
| 1890 | The :class:`SocketHandler` class, located in the :mod:`logging.handlers` module, |
| 1891 | sends logging output to a network socket. The base class uses a TCP socket. |
| 1892 | |
| 1893 | |
| 1894 | .. class:: SocketHandler(host, port) |
| 1895 | |
| 1896 | Returns a new instance of the :class:`SocketHandler` class intended to |
| 1897 | communicate with a remote machine whose address is given by *host* and *port*. |
| 1898 | |
| 1899 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1900 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1901 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1902 | Closes the socket. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1903 | |
| 1904 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1905 | .. method:: emit() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1906 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1907 | Pickles the record's attribute dictionary and writes it to the socket in |
| 1908 | binary format. If there is an error with the socket, silently drops the |
| 1909 | packet. If the connection was previously lost, re-establishes the |
| 1910 | connection. To unpickle the record at the receiving end into a |
| 1911 | :class:`LogRecord`, use the :func:`makeLogRecord` function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1912 | |
| 1913 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1914 | .. method:: handleError() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1915 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1916 | Handles an error which has occurred during :meth:`emit`. The most likely |
| 1917 | cause is a lost connection. Closes the socket so that we can retry on the |
| 1918 | next event. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1919 | |
| 1920 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1921 | .. method:: makeSocket() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1922 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1923 | This is a factory method which allows subclasses to define the precise |
| 1924 | type of socket they want. The default implementation creates a TCP socket |
| 1925 | (:const:`socket.SOCK_STREAM`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1926 | |
| 1927 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1928 | .. method:: makePickle(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1929 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1930 | Pickles the record's attribute dictionary in binary format with a length |
| 1931 | prefix, and returns it ready for transmission across the socket. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1932 | |
| 1933 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1934 | .. method:: send(packet) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1935 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1936 | Send a pickled string *packet* to the socket. This function allows for |
| 1937 | partial sends which can happen when the network is busy. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1938 | |
| 1939 | |
| 1940 | DatagramHandler |
| 1941 | ^^^^^^^^^^^^^^^ |
| 1942 | |
| 1943 | The :class:`DatagramHandler` class, located in the :mod:`logging.handlers` |
| 1944 | module, inherits from :class:`SocketHandler` to support sending logging messages |
| 1945 | over UDP sockets. |
| 1946 | |
| 1947 | |
| 1948 | .. class:: DatagramHandler(host, port) |
| 1949 | |
| 1950 | Returns a new instance of the :class:`DatagramHandler` class intended to |
| 1951 | communicate with a remote machine whose address is given by *host* and *port*. |
| 1952 | |
| 1953 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1954 | .. method:: emit() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1955 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1956 | Pickles the record's attribute dictionary and writes it to the socket in |
| 1957 | binary format. If there is an error with the socket, silently drops the |
| 1958 | packet. To unpickle the record at the receiving end into a |
| 1959 | :class:`LogRecord`, use the :func:`makeLogRecord` function. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1960 | |
| 1961 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1962 | .. method:: makeSocket() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1963 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1964 | The factory method of :class:`SocketHandler` is here overridden to create |
| 1965 | a UDP socket (:const:`socket.SOCK_DGRAM`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1966 | |
| 1967 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1968 | .. method:: send(s) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1969 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1970 | Send a pickled string to a socket. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1971 | |
| 1972 | |
| 1973 | SysLogHandler |
| 1974 | ^^^^^^^^^^^^^ |
| 1975 | |
| 1976 | The :class:`SysLogHandler` class, located in the :mod:`logging.handlers` module, |
| 1977 | supports sending logging messages to a remote or local Unix syslog. |
| 1978 | |
| 1979 | |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 1980 | .. class:: SysLogHandler(address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1981 | |
| 1982 | Returns a new instance of the :class:`SysLogHandler` class intended to |
| 1983 | communicate with a remote Unix machine whose address is given by *address* in |
| 1984 | the form of a ``(host, port)`` tuple. If *address* is not specified, |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 1985 | ``('localhost', 514)`` is used. The address is used to open a socket. An |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1986 | alternative to providing a ``(host, port)`` tuple is providing an address as a |
| 1987 | string, for example "/dev/log". In this case, a Unix domain socket is used to |
| 1988 | send the message to the syslog. If *facility* is not specified, |
Vinay Sajip | cbabd7e | 2009-10-10 20:32:36 +0000 | [diff] [blame] | 1989 | :const:`LOG_USER` is used. The type of socket opened depends on the |
| 1990 | *socktype* argument, which defaults to :const:`socket.SOCK_DGRAM` and thus |
| 1991 | opens a UDP socket. To open a TCP socket (for use with the newer syslog |
| 1992 | daemons such as rsyslog), specify a value of :const:`socket.SOCK_STREAM`. |
| 1993 | |
| 1994 | .. versionchanged:: 3.2 |
| 1995 | *socktype* was added. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1996 | |
| 1997 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 1998 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1999 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2000 | Closes the socket to the remote host. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2001 | |
| 2002 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2003 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2004 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2005 | The record is formatted, and then sent to the syslog server. If exception |
| 2006 | information is present, it is *not* sent to the server. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2007 | |
| 2008 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2009 | .. method:: encodePriority(facility, priority) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2010 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2011 | Encodes the facility and priority into an integer. You can pass in strings |
| 2012 | or integers - if strings are passed, internal mapping dictionaries are |
| 2013 | used to convert them to integers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2014 | |
| 2015 | |
| 2016 | NTEventLogHandler |
| 2017 | ^^^^^^^^^^^^^^^^^ |
| 2018 | |
| 2019 | The :class:`NTEventLogHandler` class, located in the :mod:`logging.handlers` |
| 2020 | module, supports sending logging messages to a local Windows NT, Windows 2000 or |
| 2021 | Windows XP event log. Before you can use it, you need Mark Hammond's Win32 |
| 2022 | extensions for Python installed. |
| 2023 | |
| 2024 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2025 | .. class:: NTEventLogHandler(appname, dllname=None, logtype='Application') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2026 | |
| 2027 | Returns a new instance of the :class:`NTEventLogHandler` class. The *appname* is |
| 2028 | used to define the application name as it appears in the event log. An |
| 2029 | appropriate registry entry is created using this name. The *dllname* should give |
| 2030 | the fully qualified pathname of a .dll or .exe which contains message |
| 2031 | definitions to hold in the log (if not specified, ``'win32service.pyd'`` is used |
| 2032 | - this is installed with the Win32 extensions and contains some basic |
| 2033 | placeholder message definitions. Note that use of these placeholders will make |
| 2034 | your event logs big, as the entire message source is held in the log. If you |
| 2035 | want slimmer logs, you have to pass in the name of your own .dll or .exe which |
| 2036 | contains the message definitions you want to use in the event log). The |
| 2037 | *logtype* is one of ``'Application'``, ``'System'`` or ``'Security'``, and |
| 2038 | defaults to ``'Application'``. |
| 2039 | |
| 2040 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2041 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2042 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2043 | At this point, you can remove the application name from the registry as a |
| 2044 | source of event log entries. However, if you do this, you will not be able |
| 2045 | to see the events as you intended in the Event Log Viewer - it needs to be |
| 2046 | able to access the registry to get the .dll name. The current version does |
Benjamin Peterson | 3e4f055 | 2008-09-02 00:31:15 +0000 | [diff] [blame] | 2047 | not do this. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2048 | |
| 2049 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2050 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2051 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2052 | Determines the message ID, event category and event type, and then logs |
| 2053 | the message in the NT event log. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2054 | |
| 2055 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2056 | .. method:: getEventCategory(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2057 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2058 | Returns the event category for the record. Override this if you want to |
| 2059 | specify your own categories. This version returns 0. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2060 | |
| 2061 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2062 | .. method:: getEventType(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2063 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2064 | Returns the event type for the record. Override this if you want to |
| 2065 | specify your own types. This version does a mapping using the handler's |
| 2066 | typemap attribute, which is set up in :meth:`__init__` to a dictionary |
| 2067 | which contains mappings for :const:`DEBUG`, :const:`INFO`, |
| 2068 | :const:`WARNING`, :const:`ERROR` and :const:`CRITICAL`. If you are using |
| 2069 | your own levels, you will either need to override this method or place a |
| 2070 | suitable dictionary in the handler's *typemap* attribute. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2071 | |
| 2072 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2073 | .. method:: getMessageID(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2074 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2075 | Returns the message ID for the record. If you are using your own messages, |
| 2076 | you could do this by having the *msg* passed to the logger being an ID |
| 2077 | rather than a format string. Then, in here, you could use a dictionary |
| 2078 | lookup to get the message ID. This version returns 1, which is the base |
| 2079 | message ID in :file:`win32service.pyd`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2080 | |
| 2081 | |
| 2082 | SMTPHandler |
| 2083 | ^^^^^^^^^^^ |
| 2084 | |
| 2085 | The :class:`SMTPHandler` class, located in the :mod:`logging.handlers` module, |
| 2086 | supports sending logging messages to an email address via SMTP. |
| 2087 | |
| 2088 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2089 | .. class:: SMTPHandler(mailhost, fromaddr, toaddrs, subject, credentials=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2090 | |
| 2091 | Returns a new instance of the :class:`SMTPHandler` class. The instance is |
| 2092 | initialized with the from and to addresses and subject line of the email. The |
| 2093 | *toaddrs* should be a list of strings. To specify a non-standard SMTP port, use |
| 2094 | the (host, port) tuple format for the *mailhost* argument. If you use a string, |
| 2095 | the standard SMTP port is used. If your SMTP server requires authentication, you |
| 2096 | can specify a (username, password) tuple for the *credentials* argument. |
| 2097 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2098 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2099 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2100 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2101 | Formats the record and sends it to the specified addressees. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2102 | |
| 2103 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2104 | .. method:: getSubject(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2105 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2106 | If you want to specify a subject line which is record-dependent, override |
| 2107 | this method. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2108 | |
| 2109 | |
| 2110 | MemoryHandler |
| 2111 | ^^^^^^^^^^^^^ |
| 2112 | |
| 2113 | The :class:`MemoryHandler` class, located in the :mod:`logging.handlers` module, |
| 2114 | supports buffering of logging records in memory, periodically flushing them to a |
| 2115 | :dfn:`target` handler. Flushing occurs whenever the buffer is full, or when an |
| 2116 | event of a certain severity or greater is seen. |
| 2117 | |
| 2118 | :class:`MemoryHandler` is a subclass of the more general |
| 2119 | :class:`BufferingHandler`, which is an abstract class. This buffers logging |
| 2120 | records in memory. Whenever each record is added to the buffer, a check is made |
| 2121 | by calling :meth:`shouldFlush` to see if the buffer should be flushed. If it |
| 2122 | should, then :meth:`flush` is expected to do the needful. |
| 2123 | |
| 2124 | |
| 2125 | .. class:: BufferingHandler(capacity) |
| 2126 | |
| 2127 | Initializes the handler with a buffer of the specified capacity. |
| 2128 | |
| 2129 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2130 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2131 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2132 | Appends the record to the buffer. If :meth:`shouldFlush` returns true, |
| 2133 | calls :meth:`flush` to process the buffer. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2134 | |
| 2135 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2136 | .. method:: flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2137 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2138 | You can override this to implement custom flushing behavior. This version |
| 2139 | just zaps the buffer to empty. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2140 | |
| 2141 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2142 | .. method:: shouldFlush(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2143 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2144 | Returns true if the buffer is up to capacity. This method can be |
| 2145 | overridden to implement custom flushing strategies. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2146 | |
| 2147 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2148 | .. class:: MemoryHandler(capacity, flushLevel=ERROR, target=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2149 | |
| 2150 | Returns a new instance of the :class:`MemoryHandler` class. The instance is |
| 2151 | initialized with a buffer size of *capacity*. If *flushLevel* is not specified, |
| 2152 | :const:`ERROR` is used. If no *target* is specified, the target will need to be |
| 2153 | set using :meth:`setTarget` before this handler does anything useful. |
| 2154 | |
| 2155 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2156 | .. method:: close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2157 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2158 | Calls :meth:`flush`, sets the target to :const:`None` and clears the |
| 2159 | buffer. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2160 | |
| 2161 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2162 | .. method:: flush() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2163 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2164 | For a :class:`MemoryHandler`, flushing means just sending the buffered |
| 2165 | records to the target, if there is one. Override if you want different |
| 2166 | behavior. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2167 | |
| 2168 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2169 | .. method:: setTarget(target) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2170 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2171 | Sets the target handler for this handler. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2172 | |
| 2173 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2174 | .. method:: shouldFlush(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2175 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2176 | Checks for buffer full or a record at the *flushLevel* or higher. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2177 | |
| 2178 | |
| 2179 | HTTPHandler |
| 2180 | ^^^^^^^^^^^ |
| 2181 | |
| 2182 | The :class:`HTTPHandler` class, located in the :mod:`logging.handlers` module, |
| 2183 | supports sending logging messages to a Web server, using either ``GET`` or |
| 2184 | ``POST`` semantics. |
| 2185 | |
| 2186 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2187 | .. class:: HTTPHandler(host, url, method='GET') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2188 | |
| 2189 | Returns a new instance of the :class:`HTTPHandler` class. The instance is |
| 2190 | initialized with a host address, url and HTTP method. The *host* can be of the |
| 2191 | form ``host:port``, should you need to use a specific port number. If no |
| 2192 | *method* is specified, ``GET`` is used. |
| 2193 | |
| 2194 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2195 | .. method:: emit(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2196 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2197 | Sends the record to the Web server as an URL-encoded dictionary. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2198 | |
| 2199 | |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2200 | .. _formatter-objects: |
| 2201 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2202 | Formatter Objects |
| 2203 | ----------------- |
| 2204 | |
Benjamin Peterson | 75edad0 | 2009-01-01 15:05:06 +0000 | [diff] [blame] | 2205 | .. currentmodule:: logging |
| 2206 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2207 | :class:`Formatter`\ s have the following attributes and methods. They are |
| 2208 | responsible for converting a :class:`LogRecord` to (usually) a string which can |
| 2209 | be interpreted by either a human or an external system. The base |
| 2210 | :class:`Formatter` allows a formatting string to be specified. If none is |
| 2211 | supplied, the default value of ``'%(message)s'`` is used. |
| 2212 | |
| 2213 | A Formatter can be initialized with a format string which makes use of knowledge |
| 2214 | of the :class:`LogRecord` attributes - such as the default value mentioned above |
| 2215 | making use of the fact that the user's message and arguments are pre-formatted |
| 2216 | into a :class:`LogRecord`'s *message* attribute. This format string contains |
Ezio Melotti | 0639d5a | 2009-12-19 23:26:38 +0000 | [diff] [blame] | 2217 | standard Python %-style mapping keys. See section :ref:`old-string-formatting` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2218 | for more information on string formatting. |
| 2219 | |
| 2220 | Currently, the useful mapping keys in a :class:`LogRecord` are: |
| 2221 | |
| 2222 | +-------------------------+-----------------------------------------------+ |
| 2223 | | Format | Description | |
| 2224 | +=========================+===============================================+ |
| 2225 | | ``%(name)s`` | Name of the logger (logging channel). | |
| 2226 | +-------------------------+-----------------------------------------------+ |
| 2227 | | ``%(levelno)s`` | Numeric logging level for the message | |
| 2228 | | | (:const:`DEBUG`, :const:`INFO`, | |
| 2229 | | | :const:`WARNING`, :const:`ERROR`, | |
| 2230 | | | :const:`CRITICAL`). | |
| 2231 | +-------------------------+-----------------------------------------------+ |
| 2232 | | ``%(levelname)s`` | Text logging level for the message | |
| 2233 | | | (``'DEBUG'``, ``'INFO'``, ``'WARNING'``, | |
| 2234 | | | ``'ERROR'``, ``'CRITICAL'``). | |
| 2235 | +-------------------------+-----------------------------------------------+ |
| 2236 | | ``%(pathname)s`` | Full pathname of the source file where the | |
| 2237 | | | logging call was issued (if available). | |
| 2238 | +-------------------------+-----------------------------------------------+ |
| 2239 | | ``%(filename)s`` | Filename portion of pathname. | |
| 2240 | +-------------------------+-----------------------------------------------+ |
| 2241 | | ``%(module)s`` | Module (name portion of filename). | |
| 2242 | +-------------------------+-----------------------------------------------+ |
| 2243 | | ``%(funcName)s`` | Name of function containing the logging call. | |
| 2244 | +-------------------------+-----------------------------------------------+ |
| 2245 | | ``%(lineno)d`` | Source line number where the logging call was | |
| 2246 | | | issued (if available). | |
| 2247 | +-------------------------+-----------------------------------------------+ |
| 2248 | | ``%(created)f`` | Time when the :class:`LogRecord` was created | |
| 2249 | | | (as returned by :func:`time.time`). | |
| 2250 | +-------------------------+-----------------------------------------------+ |
| 2251 | | ``%(relativeCreated)d`` | Time in milliseconds when the LogRecord was | |
| 2252 | | | created, relative to the time the logging | |
| 2253 | | | module was loaded. | |
| 2254 | +-------------------------+-----------------------------------------------+ |
| 2255 | | ``%(asctime)s`` | Human-readable time when the | |
| 2256 | | | :class:`LogRecord` was created. By default | |
| 2257 | | | this is of the form "2003-07-08 16:49:45,896" | |
| 2258 | | | (the numbers after the comma are millisecond | |
| 2259 | | | portion of the time). | |
| 2260 | +-------------------------+-----------------------------------------------+ |
| 2261 | | ``%(msecs)d`` | Millisecond portion of the time when the | |
| 2262 | | | :class:`LogRecord` was created. | |
| 2263 | +-------------------------+-----------------------------------------------+ |
| 2264 | | ``%(thread)d`` | Thread ID (if available). | |
| 2265 | +-------------------------+-----------------------------------------------+ |
| 2266 | | ``%(threadName)s`` | Thread name (if available). | |
| 2267 | +-------------------------+-----------------------------------------------+ |
| 2268 | | ``%(process)d`` | Process ID (if available). | |
| 2269 | +-------------------------+-----------------------------------------------+ |
| 2270 | | ``%(message)s`` | The logged message, computed as ``msg % | |
| 2271 | | | args``. | |
| 2272 | +-------------------------+-----------------------------------------------+ |
| 2273 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2274 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2275 | .. class:: Formatter(fmt=None, datefmt=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2276 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2277 | Returns a new instance of the :class:`Formatter` class. The instance is |
| 2278 | initialized with a format string for the message as a whole, as well as a |
| 2279 | format string for the date/time portion of a message. If no *fmt* is |
| 2280 | specified, ``'%(message)s'`` is used. If no *datefmt* is specified, the |
| 2281 | ISO8601 date format is used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2282 | |
| 2283 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2284 | .. method:: format(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2285 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2286 | The record's attribute dictionary is used as the operand to a string |
| 2287 | formatting operation. Returns the resulting string. Before formatting the |
| 2288 | dictionary, a couple of preparatory steps are carried out. The *message* |
| 2289 | attribute of the record is computed using *msg* % *args*. If the |
| 2290 | formatting string contains ``'(asctime)'``, :meth:`formatTime` is called |
| 2291 | to format the event time. If there is exception information, it is |
| 2292 | formatted using :meth:`formatException` and appended to the message. Note |
| 2293 | that the formatted exception information is cached in attribute |
| 2294 | *exc_text*. This is useful because the exception information can be |
| 2295 | pickled and sent across the wire, but you should be careful if you have |
| 2296 | more than one :class:`Formatter` subclass which customizes the formatting |
| 2297 | of exception information. In this case, you will have to clear the cached |
| 2298 | value after a formatter has done its formatting, so that the next |
| 2299 | formatter to handle the event doesn't use the cached value but |
| 2300 | recalculates it afresh. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2301 | |
| 2302 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2303 | .. method:: formatTime(record, datefmt=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2304 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2305 | This method should be called from :meth:`format` by a formatter which |
| 2306 | wants to make use of a formatted time. This method can be overridden in |
| 2307 | formatters to provide for any specific requirement, but the basic behavior |
| 2308 | is as follows: if *datefmt* (a string) is specified, it is used with |
| 2309 | :func:`time.strftime` to format the creation time of the |
| 2310 | record. Otherwise, the ISO8601 format is used. The resulting string is |
| 2311 | returned. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2312 | |
| 2313 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2314 | .. method:: formatException(exc_info) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2315 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2316 | Formats the specified exception information (a standard exception tuple as |
| 2317 | returned by :func:`sys.exc_info`) as a string. This default implementation |
| 2318 | just uses :func:`traceback.print_exception`. The resulting string is |
| 2319 | returned. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2320 | |
| 2321 | |
| 2322 | Filter Objects |
| 2323 | -------------- |
| 2324 | |
| 2325 | :class:`Filter`\ s can be used by :class:`Handler`\ s and :class:`Logger`\ s for |
| 2326 | more sophisticated filtering than is provided by levels. The base filter class |
| 2327 | only allows events which are below a certain point in the logger hierarchy. For |
| 2328 | example, a filter initialized with "A.B" will allow events logged by loggers |
| 2329 | "A.B", "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB", "B.A.B" etc. If |
| 2330 | initialized with the empty string, all events are passed. |
| 2331 | |
| 2332 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2333 | .. class:: Filter(name='') |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2334 | |
| 2335 | Returns an instance of the :class:`Filter` class. If *name* is specified, it |
| 2336 | names a logger which, together with its children, will have its events allowed |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2337 | through the filter. If *name* is the empty string, allows every event. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2338 | |
| 2339 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2340 | .. method:: filter(record) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2341 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2342 | Is the specified record to be logged? Returns zero for no, nonzero for |
| 2343 | yes. If deemed appropriate, the record may be modified in-place by this |
| 2344 | method. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2345 | |
| 2346 | |
| 2347 | LogRecord Objects |
| 2348 | ----------------- |
| 2349 | |
| 2350 | :class:`LogRecord` instances are created every time something is logged. They |
| 2351 | contain all the information pertinent to the event being logged. The main |
| 2352 | information passed in is in msg and args, which are combined using msg % args to |
| 2353 | create the message field of the record. The record also includes information |
| 2354 | such as when the record was created, the source line where the logging call was |
| 2355 | made, and any exception information to be logged. |
| 2356 | |
| 2357 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2358 | .. class:: LogRecord(name, lvl, pathname, lineno, msg, args, exc_info, func=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2359 | |
| 2360 | Returns an instance of :class:`LogRecord` initialized with interesting |
| 2361 | information. The *name* is the logger name; *lvl* is the numeric level; |
| 2362 | *pathname* is the absolute pathname of the source file in which the logging |
| 2363 | call was made; *lineno* is the line number in that file where the logging |
| 2364 | call is found; *msg* is the user-supplied message (a format string); *args* |
| 2365 | is the tuple which, together with *msg*, makes up the user message; and |
| 2366 | *exc_info* is the exception tuple obtained by calling :func:`sys.exc_info` |
| 2367 | (or :const:`None`, if no exception information is available). The *func* is |
| 2368 | the name of the function from which the logging call was made. If not |
| 2369 | specified, it defaults to ``None``. |
| 2370 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2371 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2372 | .. method:: getMessage() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2373 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2374 | Returns the message for this :class:`LogRecord` instance after merging any |
| 2375 | user-supplied arguments with the message. |
| 2376 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2377 | |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 2378 | LoggerAdapter Objects |
| 2379 | --------------------- |
| 2380 | |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 2381 | :class:`LoggerAdapter` instances are used to conveniently pass contextual |
Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 2382 | information into logging calls. For a usage example , see the section on |
| 2383 | `adding contextual information to your logging output`__. |
| 2384 | |
| 2385 | __ context-info_ |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 2386 | |
| 2387 | .. class:: LoggerAdapter(logger, extra) |
| 2388 | |
| 2389 | Returns an instance of :class:`LoggerAdapter` initialized with an |
| 2390 | underlying :class:`Logger` instance and a dict-like object. |
| 2391 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2392 | .. method:: process(msg, kwargs) |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 2393 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 2394 | Modifies the message and/or keyword arguments passed to a logging call in |
| 2395 | order to insert contextual information. This implementation takes the object |
| 2396 | passed as *extra* to the constructor and adds it to *kwargs* using key |
| 2397 | 'extra'. The return value is a (*msg*, *kwargs*) tuple which has the |
| 2398 | (possibly modified) versions of the arguments passed in. |
Christian Heimes | 04c420f | 2008-01-18 18:40:46 +0000 | [diff] [blame] | 2399 | |
| 2400 | In addition to the above, :class:`LoggerAdapter` supports all the logging |
| 2401 | methods of :class:`Logger`, i.e. :meth:`debug`, :meth:`info`, :meth:`warning`, |
| 2402 | :meth:`error`, :meth:`exception`, :meth:`critical` and :meth:`log`. These |
| 2403 | methods have the same signatures as their counterparts in :class:`Logger`, so |
| 2404 | you can use the two types of instances interchangeably. |
| 2405 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2406 | |
| 2407 | Thread Safety |
| 2408 | ------------- |
| 2409 | |
| 2410 | The logging module is intended to be thread-safe without any special work |
| 2411 | needing to be done by its clients. It achieves this though using threading |
| 2412 | locks; there is one lock to serialize access to the module's shared data, and |
| 2413 | each handler also creates a lock to serialize access to its underlying I/O. |
| 2414 | |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 2415 | If you are implementing asynchronous signal handlers using the :mod:`signal` |
| 2416 | module, you may not be able to use logging from within such handlers. This is |
| 2417 | because lock implementations in the :mod:`threading` module are not always |
| 2418 | re-entrant, and so cannot be invoked from such signal handlers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2419 | |
Benjamin Peterson | 9451a1c | 2010-03-13 22:30:34 +0000 | [diff] [blame] | 2420 | |
| 2421 | Integration with the warnings module |
| 2422 | ------------------------------------ |
| 2423 | |
| 2424 | The :func:`captureWarnings` function can be used to integrate :mod:`logging` |
| 2425 | with the :mod:`warnings` module. |
| 2426 | |
| 2427 | .. function:: captureWarnings(capture) |
| 2428 | |
| 2429 | This function is used to turn the capture of warnings by logging on and |
| 2430 | off. |
| 2431 | |
| 2432 | If `capture` is `True`, warnings issued by the :mod:`warnings` module |
| 2433 | will be redirected to the logging system. Specifically, a warning will be |
| 2434 | formatted using :func:`warnings.formatwarning` and the resulting string |
| 2435 | logged to a logger named "py.warnings" with a severity of `WARNING`. |
| 2436 | |
| 2437 | If `capture` is `False`, the redirection of warnings to the logging system |
| 2438 | will stop, and warnings will be redirected to their original destinations |
| 2439 | (i.e. those in effect before `captureWarnings(True)` was called). |
| 2440 | |
| 2441 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2442 | Configuration |
| 2443 | ------------- |
| 2444 | |
| 2445 | |
| 2446 | .. _logging-config-api: |
| 2447 | |
| 2448 | Configuration functions |
| 2449 | ^^^^^^^^^^^^^^^^^^^^^^^ |
| 2450 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2451 | The following functions configure the logging module. They are located in the |
| 2452 | :mod:`logging.config` module. Their use is optional --- you can configure the |
| 2453 | logging module using these functions or by making calls to the main API (defined |
| 2454 | in :mod:`logging` itself) and defining handlers which are declared either in |
| 2455 | :mod:`logging` or :mod:`logging.handlers`. |
| 2456 | |
| 2457 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2458 | .. function:: fileConfig(fname, defaults=None, disable_existing_loggers=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2459 | |
Alexandre Vassalotti | 1d1eaa4 | 2008-05-14 22:59:42 +0000 | [diff] [blame] | 2460 | Reads the logging configuration from a :mod:`configparser`\-format file named |
Benjamin Peterson | 960cf0f | 2009-01-09 04:11:44 +0000 | [diff] [blame] | 2461 | *fname*. This function can be called several times from an application, |
Alexandre Vassalotti | 1d1eaa4 | 2008-05-14 22:59:42 +0000 | [diff] [blame] | 2462 | allowing an end user the ability to select from various pre-canned |
| 2463 | configurations (if the developer provides a mechanism to present the choices |
| 2464 | and load the chosen configuration). Defaults to be passed to the ConfigParser |
| 2465 | can be specified in the *defaults* argument. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2466 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2467 | If *disable_existing_loggers* is true, any existing loggers that are not |
| 2468 | children of named loggers will be disabled. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2469 | |
Georg Brandl | cd7f32b | 2009-06-08 09:13:45 +0000 | [diff] [blame] | 2470 | |
| 2471 | .. function:: listen(port=DEFAULT_LOGGING_CONFIG_PORT) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2472 | |
| 2473 | Starts up a socket server on the specified port, and listens for new |
| 2474 | configurations. If no port is specified, the module's default |
| 2475 | :const:`DEFAULT_LOGGING_CONFIG_PORT` is used. Logging configurations will be |
| 2476 | sent as a file suitable for processing by :func:`fileConfig`. Returns a |
| 2477 | :class:`Thread` instance on which you can call :meth:`start` to start the |
| 2478 | server, and which you can :meth:`join` when appropriate. To stop the server, |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2479 | call :func:`stopListening`. |
| 2480 | |
| 2481 | To send a configuration to the socket, read in the configuration file and |
| 2482 | send it to the socket as a string of bytes preceded by a four-byte length |
| 2483 | string packed in binary using ``struct.pack('>L', n)``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2484 | |
| 2485 | |
| 2486 | .. function:: stopListening() |
| 2487 | |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2488 | Stops the listening server which was created with a call to :func:`listen`. |
| 2489 | This is typically called before calling :meth:`join` on the return value from |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2490 | :func:`listen`. |
| 2491 | |
| 2492 | |
| 2493 | .. _logging-config-fileformat: |
| 2494 | |
| 2495 | Configuration file format |
| 2496 | ^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 2497 | |
Benjamin Peterson | 960cf0f | 2009-01-09 04:11:44 +0000 | [diff] [blame] | 2498 | The configuration file format understood by :func:`fileConfig` is based on |
| 2499 | :mod:`configparser` functionality. The file must contain sections called |
| 2500 | ``[loggers]``, ``[handlers]`` and ``[formatters]`` which identify by name the |
| 2501 | entities of each type which are defined in the file. For each such entity, there |
| 2502 | is a separate section which identifies how that entity is configured. Thus, for |
| 2503 | a logger named ``log01`` in the ``[loggers]`` section, the relevant |
| 2504 | configuration details are held in a section ``[logger_log01]``. Similarly, a |
| 2505 | handler called ``hand01`` in the ``[handlers]`` section will have its |
| 2506 | configuration held in a section called ``[handler_hand01]``, while a formatter |
| 2507 | called ``form01`` in the ``[formatters]`` section will have its configuration |
| 2508 | specified in a section called ``[formatter_form01]``. The root logger |
| 2509 | configuration must be specified in a section called ``[logger_root]``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2510 | |
| 2511 | Examples of these sections in the file are given below. :: |
| 2512 | |
| 2513 | [loggers] |
| 2514 | keys=root,log02,log03,log04,log05,log06,log07 |
| 2515 | |
| 2516 | [handlers] |
| 2517 | keys=hand01,hand02,hand03,hand04,hand05,hand06,hand07,hand08,hand09 |
| 2518 | |
| 2519 | [formatters] |
| 2520 | keys=form01,form02,form03,form04,form05,form06,form07,form08,form09 |
| 2521 | |
| 2522 | The root logger must specify a level and a list of handlers. An example of a |
| 2523 | root logger section is given below. :: |
| 2524 | |
| 2525 | [logger_root] |
| 2526 | level=NOTSET |
| 2527 | handlers=hand01 |
| 2528 | |
| 2529 | The ``level`` entry can be one of ``DEBUG, INFO, WARNING, ERROR, CRITICAL`` or |
| 2530 | ``NOTSET``. For the root logger only, ``NOTSET`` means that all messages will be |
| 2531 | logged. Level values are :func:`eval`\ uated in the context of the ``logging`` |
| 2532 | package's namespace. |
| 2533 | |
| 2534 | The ``handlers`` entry is a comma-separated list of handler names, which must |
| 2535 | appear in the ``[handlers]`` section. These names must appear in the |
| 2536 | ``[handlers]`` section and have corresponding sections in the configuration |
| 2537 | file. |
| 2538 | |
| 2539 | For loggers other than the root logger, some additional information is required. |
| 2540 | This is illustrated by the following example. :: |
| 2541 | |
| 2542 | [logger_parser] |
| 2543 | level=DEBUG |
| 2544 | handlers=hand01 |
| 2545 | propagate=1 |
| 2546 | qualname=compiler.parser |
| 2547 | |
| 2548 | The ``level`` and ``handlers`` entries are interpreted as for the root logger, |
| 2549 | except that if a non-root logger's level is specified as ``NOTSET``, the system |
| 2550 | consults loggers higher up the hierarchy to determine the effective level of the |
| 2551 | logger. The ``propagate`` entry is set to 1 to indicate that messages must |
| 2552 | propagate to handlers higher up the logger hierarchy from this logger, or 0 to |
| 2553 | indicate that messages are **not** propagated to handlers up the hierarchy. The |
| 2554 | ``qualname`` entry is the hierarchical channel name of the logger, that is to |
| 2555 | say the name used by the application to get the logger. |
| 2556 | |
| 2557 | Sections which specify handler configuration are exemplified by the following. |
| 2558 | :: |
| 2559 | |
| 2560 | [handler_hand01] |
| 2561 | class=StreamHandler |
| 2562 | level=NOTSET |
| 2563 | formatter=form01 |
| 2564 | args=(sys.stdout,) |
| 2565 | |
| 2566 | The ``class`` entry indicates the handler's class (as determined by :func:`eval` |
| 2567 | in the ``logging`` package's namespace). The ``level`` is interpreted as for |
| 2568 | loggers, and ``NOTSET`` is taken to mean "log everything". |
| 2569 | |
| 2570 | The ``formatter`` entry indicates the key name of the formatter for this |
| 2571 | handler. If blank, a default formatter (``logging._defaultFormatter``) is used. |
| 2572 | If a name is specified, it must appear in the ``[formatters]`` section and have |
| 2573 | a corresponding section in the configuration file. |
| 2574 | |
| 2575 | The ``args`` entry, when :func:`eval`\ uated in the context of the ``logging`` |
| 2576 | package's namespace, is the list of arguments to the constructor for the handler |
| 2577 | class. Refer to the constructors for the relevant handlers, or to the examples |
| 2578 | below, to see how typical entries are constructed. :: |
| 2579 | |
| 2580 | [handler_hand02] |
| 2581 | class=FileHandler |
| 2582 | level=DEBUG |
| 2583 | formatter=form02 |
| 2584 | args=('python.log', 'w') |
| 2585 | |
| 2586 | [handler_hand03] |
| 2587 | class=handlers.SocketHandler |
| 2588 | level=INFO |
| 2589 | formatter=form03 |
| 2590 | args=('localhost', handlers.DEFAULT_TCP_LOGGING_PORT) |
| 2591 | |
| 2592 | [handler_hand04] |
| 2593 | class=handlers.DatagramHandler |
| 2594 | level=WARN |
| 2595 | formatter=form04 |
| 2596 | args=('localhost', handlers.DEFAULT_UDP_LOGGING_PORT) |
| 2597 | |
| 2598 | [handler_hand05] |
| 2599 | class=handlers.SysLogHandler |
| 2600 | level=ERROR |
| 2601 | formatter=form05 |
| 2602 | args=(('localhost', handlers.SYSLOG_UDP_PORT), handlers.SysLogHandler.LOG_USER) |
| 2603 | |
| 2604 | [handler_hand06] |
| 2605 | class=handlers.NTEventLogHandler |
| 2606 | level=CRITICAL |
| 2607 | formatter=form06 |
| 2608 | args=('Python Application', '', 'Application') |
| 2609 | |
| 2610 | [handler_hand07] |
| 2611 | class=handlers.SMTPHandler |
| 2612 | level=WARN |
| 2613 | formatter=form07 |
| 2614 | args=('localhost', 'from@abc', ['user1@abc', 'user2@xyz'], 'Logger Subject') |
| 2615 | |
| 2616 | [handler_hand08] |
| 2617 | class=handlers.MemoryHandler |
| 2618 | level=NOTSET |
| 2619 | formatter=form08 |
| 2620 | target= |
| 2621 | args=(10, ERROR) |
| 2622 | |
| 2623 | [handler_hand09] |
| 2624 | class=handlers.HTTPHandler |
| 2625 | level=NOTSET |
| 2626 | formatter=form09 |
| 2627 | args=('localhost:9022', '/log', 'GET') |
| 2628 | |
| 2629 | Sections which specify formatter configuration are typified by the following. :: |
| 2630 | |
| 2631 | [formatter_form01] |
| 2632 | format=F1 %(asctime)s %(levelname)s %(message)s |
| 2633 | datefmt= |
| 2634 | class=logging.Formatter |
| 2635 | |
| 2636 | The ``format`` entry is the overall format string, and the ``datefmt`` entry is |
Christian Heimes | 5b5e81c | 2007-12-31 16:14:33 +0000 | [diff] [blame] | 2637 | the :func:`strftime`\ -compatible date/time format string. If empty, the |
| 2638 | package substitutes ISO8601 format date/times, which is almost equivalent to |
| 2639 | specifying the date format string ``"%Y-%m-%d %H:%M:%S"``. The ISO8601 format |
| 2640 | also specifies milliseconds, which are appended to the result of using the above |
| 2641 | format string, with a comma separator. An example time in ISO8601 format is |
| 2642 | ``2003-01-23 00:29:50,411``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 2643 | |
| 2644 | The ``class`` entry is optional. It indicates the name of the formatter's class |
| 2645 | (as a dotted module and class name.) This option is useful for instantiating a |
| 2646 | :class:`Formatter` subclass. Subclasses of :class:`Formatter` can present |
| 2647 | exception tracebacks in an expanded or condensed format. |
| 2648 | |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2649 | |
| 2650 | Configuration server example |
| 2651 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 2652 | |
| 2653 | Here is an example of a module using the logging configuration server:: |
| 2654 | |
| 2655 | import logging |
| 2656 | import logging.config |
| 2657 | import time |
| 2658 | import os |
| 2659 | |
| 2660 | # read initial config file |
| 2661 | logging.config.fileConfig("logging.conf") |
| 2662 | |
| 2663 | # create and start listener on port 9999 |
| 2664 | t = logging.config.listen(9999) |
| 2665 | t.start() |
| 2666 | |
| 2667 | logger = logging.getLogger("simpleExample") |
| 2668 | |
| 2669 | try: |
| 2670 | # loop through logging calls to see the difference |
| 2671 | # new configurations make, until Ctrl+C is pressed |
| 2672 | while True: |
| 2673 | logger.debug("debug message") |
| 2674 | logger.info("info message") |
| 2675 | logger.warn("warn message") |
| 2676 | logger.error("error message") |
| 2677 | logger.critical("critical message") |
| 2678 | time.sleep(5) |
| 2679 | except KeyboardInterrupt: |
| 2680 | # cleanup |
| 2681 | logging.config.stopListening() |
| 2682 | t.join() |
| 2683 | |
| 2684 | And here is a script that takes a filename and sends that file to the server, |
| 2685 | properly preceded with the binary-encoded length, as the new logging |
| 2686 | configuration:: |
| 2687 | |
| 2688 | #!/usr/bin/env python |
| 2689 | import socket, sys, struct |
| 2690 | |
| 2691 | data_to_send = open(sys.argv[1], "r").read() |
| 2692 | |
| 2693 | HOST = 'localhost' |
| 2694 | PORT = 9999 |
| 2695 | s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 2696 | print("connecting...") |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2697 | s.connect((HOST, PORT)) |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 2698 | print("sending config...") |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2699 | s.send(struct.pack(">L", len(data_to_send))) |
| 2700 | s.send(data_to_send) |
| 2701 | s.close() |
Georg Brandl | f694518 | 2008-02-01 11:56:49 +0000 | [diff] [blame] | 2702 | print("complete") |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2703 | |
| 2704 | |
| 2705 | More examples |
| 2706 | ------------- |
| 2707 | |
| 2708 | Multiple handlers and formatters |
| 2709 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 2710 | |
| 2711 | Loggers are plain Python objects. The :func:`addHandler` method has no minimum |
| 2712 | or maximum quota for the number of handlers you may add. Sometimes it will be |
| 2713 | beneficial for an application to log all messages of all severities to a text |
| 2714 | file while simultaneously logging errors or above to the console. To set this |
| 2715 | up, simply configure the appropriate handlers. The logging calls in the |
| 2716 | application code will remain unchanged. Here is a slight modification to the |
| 2717 | previous simple module-based configuration example:: |
| 2718 | |
| 2719 | import logging |
| 2720 | |
| 2721 | logger = logging.getLogger("simple_example") |
| 2722 | logger.setLevel(logging.DEBUG) |
| 2723 | # create file handler which logs even debug messages |
| 2724 | fh = logging.FileHandler("spam.log") |
| 2725 | fh.setLevel(logging.DEBUG) |
| 2726 | # create console handler with a higher log level |
| 2727 | ch = logging.StreamHandler() |
| 2728 | ch.setLevel(logging.ERROR) |
| 2729 | # create formatter and add it to the handlers |
| 2730 | formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") |
| 2731 | ch.setFormatter(formatter) |
| 2732 | fh.setFormatter(formatter) |
| 2733 | # add the handlers to logger |
| 2734 | logger.addHandler(ch) |
| 2735 | logger.addHandler(fh) |
| 2736 | |
| 2737 | # "application" code |
| 2738 | logger.debug("debug message") |
| 2739 | logger.info("info message") |
| 2740 | logger.warn("warn message") |
| 2741 | logger.error("error message") |
| 2742 | logger.critical("critical message") |
| 2743 | |
| 2744 | Notice that the "application" code does not care about multiple handlers. All |
| 2745 | that changed was the addition and configuration of a new handler named *fh*. |
| 2746 | |
| 2747 | The ability to create new handlers with higher- or lower-severity filters can be |
| 2748 | very helpful when writing and testing an application. Instead of using many |
| 2749 | ``print`` statements for debugging, use ``logger.debug``: Unlike the print |
| 2750 | statements, which you will have to delete or comment out later, the logger.debug |
| 2751 | statements can remain intact in the source code and remain dormant until you |
| 2752 | need them again. At that time, the only change that needs to happen is to |
| 2753 | modify the severity level of the logger and/or handler to debug. |
| 2754 | |
| 2755 | |
| 2756 | Using logging in multiple modules |
| 2757 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 2758 | |
| 2759 | It was mentioned above that multiple calls to |
| 2760 | ``logging.getLogger('someLogger')`` return a reference to the same logger |
| 2761 | object. This is true not only within the same module, but also across modules |
| 2762 | as long as it is in the same Python interpreter process. It is true for |
| 2763 | references to the same object; additionally, application code can define and |
| 2764 | configure a parent logger in one module and create (but not configure) a child |
| 2765 | logger in a separate module, and all logger calls to the child will pass up to |
| 2766 | the parent. Here is a main module:: |
| 2767 | |
| 2768 | import logging |
| 2769 | import auxiliary_module |
| 2770 | |
| 2771 | # create logger with "spam_application" |
| 2772 | logger = logging.getLogger("spam_application") |
| 2773 | logger.setLevel(logging.DEBUG) |
| 2774 | # create file handler which logs even debug messages |
| 2775 | fh = logging.FileHandler("spam.log") |
| 2776 | fh.setLevel(logging.DEBUG) |
| 2777 | # create console handler with a higher log level |
| 2778 | ch = logging.StreamHandler() |
| 2779 | ch.setLevel(logging.ERROR) |
| 2780 | # create formatter and add it to the handlers |
| 2781 | formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") |
| 2782 | fh.setFormatter(formatter) |
| 2783 | ch.setFormatter(formatter) |
| 2784 | # add the handlers to the logger |
| 2785 | logger.addHandler(fh) |
| 2786 | logger.addHandler(ch) |
| 2787 | |
| 2788 | logger.info("creating an instance of auxiliary_module.Auxiliary") |
| 2789 | a = auxiliary_module.Auxiliary() |
| 2790 | logger.info("created an instance of auxiliary_module.Auxiliary") |
| 2791 | logger.info("calling auxiliary_module.Auxiliary.do_something") |
| 2792 | a.do_something() |
| 2793 | logger.info("finished auxiliary_module.Auxiliary.do_something") |
| 2794 | logger.info("calling auxiliary_module.some_function()") |
| 2795 | auxiliary_module.some_function() |
| 2796 | logger.info("done with auxiliary_module.some_function()") |
| 2797 | |
| 2798 | Here is the auxiliary module:: |
| 2799 | |
| 2800 | import logging |
| 2801 | |
| 2802 | # create logger |
| 2803 | module_logger = logging.getLogger("spam_application.auxiliary") |
| 2804 | |
| 2805 | class Auxiliary: |
| 2806 | def __init__(self): |
| 2807 | self.logger = logging.getLogger("spam_application.auxiliary.Auxiliary") |
| 2808 | self.logger.info("creating an instance of Auxiliary") |
| 2809 | def do_something(self): |
| 2810 | self.logger.info("doing something") |
| 2811 | a = 1 + 1 |
| 2812 | self.logger.info("done doing something") |
| 2813 | |
| 2814 | def some_function(): |
| 2815 | module_logger.info("received a call to \"some_function\"") |
| 2816 | |
| 2817 | The output looks like this:: |
| 2818 | |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2819 | 2005-03-23 23:47:11,663 - spam_application - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2820 | creating an instance of auxiliary_module.Auxiliary |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2821 | 2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2822 | creating an instance of Auxiliary |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2823 | 2005-03-23 23:47:11,665 - spam_application - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2824 | created an instance of auxiliary_module.Auxiliary |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2825 | 2005-03-23 23:47:11,668 - spam_application - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2826 | calling auxiliary_module.Auxiliary.do_something |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2827 | 2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2828 | doing something |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2829 | 2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2830 | done doing something |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2831 | 2005-03-23 23:47:11,670 - spam_application - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2832 | finished auxiliary_module.Auxiliary.do_something |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2833 | 2005-03-23 23:47:11,671 - spam_application - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2834 | calling auxiliary_module.some_function() |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2835 | 2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2836 | received a call to "some_function" |
Christian Heimes | 043d6f6 | 2008-01-07 17:19:16 +0000 | [diff] [blame] | 2837 | 2005-03-23 23:47:11,673 - spam_application - INFO - |
Christian Heimes | 8b0facf | 2007-12-04 19:30:01 +0000 | [diff] [blame] | 2838 | done with auxiliary_module.some_function() |
| 2839 | |