Changeset 1261

Timestamp:

04/27/06 11:37:50 (3 years ago)

Author:

kevin

Message:

much improved logging configuration

Files:

• branches/1.0/CHANGELOG.txt (modified) (1 diff)
• branches/1.0/setup.py (modified) (1 diff)
• branches/1.0/turbogears/config.py (modified) (3 diffs)
• branches/1.0/turbogears/controllers.py (modified) (1 diff)
• branches/1.0/turbogears/qstemplates/quickstartbig/+package+/controllers/root.py_tmpl (modified) (1 diff)
• branches/1.0/turbogears/qstemplates/quickstart/dev.cfg_tmpl (modified) (1 diff)
• branches/1.0/turbogears/qstemplates/quickstart/+package+/controllers.py_tmpl (modified) (2 diffs)
• branches/1.0/turbogears/qstemplates/quickstart/sample-prod.cfg_tmpl (modified) (1 diff)
• branches/1.0/turbogears/startup.py (modified) (2 diffs)
• branches/1.0/turbogears/tests/config.cfg (modified) (1 diff)
• branches/1.0/turbogears/tests/test_config.py (modified) (3 diffs)

branches/1.0/CHANGELOG.txt

@@ -16 +16 @@
-  permissionId to be user\_name, group\_name, and permission_name.
-* visit\_id has been deprecated in favor of visit_key
+
+*Features*
+
+* Dramatically improved and unified logging configuration. Config files
+  can now use the options in Python's logging module for log formats
+  and output.
-
-*Changes*

branches/1.0/setup.py

@@ -42 +42 @@
-        "cElementTree >= 1.0.5", "FormEncode >= 0.5.1",
-        "setuptools >= 0.6a11",
-
+ConfigObj >= 4.3.0", "
-    packages=find_packages(),
-    include_package_data=True,

branches/1.0/turbogears/config.py

@@ -2 +2 @@
-
-from cherrypy import config
+from configobj import ConfigObj
-import pkg_resources
-
+
-
-__all__ = ["update_config", "get", "update"]
@@ -12 +13 @@
-    from sets import Set as set
-
+class ConfigError(Exception):
+    pass
+
+def _get_formatters(formatters):
+    for key, formatter in formatters.items():
+        kw = {}
+        fmt = formatter.get("format", None)
+        if fmt:
+            fmt = fmt.replace("*(", "%(")
+            kw["fmt"] = fmt
+        datefmt = formatter.get("datefmt", None)
+        if datefmt:
+            kw["datefmt"] = datefmt
+        formatter = logging.Formatter(**kw)
+        formatters[key] = formatter
+
+def _get_handlers(handlers, formatters):
+    for key, handler in handlers.items():
+        kw = {}
+        cls = handler.get("class", None)
+        if not cls:
+            raise ConfigError("No class specified for logging handler %s" 
+                              % key)
+        cls = eval(cls, logging.__dict__)
+        args = handler.get("args", tuple())
+        if args:
+            args = eval(args, logging.__dict__)
+        handler_obj = cls(*args)
+        level = handler.get("level", None)
+        if level:
+            level = eval(level, logging.__dict__)
+            handler_obj.setLevel(level)
+        formatter = handler.get("formatter", None)
+        if formatter:
+            try:
+                formatter = formatters[formatter]
+            except KeyError:
+                raise ConfigError("Handler %s references unknown "
+                            "formatter %s" % (key, formatter))
+            handler_obj.setFormatter(formatter)
+        handlers[key] = handler_obj
+
+def _get_loggers(loggers, handlers):
+    for key, logger in loggers.items():
+        qualname = logger.get("qualname", None)
+        if qualname:
+            log = logging.getLogger(qualname)
+        else:
+            log = logging.getLogger()
+            
+        level = logger.get("level", None)
+        if level:
+            level = eval(level, logging.__dict__)
+        else:
+            level = logging.NOTSET
+        log.setLevel(level)
+        
+        propagate = logger.get("propagate", None)
+        if propagate is not None:
+            log.propagate = propagate
+        
+        cfghandlers = logger.get("handlers", None)
+        if cfghandlers:
+            if isinstance(cfghandlers, basestring):
+                cfghandlers = [cfghandlers]
+            for handler in cfghandlers:
+                try:
+                    handler = handlers[handler]
+                except KeyError:
+                    raise ConfigError("Logger %s references unknown "
+                                "handler %s" % (key, handler))
+                log.addHandler(handler)
+
+def configure_loggers(config):
+    """Configures the Python logging module, using options that are very
+    similar to the ones listed in the Python documentation. This also
+    removes the logging configuration from the configuration dictionary
+    because CherryPy doesn't like it there. Here are some of the Python
+    examples converted to the format used here:
+    
+    [logging]
+    [[loggers]]
+    [[[parser]]]
+    [logger_parser]
+    level="DEBUG"
+    handlers="hand01"
+    propagate=1
+    qualname="compiler.parser"
+
+    [[handlers]]
+    [[[hand01]]]
+    class="StreamHandler"
+    level="NOTSET"
+    formatter="form01"
+    args="(sys.stdout,)"
+    
+    [[formatters]]
+    [[[form01]]]
+    format="F1 *(asctime)s *(levelname)s *(message)s"
+    datefmt=
+    
+    
+    One notable format difference is that *() is used in the formatter
+    instead of %() because %() is already used for config file
+    interpolation.
+    """
+    if not config.has_key("logging"):
+        config["global"]["tg.new_style_logging"] = False
+        return
+    logcfg = config["logging"]
+    formatters = logcfg.get("formatters", {})
+    _get_formatters(formatters)
+    
+    handlers = logcfg.get("handlers", {})
+    _get_handlers(handlers, formatters)
+    
+    loggers = logcfg.get("loggers", {})
+    _get_loggers(loggers, handlers)
+    
+    del config["logging"]
+    config["global"]["tg.new_style_logging"] = True
-
-def update_config(configfile = None, modulename = None):
@@ -33 +155 @@
-        package_dir = pkg_resources.resource_filename(
-                        packagename, "")[:-1].replace("\\", "/")
-
-
-
-
+
+
+
-
-    if configfile:
-        if modulename:
-
-
-
-
+
+
+
-        else:
-
+
+
+
+
-
-def get(key, default_value=None, return_section=False, path = None):

branches/1.0/turbogears/controllers.py

@@ -307 +307 @@
-    """
-    is_app_root = True
+    
+    msglog = logging.getLogger('cherrypy.msg')
+    msglogfunc = {0: msglog.info, 1: msglog.warning, 2: msglog.error}
+    def _cp_log_message(self, msg, context = 'nocontext', severity = 0):
+        log = self.msglogfunc[severity]
+        text = ''.join((context, ': ', msg))
+        log(text)
+    
+    accesslog = logging.getLogger("turbogears.access")
+    def _cp_log_access(self):
+        tmpl = '%(h)s %(l)s %(u)s "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s"'
+        identity = getattr(cherrypy.request, "identity", None)
+        if not identity:
+            username = "-"
+        else:
+            username = identity.user_name
+        s = tmpl % {'h': cherrypy.request.remoteHost,
+                   'l': '-',
+                   'u': username,
+                   'r': cherrypy.request.requestLine,
+                   's': cherrypy.response.status.split(" ", 1)[0],
+                   'b': cherrypy.response.headers.get('Content-Length',
+                            '') or "-",
+                   'f': cherrypy.request.headers.get('referer', ''),
+                   'a': cherrypy.request.headers.get('user-agent', ''),
+        }
+        self.accesslog.info(s)
-
-Root = RootController

branches/1.0/turbogears/qstemplates/quickstartbig/+package+/controllers/root.py_tmpl

@@ +1 @@
+import logging
+
-import cherrypy
+
-import turbogears
-
+
+
-from turbogears import identity
+#end if
+
+from ${package} import json
+
+log = logging.getLogger("${package}.controllers")
-
-class Root(controllers.RootController):
-turbogears.
+
-    def index(self):
-        import time
+        log.debug("Happy TurboGears Controller Responding For Duty")
-        return dict(now=time.ctime())
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        else:
- 
-previous
+
+forward
-        cherrypy.response.status=403
-        return dict(message=msg, previous_url=previous_url, logging_in=True,
-
+
+
-
-turbogears.
+
-    def logout(self):
-        identity.current.logout()
-
+
+

branches/1.0/turbogears/qstemplates/quickstart/dev.cfg_tmpl

@@ -36 +36 @@
-tg.strict_parameters = True
-
+# LOGGING
+# Logging configuration generally follows the style of the standard
+# Python logging module configuration. Note that when specifying
+# log format messages, you need to use *() for formatting variables.
+[logging]
+
+[[formatters]]
+[[[messageonly]]]
+format='*(message)s'
+
+[[[fullcontent]]]
+format='*(asctime)s *(name)s *(levelname)s *(message)s'
+
+[[handlers]]
+[[[debugout]]]
+class='StreamHandler'
+level='DEBUG'
+args='(sys.stdout,)'
+formatter='fullcontent'
+
+[[[accessout]]]
+class='StreamHandler'
+level='INFO'
+args='(sys.stdout,)'
+formatter='messageonly'
+
+[[loggers]]
+[[[yourproject]]]
+level='DEBUG'
+qualname='${package}'
+handlers=['debugout']
+
+[[[cherrymsg]]]
+level='INFO'
+qualname='cherrypy.msg'
+handlers=['debugout']
+
+[[[access]]]
+level='INFO'
+qualname='turbogears.access'
+handlers=['accessout']
+propagate=0

branches/1.0/turbogears/qstemplates/quickstart/+package+/controllers.py_tmpl

@@ +1 @@
+import logging
+
-import cherrypy
+
-import turbogears
-from turbogears import controllers, expose, redirect
+#if $identity != "none"
-from turbogears import identity
+#end if
-
-from ${package} import json
+
+log = logging.getLogger("${package}.controllers")
-
-class Root(controllers.RootController):
@@ -10 +17 @@
-    def index(self):
-        import time
+        log.debug("Happy TurboGears Controller Responding For Duty")
-        return dict(now=time.ctime())
-#if $identity != "none"

branches/1.0/turbogears/qstemplates/quickstart/sample-prod.cfg_tmpl

@@ -40 +40 @@
-# tg.strict_parameters = False
-
+# LOGGING
+# Logging configuration generally follows the style of the standard
+# Python logging module configuration. Note that when specifying
+# log format messages, you need to use *() for formatting variables.
+[logging]
+
+[[formatters]]
+[[[messageonly]]]
+format='*(message)s'
+
+[[handlers]]
+[[[errorout]]]
+class='StreamHandler'
+level='ERROR'
+args='(sys.stdout,)'
+
+[[[accessout]]]
+class='StreamHandler'
+level='INFO'
+args="('server.log',)"
+formatter='messageonly'
+
+[[loggers]]
+[[[yourproject]]]
+level='ERROR'
+qualname='${package}'
+handlers=['errorout']
+
+[[[access]]]
+level='INFO'
+qualname='turbogears.access'
+handlers=['accessout']
+propagate=0

branches/1.0/turbogears/startup.py

@@ -184 +184 @@
-        webpath = webpath + "/"
-    isdev = turbogears.config.get('server.environment') == 'development'
-
+
+
+
-        log = logging.getLogger()
-        log.setLevel(logging.DEBUG)
@@ -190 +192 @@
-        handler = logging.StreamHandler(sys.stdout)
-        handler.setLevel(logging.DEBUG)
+        handler.setFormatter(fmt)
+        log.addHandler(handler)
+        
+        log = logging.getLogger("turbogears.access")
+        log.propagate = 0
+        fmt = logging.Formatter("%(message)s")
+        handler = logging.StreamHandler(sys.stdout)
+        handler.setLevel(logging.INFO)
-        handler.setFormatter(fmt)
-        log.addHandler(handler)

branches/1.0/turbogears/tests/config.cfg

@@ -7 +7 @@
-[/static]
-static_filter.on = True
+
+[logging]
+[[formatters]]
+[[[coolformat]]]
+format="F1 *(asctime)s *(levelname)s *(message)s"
+datefmt=
+
+[[handlers]]
+[[[mystream]]]
+class='StreamHandler'
+level='NOTSET'
+formatter='coolformat'
+args='(logout,)'
+
+[[loggers]]
+[[[tester]]]
+level='DEBUG'
+handlers=['mystream']
+propogate=1
+qualname="turbogears.tests.test_config.logconfig"

branches/1.0/turbogears/tests/test_config.py

@@ -1 +1 @@
-import turbogears
-import pkg_resources
+import sys
+from cStringIO import StringIO
+import logging
+import re
-
-testfile = pkg_resources.resource_filename(__name__, "configfile.cfg")
-
-rfn = pkg_resources.resource_filename
+
+logout = StringIO()
+logging.logout = logout
-
-def test_update_from_package():
@@ -17 +24 @@
-    turbogears.update_config(configfile = testfile, 
-        modulename="turbogears.tests.config")
+    print turbogears.config.get("foo.bar")
-    assert turbogears.config.get("foo.bar") == "blurb"
-    assert turbogears.config.get("tg.something") == 10
@@ -39 +47 @@
-    print testdir
-    assert testdir == "c:/foo/bar"
+
+def test_logging_config():
+    logout.truncate(0)
+    log = logging.getLogger("turbogears.tests.test_config.logconfig")
+    log.info("Testing")
+    logged = logout.getvalue()
+    print "Logged: %s" % logged
+    assert re.match(r'F1 \d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d,\d\d\d INFO '
+                    'Testing', logged)
+    assert turbogears.config.get("tg.new_style_logging", False)
-        
-def teardown_module():