]> granicus.if.org Git - python/commitdiff
Logging documentation - further update.
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Sun, 12 Dec 2010 13:25:29 +0000 (13:25 +0000)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Sun, 12 Dec 2010 13:25:29 +0000 (13:25 +0000)
Doc/library/logging.rst

index 29854a40f02d06843be452d39b467e2de105e39d..8cfb7d51c344eb9380b9514552ae1899167e5b8e 100644 (file)
@@ -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