[Git][NTPsec/ntpsec][master] Improve descriptions and formating

Wed Aug 31 03:17:12 UTC 2016

Gary E. Miller pushed to branch master at NTPsec / ntpsec


Commits:
af29d818 by Gary E. Miller at 2016-08-30T20:15:37-07:00
Improve descriptions and formating

- - - - -


1 changed file:

- ntpstats/ntpviz


Changes:

=====================================
ntpstats/ntpviz
=====================================

--- a/ntpstats/ntpviz
+++ b/ntpstats/ntpviz
@@ -82,7 +82,7 @@ set rmargin 12
             return ''
         sitename = self.sitename
         plot_template = NTPViz.Common + """\
-set title "%(sitename)s: Local Clock Offset"
+set title "%(sitename)s: Local Clock Time/Frequency Offsets"
 set ytics format "@1.2f μs" nomirror textcolor rgb '#0060ad'
 set y2tics format "@2.3f ppm" nomirror textcolor rgb '#dd181f'
 set key bottom right box
@@ -558,20 +558,20 @@ if __name__ == '__main__':
 
     explanations = {
         "local-offset": """\
-<p>This graph can be used to see the relationship between the frequency
-offset of the local clock (red, in parts per million, right) against
-the local clock offset (blue, in μs). Quick changes in frequency will lead to
-larger clock offsets.</p>
+<p>The offsets of the ntpd calculated time and the local system clock.
+Showing frequency offset (red, in parts per million, scale on right) and the
+frequency offset (blue, in μs, scale on left). Quick changes in time offset
+will lead to larger frequency offsets.</p>
 """,
+
         "local-error": """\
 <p>This shows the frequency offset of the local clock.  It includes
 percentile data to show how much the frequency changes over a longer
 period of time.  The majority of this change should come from
 temperature changes (ex: HVAC, the weather, CPU usage causing local
 heating).</p>
-<p>Smaller changes are better.  An ideal clock would be a flat line at 0ppm.</p>
-<p>Expected values: within ±500ppm of 0</p>
-<p>Expected values of 99%-1% percentiles: within 10ppm of 0</p>
+<p>Smaller changes are better.  An ideal result would be a flat line at 0ppm.</p>
+<p>Expected values of 99%-1% percentiles: 0.4ppm</p>
 """,
         "local-offset-histogram": """\
 <p>This shows the clock offsets of the local clock as a histogram.  It
@@ -629,8 +629,18 @@ and response and offset all went in the same direction).<p>
 <meta http-equiv="refresh" content="1800">
 <meta name="expires" content="0">
 <title>ntpviz plot</title>
+<style>
+dt {
+    font-weight: bold;
+}
+dd {
+    margin-bottom: 4px;
+    margin-bottom: 10px;
+}
+</style>
 </head>
 <body>
+<div style="width:910px">
 <a href='https://www.ntpsec.org/'>
 <img src="ntpsec-logo.png" alt="NTPsec" style="float:left;margin:5px 50px;">
 </a>
@@ -651,35 +661,35 @@ and response and offset all went in the same direction).<p>
 <h2>Glossary:</h2>
 
 <dl>
-<dt>clock offset</dt>
-<dd>The difference between the actual time and the local clock's time.
-    (Also can be called phase offset)</dd>
-
-<dt>frequency offset</dt>
-<dd>The difference between the local clock's actual frequency and its
-    expected frequency (usually in parts per million, ppm)</dd>
+<dt>frequency offset:</dt>
+<dd>The difference between the ntpd calcualted frequency and the local
+system clock frequency (usually in parts per million, ppm)</dd>
 
-<dt>jitter</dt>
+<dt>jitter:</dt>
 <dd>The short term change in a value</dd>
 
-<dt>ms, millisecond</dt>
+<dt>ms, millisecond:</dt>
 <dd>One thousandth of a second = 0.001s</dd>
 
-<dt>ppm, parts per million</dt>
+<dt>ppm, parts per million:</dt>
 <dd>Ratio between two values. These following are all the same:
     1 ppm, one in one million, 1/1000000, 0.000001, and 0.0001%</dd>
 
-<dt>refclock</dt>
-<dd>Reference clock, from a GPS module or other source of time.</dd>
+<dt>refclock:</dt>
+<dd>Reference clock, a local GPS module or other local source of time.</dd>
 
-<dt>remote clock</dt>
+<dt>remote clock:</dt>
 <dd>Any clock reached over the network, LAN or WAN.</dd>
 
-<dt>upstream clock</dt>
+<dt>time offset:</dt>
+<dd>The difference between the ntpd calculated time and the local system
+ clock's time.  (Also can be called phase offset)</dd>
+
+<dt>upstream clock:</dt>
 <dd>Any remote clock or reference clock used as a source of time.</dd>
 
-<dt>µs, us, microsecond</dt>
-<dd>One millionth of a second, and one thousandth of a millisecond,
+<dt>µs, us, microsecond:</dt>
+<dd>One millionth of a second, also one thousandth of a millisecond,
 0.0000001s.</dd>
 </dl>
 
@@ -703,6 +713,7 @@ ntpviz</a>, part of the <a href="https://www.ntpsec.org/">NTPsec project</a>
     </a>
 </div>
 <div style="clear:both;"></div>
+</div>
 </body>
 </html>
 '''



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/af29d818f44e2bd1f00a26762ab2f6392bddab29
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20160831/e840f5d7/attachment.html>
