[Git][NTPsec/ntpsec][master] Tweak the ntpviz explanations.
Gary E. Miller
gitlab at mg.gitlab.com
Fri Sep 30 23:23:14 UTC 2016
Gary E. Miller pushed to branch master at NTPsec / ntpsec
Commits:
830b8132 by Gary E. Miller at 2016-09-30T16:22:13-07:00
Tweak the ntpviz explanations.
There the data comes from is now always the last item.
- - - - -
1 changed file:
- ntpstats/ntpviz
Changes:
=====================================
ntpstats/ntpviz
=====================================
--- a/ntpstats/ntpviz
+++ b/ntpstats/ntpviz
@@ -162,11 +162,15 @@ plot \
""" % locals()
exp = """\
-<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 time offset (blue, in μs, scale on left). These are fields 4 and 3
-from the loopstats log file. Quick changes in time offset will lead to
-larger frequency offsets.</p>
+<p>The time and frequency offsets between the ntpd calculated time
+and the local system clock. Showing frequency offset (red, in parts
+per million, scale on right) and the time offset (blue, in μs, scale
+on left). Quick changes in time offset will lead to larger frequency
+offsets.</p>
+
+<p>These are fields 3 (time) and 4 (frequency) from the loopstats log
+file.</p>
+
"""
ret = {'html' : exp, 'percs' : percs }
@@ -319,17 +323,16 @@ plot \
1%% = %(one).3f %(unit)s<br>
Ranges: 99%% - 1%% = %(nn_m_o).3f %(unit)s,
95%% - 5%% = %(nf_m_f).3f %(unit)s</p>
-<p>This shows the frequency offset of the local clock (aka drift).
-It comes from field 3 of the loopstats log file. The graph 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
+<p>This shows the frequency offset of the local clock (aka drift). The
+graph 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 result would be a horizontal
-line at 0ppm.</p>
+line at 0ppm. Expected values of 99%%-1%% percentiles: 0.4ppm</p>
-<p>Expected values of 99%%-1%% percentiles: 0.4ppm</p>
+<p>The Frequency Offset comes from field 3 of the loopstats log file.</p>
""" % locals()
ret = {'html' : exp, 'percs' : percs }
ret['title'] = "Local Clock Frequency Offset"
@@ -348,19 +351,25 @@ line at 0ppm.</p>
unit = "ppm"
title = "Local Stability"
exp = """\
-<p>This shows the frequency jitter (aka wander) of the local clock's
-frequency. In other words, how fast it the local clock changes freqency.
-This is field 6 in the loopstats log file.</p>
-<p>Lower is better. An ideal clock would be a horizontal line at 0ppm.</p>
+<p>This shows the RMS Frequency Jitter (aka wander) of the local
+clock's frequency. In other words, how fast it the local clock changes
+freqency.</p>
+
+<p>Lower is better. An ideal clock would be a horizontal line at
+0ppm.</p>
+
+<p> RMSFrequency Jitter is field 6 in the loopstats log file.</p>
"""
else:
unit = "μs"
title = "Local Time Jitter"
exp = """\
-<p>This shows the jitter of the local clock offset. In other words,
-how fast the local clock offset is changing. This is field 5 in the
-loopstats log file</p>
+<p>This shows the RMS Jitter of the local clock offset. In other words,
+how fast the local clock offset is changing.</p>
+
<p>Lower is better. An ideal system would be a horizontal line at 0μs.</p>
+
+<p>RMS jitter is field 5 in the loopstats log file.</p>
"""
sitename = self.sitename
@@ -520,42 +529,50 @@ Ranges: 99%% - 1%% = %(nn_m_o).3f %(unit)s,
rtt = 0
title = "Refclock Offset " + str(peerlist[0])
exp += """\
-<p>This shows the offset of a local refclock in %(unit)s.
-This is field 5 from the loopstats log file. This is be useful to
-see how the measured offset is changing.</p>
+<p>This shows the offset of a local refclock in %(unit)s. This is
+useful to see how the measured offset is behaving.</p>
+
+<p>Clock Offset is field 5 in the peerstats log file.</p>
""" % locals()
else:
title = "Peer Offset " + str(peerlist[0])
exp += """\
-<p>This shows the offset of a peer or server in seconds.
-This is field 5 from the loopstats log file. This is be useful to
-see how the measured offset is changing.</p>
+<p>This shows the offset of a peer or server in seconds. This is be
+useful to see how the measured offset is behaving.</p>
+
<p>The chart also plots offset±rtt. Where rtt is the round trip time
to the remote. NTP can not really know the offset of a remote chimer,
NTP computes it by subtracting rtt/2 from the offset. Plotting the
offset±rtt reverses this calculation to more easily see the effects of
rtt changes.</p>
+
+<p>Clock Offset is field 5 in the peerstats log file.</p>
"""
else:
# doing jitter, not offset
if "127.127." == peerlist[0][:8]:
- title = "Refclock Jitter " + str(peerlist[0])
+ title = "Refclock RMS Jitter " + str(peerlist[0])
exp += """\
-<p>This shows the jitter of a local refclock. Jitter is the
-current estimated dispersion; the variation in offset between samples.
-This is field 8 in the loopstats log file.</p>
+<p>This shows the RMS Jitter of a local refclock. Jitter is the
+current estimated dispersion; the variation in offset between samples.</p>
+
<p>Closer to 0s is better. An ideal system would be a horizontal
line at 0s.</p>
+
+<p>RMS Jitter is field 8 in the peerstats log file.</p>
"""
else:
title = "Peer Jitter " + str(peerlist[0])
exp += """\
-<p>This shows the jitter of a remote peer or server. Jitter is the
-current estimated dispersion; the variation in offset between samples.
-This is field 8 in the loopstats log file.</p>
-<p>Closer to 0s is better. An ideal system would be a horizontal
-line at 0s.</p>
+<p>This shows the RMS Jitter of a remote peer or server. Jitter is
+the current estimated dispersion; the variation in offset between
+samples.</p>
+
+<p>Closer to 0s is better. An ideal system would be a horizontal line
+at 0s.</p>
+
+<p>RMS Jitter is field 8 in the peerstats log file.</p>
"""
else:
@@ -564,23 +581,28 @@ line at 0s.</p>
if "offset" == type:
title = "Peer Offsets"
exp = """\
-<p>This shows the offset of all refclocks, peers and servers in %(unit)s.
-This is field 5 from the loopstats log file. This can be useful to
-see if offset changes are happening in a single clock or all clocks
-together.</p>
+<p>This shows the offset of all refclocks, peers and servers in
+%(unit)s. This can be useful to see if offset changes are happening in
+a single clock or all clocks together.</p>
+
<p>Closer to 0s is better. An ideal system would be a horizontal line
-at 0s. Typical 90%% ranges may be: local serial GPS 200 ms; local LAN peer
-80µs; local PPS 20µs. 90%% ranges for WAN servers may be 4ms and much larger.
-</p>
+at 0s. Typical 90%% ranges may be: local serial GPS 200 ms; local LAN
+peer 80µs; local PPS 20µs. 90%% ranges for WAN servers may be 4ms and
+much larger. </p>
+
+<p>Clock Offset is field 5 in the peerstats log file.</p>
""" % locals()
else:
title = "Peer Jitters"
exp = """\
-<p>This shows the jitter of all refclocks, peers and servers. Jitter is the
-current estimated dispersion; the variation in offset between samples.
-This is field 8 in the loopstats log file.</p>
-<p>Closer to 0s is better. An ideal system would be a horizontal
-line at 0s.</p>
+<p>This shows the RMS Jitter of all refclocks, peers and servers.
+Jitter is the current estimated dispersion; the variation in offset
+between samples.</p>
+
+<p>Closer to 0s is better. An ideal system would be a horizontal line
+at 0s.</p>
+
+<p>RMS Jitter is field 8 in the peerstats log file.</p>
"""
plot_template = NTPViz.Common + """\
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/830b8132df5bfb3c31479b409788073e17252e23
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20160930/9d59041e/attachment.html>
More information about the vc
mailing list