[Git][NTPsec/ntpsec][master] ntpviz.py: copyedit descriptive output
Gary E. Miller
gitlab at mg.gitlab.com
Tue Jun 19 20:24:03 UTC 2018
Gary E. Miller pushed to branch master at NTPsec / ntpsec
Commits:
7574705b by Paul Theodoropoulos at 2018-06-19T20:12:35Z
ntpviz.py: copyedit descriptive output
Signed-off-by: Gary E. Miller <gem at rellim.com>
- - - - -
1 changed file:
- ntpclients/ntpviz.py
Changes:
=====================================
ntpclients/ntpviz.py
=====================================
--- a/ntpclients/ntpviz.py
+++ b/ntpclients/ntpviz.py
@@ -1,7 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""\
-ntpviz - logfile visualizer for NTP log files
+ntpviz - visualizer for NTP log files
ntpviz [-d LOGDIR] [-g] [-n name] [-p DAYS]
[-s starttime] [-e endtime]
@@ -642,10 +642,10 @@ plot \
exp = """\
<p>The frequency offsets and temperatures.
Showing frequency offset (red, in parts
-per million, scale on right) and the temeratures.</p>
+per million, scale on right) and the temperatures.</p>
<p>These are field 4 (frequency) from the loopstats log
-file, and field 3 from the temp log .</p>
+file, and field 3 from the tempstats log file.</p>
"""
@@ -702,14 +702,14 @@ plot \\
# strip the trailing ", \n"
plot_template = plot_template[:-4] + "\n"
exp = """\
-<p>Local temperatures. These will be site specific depending on what
-temperature sensors you have and collect data from.
+<p>Local temperatures. These will be site-specific depending upon what
+temperature sensors you collect data from.
Temperature changes affect the local clock crystal frequency and
stability. The math of how temperature changes frequency is
complex, and also depends on crystal aging. So there is no easy
-way to correct for it in software. This the single most important
+way to correct for it in software. This is the single most important
component of frequency drift.</p>
-<p>The Local Termperatures are from field 3 from the tempstats log file.</p>
+<p>The Local Temperatures are from field 3 from the tempstats log file.</p>
"""
ret = {'html': exp, 'stats': stats}
@@ -839,7 +839,7 @@ plot \
""" % out
exp = """\
-<p>This shows the frequency offset of the local clock (aka drift). The
+<p>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
@@ -882,7 +882,7 @@ line at 0ppm. Expected values of 99%-1% percentiles: 0.4ppm</p>
if freq:
exp = """\
-<p>This shows the RMS Frequency Jitter (aka wander) of the local
+<p>The RMS Frequency Jitter (aka wander) of the local
clock's frequency. In other words, how fast the local clock changes
frequency.</p>
@@ -893,7 +893,7 @@ frequency.</p>
"""
else:
exp = """\
-<p>This shows the RMS Jitter of the local clock offset. In other words,
+<p>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>
@@ -980,11 +980,11 @@ plot \
rtt = 0
title = "Refclock Offset " + str(peerlist[0])
exp = """\
-<p>This shows the offset of a local refclock in seconds. This is
+<p>The offset of a local refclock in seconds. This is
useful to see how the measured offset is behaving.</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 PPS
+at 0s. Typical 90% ranges may be: local serial GPS 200 ms; local PPS
20µs.</p>
<p>Clock Offset is field 5 in the peerstats log file.</p>
@@ -992,10 +992,10 @@ at 0s. Typical 90%% ranges may be: local serial GPS 200 ms; local PPS
else:
title = "Peer Offset " + str(peerlist[0])
exp = """\
-<p>This shows the offset of a peer or server in seconds. This is
+<p>The offset of a peer or server in seconds. This is
useful to see how the measured offset is behaving.</p>
-<p>The chart also plots offset±rtt. Where rtt is the round trip time
+<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
@@ -1006,7 +1006,7 @@ at 0s. Typical 90% ranges may be: local LAN peer 80µs; 90% ranges for
WAN servers may be 4ms and much larger. </p>
<p>Clock Offset is field 5 in the peerstats log file. The Round Trip
-Time (rtt) is field 6 in the peerstats file.</p>
+Time (rtt) is field 6 in the peerstats log file.</p>
"""
else:
@@ -1014,8 +1014,9 @@ Time (rtt) is field 6 in the peerstats file.</p>
if "127.127." == peerlist[0][:8]:
title = "Refclock RMS Jitter " + str(peerlist[0])
exp = """\
-<p>This shows the RMS Jitter of a local refclock. Jitter is the
-current estimated dispersion; the variation in offset between samples.</p>
+<p>The RMS Jitter of a local refclock. Jitter is the
+current estimated dispersion, in other words the variation in offset
+between samples.</p>
<p>Closer to 0s is better. An ideal system would be a horizontal
line at 0s.</p>
@@ -1025,9 +1026,9 @@ line at 0s.</p>
else:
title = "Peer Jitter " + str(peerlist[0])
exp = """\
-<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>The RMS Jitter of a remote peer or server. Jitter is the
+current estimated dispersion, in other words the variation in offset
+between samples.</p>
<p>Closer to 0s is better. An ideal system would be a horizontal line
at 0s.</p>
@@ -1047,7 +1048,7 @@ at 0s.</p>
if "offset" == type:
title = "Peer Offsets"
exp = """\
-<p>This shows the offset of all refclocks, peers and servers.
+<p>The offset of all refclocks, peers and servers.
This can be useful to see if offset changes are happening in
a single clock or all clocks together.</p>
@@ -1056,8 +1057,8 @@ a single clock or all clocks together.</p>
else:
title = "Peer Jitters"
exp = """\
-<p>This shows the RMS Jitter of all refclocks, peers and servers.
-Jitter is the current estimated dispersion; the variation in offset
+<p>The RMS Jitter of all refclocks, peers and servers. Jitter is the
+current estimated dispersion, in other words the variation in offset
between samples.</p>
<p>Closer to 0s is better. An ideal system would be a horizontal line
@@ -1245,7 +1246,7 @@ plot \
histogram_data = ["%s %s\n" % (k, v) for k, v in cnt.items()]
exp = """\
-<p>This shows the clock offsets of the local clock as a histogram.</p>
+<p>The clock offsets of the local clock as a histogram.</p>
<p>The Local Clock Offset is field 3 from the loopstats log file.</p>
"""
@@ -1373,7 +1374,7 @@ Python by ESR, concept and gnuplot code by Dan Drown.
parser.add_argument('-d', '--datadir',
default="/var/log/ntpstats",
dest='statsdirs',
- help="one or more logfile directories to read",
+ help="one or more log file directories to read",
type=str)
parser.add_argument('-e', '--endtime',
dest='endtime',
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/7574705b46508447b1f4c1b48a94c62b1b596770
--
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/7574705b46508447b1f4c1b48a94c62b1b596770
You're receiving this email because of your account on gitlab.com.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20180619/49058701/attachment.html>
More information about the vc
mailing list