<!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>[12653] CalendarServer/trunk/calendarserver/webadmin/logs.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/12653">12653</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2014-02-11 12:16:08 -0800 (Tue, 11 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add main log observer</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverwebadminlogspy">CalendarServer/trunk/calendarserver/webadmin/logs.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarserverwebadminlogspy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/webadmin/logs.py (12652 => 12653)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/logs.py 2014-02-11 19:03:36 UTC (rev 12652)
+++ CalendarServer/trunk/calendarserver/webadmin/logs.py 2014-02-11 20:16:08 UTC (rev 12653)
</span><span class="lines">@@ -30,6 +30,7 @@
</span><span class="cx">
</span><span class="cx"> from zope.interface import implementer
</span><span class="cx">
</span><ins>+from twisted.python.log import FileLogObserver
</ins><span class="cx"> from twisted.internet.defer import succeed
</span><span class="cx">
</span><span class="cx"> from txweb2.stream import IByteStream, fallbackSplit
</span><span class="lines">@@ -90,17 +91,20 @@
</span><span class="cx"> def __init__(self):
</span><span class="cx"> Resource.__init__(self)
</span><span class="cx">
</span><del>- logObserver = AccessLoggingObserver()
- logObserver.start()
</del><span class="cx">
</span><del>- self._observer = logObserver
</del><ins>+ @property
+ def events(self):
+ if not hasattr(self, "_buffer"):
+ buffer = deque(maxlen=100)
</ins><span class="cx">
</span><del>- # self._observer.logMessage(u"Hello")
- # self._observer.logMessage(u"Yo")
- # self._observer.logMessage(u"Bonjour")
- # self._observer.logMessage(u"Hola")
</del><ins>+ AccessLogObserver(buffer).start()
+ BufferingLogObserver(buffer).start()
</ins><span class="cx">
</span><ins>+ self._buffer = buffer
</ins><span class="cx">
</span><ins>+ return self._buffer
+
+
</ins><span class="cx"> def render(self, request):
</span><span class="cx"> start = request.headers.getRawHeaders("last-event-id")
</span><span class="cx">
</span><span class="lines">@@ -111,7 +115,7 @@
</span><span class="cx"> start = None
</span><span class="cx">
</span><span class="cx"> response = Response()
</span><del>- response.stream = LogObservingEventStream(self._observer, start)
</del><ins>+ response.stream = LogEventStream(self, start)
</ins><span class="cx"> response.headers.setHeader(
</span><span class="cx"> "content-type", MimeType.fromString("text/event-stream")
</span><span class="cx"> )
</span><span class="lines">@@ -120,19 +124,18 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @implementer(IByteStream)
</span><del>-class LogObservingEventStream(object):
</del><ins>+class LogEventStream(object):
</ins><span class="cx"> """
</span><del>- L{IStream} that observes log events and streams them out as HTML5
- EventSource events.
</del><ins>+ L{IByteStream} that streams log events out as HTML5 EventSource events.
</ins><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> length = None
</span><span class="cx">
</span><span class="cx">
</span><del>- def __init__(self, observer, start):
</del><ins>+ def __init__(self, source, start):
</ins><span class="cx"> object.__init__(self)
</span><span class="cx">
</span><del>- self._observer = observer
</del><ins>+ self._source = source
</ins><span class="cx"> self._start = start
</span><span class="cx"> self._closed = False
</span><span class="cx">
</span><span class="lines">@@ -144,7 +147,7 @@
</span><span class="cx"> start = self._start
</span><span class="cx"> messageID = None
</span><span class="cx">
</span><del>- for event in self._observer.events():
</del><ins>+ for eventClass, event in self._source.events:
</ins><span class="cx"> messageID = id(event)
</span><span class="cx">
</span><span class="cx"> # If we have a start point, skip messages up to and including the
</span><span class="lines">@@ -158,7 +161,10 @@
</span><span class="cx">
</span><span class="cx"> self._start = messageID
</span><span class="cx">
</span><del>- message = event["log-format"] % event
</del><ins>+ if eventClass == "access":
+ message = event["log-format"] % event
+ else:
+ message = unicode(event)
</ins><span class="cx">
</span><span class="cx"> eventText = textAsEvent(
</span><span class="cx"> message, eventID=messageID, eventClass=u"access"
</span><span class="lines">@@ -170,6 +176,7 @@
</span><span class="cx"> # We just scanned all the messages, and none are the last one the
</span><span class="cx"> # client saw.
</span><span class="cx"> self._start = None
</span><ins>+ return succeed("-" * 80)
</ins><span class="cx"> return self.read()
</span><span class="cx">
</span><span class="cx"> return succeed(None)
</span><span class="lines">@@ -184,21 +191,41 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><del>-# Note: CommonAccessLoggingObserverExtensions is an old-style log observer, as
-# it inherits from BaseCommonAccessLoggingObserver in txweb2.
</del><ins>+class BufferingLogObserver(FileLogObserver):
+ """
+ Log observer that captures events in a buffer instead of writing to a file.
</ins><span class="cx">
</span><del>-class AccessLoggingObserver(CommonAccessLoggingObserverExtensions):
</del><ins>+ @note: L{BufferingLogObserver} is an old-style log observer, as it
+ inherits from L{FileLogObserver}.
</ins><span class="cx"> """
</span><ins>+
+ def __init__(self, buffer):
+ class IO(object):
+ @staticmethod
+ def write(s):
+ buffer.append((u"server", s))
+
+ @staticmethod
+ def flush():
+ pass
+
+ FileLogObserver.__init__(self, IO)
+
+
+
+class AccessLogObserver(CommonAccessLoggingObserverExtensions):
+ """
</ins><span class="cx"> Log observer that captures apache-style access log text entries in a
</span><span class="cx"> buffer.
</span><span class="cx">
</span><del>- @note: L{AccessLoggingObserver} is an old-style log observer, as it
</del><ins>+ @note: L{AccessLogObserver} is an old-style log observer, as it
</ins><span class="cx"> ultimately inherits from L{txweb2.log.BaseCommonAccessLoggingObserver}.
</span><span class="cx"> """
</span><del>- def __init__(self):
</del><ins>+
+ def __init__(self, buffer):
</ins><span class="cx"> CommonAccessLoggingObserverExtensions.__init__(self)
</span><span class="cx">
</span><del>- self._buffer = deque(maxlen=100)
</del><ins>+ self._buffer = buffer
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> def logStats(self, event):
</span><span class="lines">@@ -206,18 +233,10 @@
</span><span class="cx"> if event["type"] != "access-log":
</span><span class="cx"> return
</span><span class="cx">
</span><del>- # # Omit events for the log event stream
- # if event["uri"] == "/admin/logs/events":
- # return
</del><ins>+ self._buffer.append((u"access", event))
</ins><span class="cx">
</span><del>- self._buffer.append(event)
</del><span class="cx">
</span><span class="cx">
</span><del>- def events(self):
- return iter(self._buffer)
-
-
-
</del><span class="cx"> def textAsEvent(text, eventID=None, eventClass=None):
</span><span class="cx"> event = []
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>