progress.md

Logging HOWTO

• Basic Logging Tutorial
  • When to use logging
  • A simple example
  • Logging to a file
  • Logging from multiple modules
  • Logging variable data
  • Changing the format of displayed messages
  • Displaying the date/time in messages
  • Next Steps
• Advanced Logging Tutorial
  • Logging Flow
  • Loggers
  • Handlers
  • Formatters
  • Configuring Logging
  • What happens if no configuration is provided
  • Configuring Logging for a Library
• Logging Levels
  • Custom Levels
• Useful Handlers
• Exceptions raised during logging
• Using arbitrary objects as messages
• Optimization

Logging Cookbook

• Using logging in multiple modules
• Multiple handlers and formatters
• Logging to multiple destinations
• Configuration server example
• Sending and receiving logging events across a network
• Adding contextual information to your logging output
  • Using LoggerAdapters to impart contextual information
    • Using objects other than dicts to pass contextual information
  • Using Filters to impart contextual information
• Logging to a single file from multiple processes
• Using file rotation
• An example dictionary-based configuration
• Inserting a BOM into messages sent to a SysLogHandler
• Implementing structured logging
• Customizing handlers with dictConfig()
• Configuring filters with dictConfig()

logging — Logging facility for Python

• Logger Objects
• Logging Levels
• Handler Objects
• Formatter Objects
• Filter Objects
• LogRecord Objects
• LogRecord attributes
• LoggerAdapter Objects
• Thread Safety
• Module-Level Functions
• Integration with the warnings module

logging.config — Logging configuration

• Configuration functions
• Configuration dictionary schema
  • Dictionary Schema Details
  • Incremental Configuration
  • Object connections
  • User-defined objects
  • Access to external objects
  • Access to internal objects
  • Import resolution and custom importers
• Configuration file format

logging.handlers — Logging handlers

• StreamHandler
• FileHandler
• NullHandler
• WatchedFileHandler
• RotatingFileHandler
• TimedRotatingFileHandler
• SocketHandler
• DatagramHandler
• SysLogHandler
• NTEventLogHandler
• SMTPHandler
• MemoryHandler
• HTTPHandler

warnings — Warning control

• Warning Categories
• The Warnings Filter
  • Default Warning Filters
• Temporarily Suppressing Warnings
• Testing Warnings
• Updating Code For New Versions of Python
• Available Functions
• Available Context Managers

Other Reading

• https://docs.python.org/2/tutorial/stdlib2.html#logging
• https://docs.python.org/2/library/multiprocessing.html#logging
• https://docs.python.org/2/whatsnew/2.3.html#pep-282-the-logging-package
• http://legacy.python.org/dev/peps/pep-0282/
• https://docs.python.org/2/whatsnew/2.7.html#pep-391-dictionary-based-configuration-for-logging
• http://legacy.python.org/dev/peps/pep-0391/
• https://docs.python.org/2/whatsnew/2.1.html#pep-230-warning-framework
• http://legacy.python.org/dev/peps/pep-0230/