<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[11375] CalendarServer/trunk/twext/python/log.py</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/11375">11375</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-06-17 13:40:21 -0700 (Mon, 17 Jun 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Add DefaultLogPublisher</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunktwextpythonlogpy">CalendarServer/trunk/twext/python/log.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunktwextpythonlogpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/twext/python/log.py (11374 => 11375)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/twext/python/log.py        2013-06-17 14:27:32 UTC (rev 11374)
+++ CalendarServer/trunk/twext/python/log.py        2013-06-17 20:40:21 UTC (rev 11375)
</span><span class="lines">@@ -717,6 +717,64 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> 
</span><ins>+# FIXME: This could have a better name.
+class DefaultLogPublisher(object):
+    &quot;&quot;&quot;
+    The default log publisher.  This observer sets up a set of chained observers
+    as follows:
+
+        1. B{rootPublisher} - a L{LogPublisher}
+
+        2. B{filteringObserver}: a L{FilteringLogObserver} that filters out
+           messages using a L{LogLevelFilterPredicate}
+
+        3. B{filteredPublisher} - a L{LogPublisher}
+
+        4. B{legacyLogObserver} - a A{LegacyLogObserver} wired up to
+           L{twisted.python.log.msg}
+
+    The purpose of this class is to provide a default log observer with
+    sufficient hooks to enable applications to add observers that can either
+    receive all log messages, or only log messages that are configured to pass
+    though the L{LogLevelFilterPredicate}::
+
+        from twext.python.log import Logger, ILogObserver
+
+        log = Logger()
+
+        @implementer(ILogObserver)
+        class AMPObserver(object):
+            def __call__(self, event):
+                # eg.: Hold all emitted events in a ring buffer and expose them
+                # via AMP.
+                ...
+
+        @implementer(ILogObserver)
+        class FileObserver(object):
+            def __call__(self, event):
+                # eg.: Take only the filtered events and write them into a
+                # file.
+                ...
+
+        log.publisher.rootPublisher.addObserver(AMPObserver())
+        log.publisher.filteredPublisher.addObserver(FileObserver())
+
+    With no observers added, the default behavior is that the legacy Twisted
+    logging system sees messages as controlled by L{LogLevelFilterPredicate}.
+    &quot;&quot;&quot;
+
+    def __init__(self):
+        self.legacyLogObserver = LegacyLogObserver(twistedLogMessage)
+        self.filteredPublisher = LogPublisher(self.legacyLogObserver)
+        self.filteringObserver = FilteringLogObserver(self.filteredPublisher, (LogLevelFilterPredicate(),))
+        self.rootPublisher     = LogPublisher(self.filteringObserver)
+
+
+    def __call__(self, event):
+        self.rootPublisher(event)
+
+
+
</ins><span class="cx"> #
</span><span class="cx"> # Utilities
</span><span class="cx"> #
</span><span class="lines">@@ -769,13 +827,9 @@
</span><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> #
</span><del>-# Default observers
-# FIXME: ...
</del><ins>+# Wire up default publisher
</ins><span class="cx"> #
</span><del>-theLegacyLogObserver = LegacyLogObserver(twistedLogMessage)
-theFilteredLogPublisher = LogPublisher(theLegacyLogObserver) # Add post-filtering observers here
-theFilteringLogObserver = FilteringLogObserver(theFilteredLogPublisher, (LogLevelFilterPredicate(),))
-Logger.publisher = LogPublisher(theFilteringLogObserver) # Add pre-filtering observers here
</del><ins>+Logger.publisher = DefaultLogPublisher()
</ins><span class="cx"> 
</span><span class="cx"> 
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>