From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Sun, 12 Dec 2010 13:25:29 +0000 (+0000)
Subject: Logging documentation - further update.
X-Git-Tag: v3.2b2~140
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5286ccfdf8629a6dccad256696cc60000938a45c;p=python

Logging documentation - further update.
---

diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 29854a40f0..8cfb7d51c3 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -319,6 +319,14 @@ separators. For example, a logger named "scan" is the parent of loggers
 "scan.text", "scan.html" and "scan.pdf". Logger names can be anything you want,
 and indicate the area of an application in which a logged message originates.
 
+A good convention to use when naming loggers is to use a module-level logger,
+in each module which uses logging, named as follows::
+
+   logger = logging.getLogger(__name__)
+
+This means that logger names track the package/module hierarchy, and it's
+intuitively obvious where events are logged just from the logger name.
+
 The root of the hierarchy of loggers is called the root logger. That's the
 logger used by the functions :func:`debug`, :func:`info`, :func:`warning`,
 :func:`error` and :func:`critical`, which just call the same-named method of