From: Harlan Stenn Date: Tue, 9 Feb 2010 07:49:34 +0000 (-0500) Subject: [Bug 1140] Clean up debug.html, decode.html, and ntpq.html X-Git-Tag: NTP_4_2_6P1_RC5~2^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5e5f866ad0b86c8d2e785b62cf4f7742adaaf1c1;p=thirdparty%2Fntp.git [Bug 1140] Clean up debug.html, decode.html, and ntpq.html bk: 4b71138el36WUGb4JxmB8rmNoAAWMw --- diff --git a/ChangeLog b/ChangeLog index b6e8ac6ef..2c1a58f79 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,6 @@ --- +* [Bug 1140] Clean up debug.html, decode.html, and ntpq.html. * [Bug 1477] 1st non-gmake make in clone w/VPATH can't make COPYRIGHT. * [Bug 1480] snprintf() cleanup caused unterminated refclock IDs. diff --git a/html/debug.html b/html/debug.html index 4cebdf744..783472b1d 100644 --- a/html/debug.html +++ b/html/debug.html @@ -43,8 +43,8 @@ the DNS name or IP address for each association along with selected status and statistics variables. The first character in each line is the tally code, which shows which associations are candidates to set the system clock and - of these which one is the system peer. The encoding is shown in the source - field of the system status word.

+ of these which one is the system peer. The encoding is shown in the select + field of the peer status word.

The as command displays a list of associations and association identifiers. Note the condition column, which reflects the tally code. The rv command displays the system variables billboard, including the system status word. The rv assocID command, where assocID is the association ID, displays the peer variables billboard, including the peer status word. Note that, except for explicit calendar dates, times are in milliseconds and frequencies are in parts-per-million (PPM).

A detailed explanation of the system, peer and clock variables in the billboards is beyond the scope of this page; however, a comprehensive explanation for each one is in the NTPv4 protocol specification. The following observations will be useful in debugging and monitoring.

    @@ -85,7 +85,7 @@
  1. Verify using ping or other utility that packets actually do make the round trip between the client and server. Verify using nslookup or other utility that the DNS server names do exist and resolve to valid Internet addresses.
  2. Check that the remote NTP server is up and running. The usual evidence that it is not is a Connection refused message.
  3. Using the ntpdc program, verify that the packets received and packets sent counters are incrementing. If the sent counter does not increment and the configuration file includes configured servers, something may be wrong in the host network or interface configuration. If this counter does increment, but the received counter does not increment, something may be wrong in the network or the server NTP daemon may not be running or the server itself may be down or not responding. -
  4. If both the sent and received counters do increment, but the reach values in the pe billboard with ntpq continues to show zero, received packets are probably being discarded for some reason. If this is the case, the cause should be evident from the flash variable as discussed above and on the ntpq page. It could be that the server has disabled access for the client address, in which case the refid field in the ntpq pe billboard will show a kiss code. See earlier on this page for a list of kiss codes and their meaning. +
  5. If both the sent and received counters do increment, but the reach values in the pe billboard with ntpq continues to show zero, received packets are probably being discarded for some reason. If this is the case, the cause should be evident from the flash variable as discussed above and on the ntpq page. It could be that the server has disabled access for the client address, in which case the refid field in the ntpq pe billboard will show a kiss code. See earlier on this page for a list of kiss codes and their meaning.
  6. If the reach values in the pe billboard show the servers are alive and responding, note the tattletale symbols at the left margin, which indicate the status of each server resulting from the various grooming and mitigation algorithms. The interpretation of these symbols is discussed on the ntpq page. After a few minutes of operation, one or another of the reachable server candidates should show a * tattletale symbol. If this doesn't happen, the intersection algorithm, which classifies the servers as truechimers or falsetickers, may be unable to find a majority of truechimers among the server population.
  7. If all else fails, see the FAQ and/or the discussion and briefings at the NTP Project page.
diff --git a/html/decode.html b/html/decode.html index 3cf1952f5..14b5e7f22 100644 --- a/html/decode.html +++ b/html/decode.html @@ -3,7 +3,7 @@ -ntpd System Log Messages +ntpd Event Messages and Status Words @@ -173,7 +173,9 @@ UTC

-

The Count Field displays the number of events since the last time the code changed. Upon reaching 15, subsequent events with the same code are ignored. The Event Field displays the most recent event message coded as follows:

+

The Count Field displays the number of events since the last time the code changed. Upon reaching 15, subsequent events with the same code are ignored.

+ +

The Event Field displays the most recent event message coded as follows:

@@ -288,7 +290,7 @@ UTC

Peer Status Word

-

The peer status word consists of four fields: Status (0-4, Select (5-7), Count (8-11) and Code (12-15). It is reported in the first line of the rv associd display produced by the ntpq program.

+

The peer status word consists of four fields: Status (0-4), Select (5-7), Count (8-11) and Code (12-15). It is reported in the first line of the rv associd display produced by the ntpq program.

@@ -301,7 +303,7 @@ UTC

-

The Status Field displays the peer status code bits in hexadecimal as follows:

+

The Status Field displays the peer status code bits in hexadecimal; each bit is an independent flag. (Note this field is 5 bits wide, and combines with the the 3-bit-wide Select Field to create the first full byte of the peer status word.) The meaning of each bit in the Status Field is listed in the following table:

@@ -343,7 +345,7 @@ UTC

-

The Select Field displays the current selection. status The T Field displays the tally codes beginning the ntpq peers display. The values are coded as follows:

+

The Select Field displays the current selection status. (The T Field in the following table gives the corresponding tally codes used in the ntpq peers display.) The values are coded as follows:

@@ -357,7 +359,7 @@ UTC

- + @@ -412,7 +414,9 @@ UTC

0 sel_reject  discarded as not valid (TEST10-TEST13)
-

The Count Field displays the number of events since the last time the code changed. Upon reaching 15, subsequent events with the same code are ignored. The Event Field displays the most recent event message coded as follows:

+

The Count Field displays the number of events since the last time the code changed. Upon reaching 15, subsequent events with the same code are ignored.

+ +

The Event Field displays the most recent event message coded as follows:

diff --git a/html/ntpq.html b/html/ntpq.html index 680b765c6..1535b8508 100644 --- a/html/ntpq.html +++ b/html/ntpq.html @@ -122,15 +122,15 @@ - + - + - +
conditionsource (see peer status word)selection status (see the select field of the peer status word)
last_eventevent report (see peer status word)event report (see the event field of the peer status word)
cntevent count (see peer status word)event count (see the count field of the peer status word)
@@ -153,17 +153,21 @@
passwd
Specify the password to use for write requests.
peers
-
Display a list of associations in the form
-
ind assid status conf reach auth condition last_event cnt
+
Display a list of peers in the form
+
[tally]remote refid st t when pool reach delay offset jitter
+ + + + - + @@ -171,7 +175,7 @@ - +
Variable Description
[tally]single-character code indicating current value of the select field of the peer status word
remoteindex on this listhost name (or IP number) of peer
refid
stpeer status wordstratum
t