From f186911e247b287d555852ce73afb721f8eb79b9 Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Tue, 22 Jan 2013 13:12:34 +0000 Subject: Updated logging HOWTO with a diagram. --- Doc/howto/logging.rst | 10 ++++++++++ Doc/howto/logging_flow.png | Bin 0 -> 49648 bytes 2 files changed, 10 insertions(+) create mode 100755 Doc/howto/logging_flow.png diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst index c2a13d9..79f1336 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -330,6 +330,9 @@ of components: loggers, handlers, filters, and formatters. to output. * Formatters specify the layout of log records in the final output. +Log event information is passed between loggers, handlers, filters and +formatters in a :class:`LogRecord` instance. + Logging is performed by calling methods on instances of the :class:`Logger` class (hereafter called :dfn:`loggers`). Each instance has a name, and they are conceptually arranged in a namespace hierarchy using dots (periods) as @@ -374,6 +377,13 @@ You can change this by passing a format string to :func:`basicConfig` with the *format* keyword argument. For all options regarding how a format string is constructed, see :ref:`formatter-objects`. +Logging Flow +^^^^^^^^^^^^ + +The flow of log event information in loggers and handlers is illustrated in the +following diagram. + +.. image:: logging_flow.png Loggers ^^^^^^^ diff --git a/Doc/howto/logging_flow.png b/Doc/howto/logging_flow.png new file mode 100755 index 0000000..a883823 Binary files /dev/null and b/Doc/howto/logging_flow.png differ -- cgit v0.12