<!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>[15618] CalendarServer/trunk/calendarserver/tools/dashcollect.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/15618">15618</a></dd>
<dt>Author</dt> <dd>dre@apple.com</dd>
<dt>Date</dt> <dd>2016-05-19 15:17:08 -0700 (Thu, 19 May 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Enhance dashcollect docstring</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarservertoolsdashcollectpy">CalendarServer/trunk/calendarserver/tools/dashcollect.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarservertoolsdashcollectpy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/tools/dashcollect.py (15617 => 15618)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/tools/dashcollect.py 2016-05-19 22:04:51 UTC (rev 15617)
+++ CalendarServer/trunk/calendarserver/tools/dashcollect.py 2016-05-19 22:17:08 UTC (rev 15618)
</span><span class="lines">@@ -15,52 +15,14 @@
</span><span class="cx"> # limitations under the License.
</span><span class="cx"> ##
</span><span class="cx">
</span><del>-from collections import OrderedDict
-from datetime import datetime, date
-from threading import Thread
-import SocketServer
-import argparse
-import errno
-import json
-import os
-import sched
-import socket
-import sys
-import time
-
</del><span class="cx"> """
</span><span class="cx"> A service that logs dashboard data from multiple hosts and stores them in
</span><span class="cx"> log files. It can also, optionally, make the most recent data available
</span><span class="cx"> for retrieval via a simple TCP socket read on a specific port.
</span><del>-"""
</del><span class="cx">
</span><del>-"""
-JSON schema for servers file:
</del><ins>+This tool uses its own config file, specified with the '-f' option. A
+sample is shown below:
</ins><span class="cx">
</span><del>-; root object
-OBJECT (title, pods)
-
-; Title/description of this config
-MEMBER title "title" : STRING
-
-; pods - set of pods to monitor
-MEMBER pods "pod" : Object (
- *pod
-)
-
-; An event type
-MEMBER pod "" : Object(
- ?description, servers
-)
-
-; The description of a pod
-MEMBER description "description" : STRING
-
-; Servers associated with a pod
-; Server names are either "host:port", or "unix:path"
-MEMBER servers "servers" : ARRAY STRING
-
-Example:
</del><span class="cx"> {
</span><span class="cx"> "title": "My CalDAV service",
</span><span class="cx"> "pods": {
</span><span class="lines">@@ -82,6 +44,19 @@
</span><span class="cx"> }
</span><span class="cx"> """
</span><span class="cx">
</span><ins>+from collections import OrderedDict
+from datetime import datetime, date
+from threading import Thread
+import SocketServer
+import argparse
+import errno
+import json
+import os
+import sched
+import socket
+import sys
+import time
+
</ins><span class="cx"> verbose = False
</span><span class="cx"> def _verbose(log):
</span><span class="cx"> if verbose:
</span><span class="lines">@@ -90,8 +65,16 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> def main():
</span><del>- parser = argparse.ArgumentParser(description="Dashboard service for CalendarServer.")
- parser.add_argument("-f", help="Server config file")
</del><ins>+ try:
+ # to produce a docstring target
+ thisFile = __file__
+ except NameError:
+ # unlikely but possible...
+ thisFile = sys.argv[0]
+ parser = argparse.ArgumentParser(
+ description="Dashboard service for CalendarServer.",
+ epilog="To view the docstring, run: pydoc {}".format(thisFile))
+ parser.add_argument("-f", help="Server config file (see docstring for details)")
</ins><span class="cx"> parser.add_argument("-l", help="Log file directory")
</span><span class="cx"> parser.add_argument("-n", action="store_true", help="New log file")
</span><span class="cx"> parser.add_argument("-s", default="localhost:8200", help="Run the dash_thread service on the specified host:port")
</span><span class="lines">@@ -143,6 +126,31 @@
</span><span class="cx"> class Config(object):
</span><span class="cx"> """
</span><span class="cx"> Loads the config and creates a list of L{Pod}'s.
</span><ins>+
+ JSON schema for server config file:
+
+ ; root object
+ OBJECT (title, pods)
+
+ ; Title/description of this config
+ MEMBER title "title" : STRING
+
+ ; pods - set of pods to monitor
+ MEMBER pods "pod" : Object (
+ *pod
+ )
+
+ ; An event type
+ MEMBER pod "" : Object(
+ ?description, servers
+ )
+
+ ; The description of a pod
+ MEMBER description "description" : STRING
+
+ ; Servers associated with a pod
+ ; Server names are either "host:port", or "unix:path"
+ MEMBER servers "servers" : ARRAY STRING
</ins><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> def loadFromFile(self, path):
</span></span></pre>
</div>
</div>
</body>
</html>