xref: /freebsd/contrib/ntp/scripts/stats/README.stats (revision c0b746e5e8d9479f05b3749cbf1f73b8928719bd)
1c0b746e5SOllivier RobertStatistics file formats (README.stats)
2c0b746e5SOllivier Robert
3c0b746e5SOllivier RobertThe xntp3 daemon can produce a variety of statistics files which are
4c0b746e5SOllivier Robertuseful for maintenance, evaluation and retrospective calibration
5c0b746e5SOllivier Robertpurposes. See the xntpd.8 man page for instructions on how to configure
6c0b746e5SOllivier Robertthis feature. Since these files can become rather large and cumbersome,
7c0b746e5SOllivier Robertthey are ordinarily reduced to summary form by running the summary.sh
8c0b746e5SOllivier Robertshell script once per day, week or month, as appropriate. There are
9c0b746e5SOllivier Robertthree file collections presently defined: peerstats, loopstats and
10c0b746e5SOllivier Robertclockstats, each of which is described in this note.
11c0b746e5SOllivier Robert
12c0b746e5SOllivier Robertpeerstats
13c0b746e5SOllivier Robert
14c0b746e5SOllivier RobertThe following data are collected in the peerstats files. The files are
15c0b746e5SOllivier Robertreduced to summary data using the peer.sh shell script. See the peer.awk
16c0b746e5SOllivier Robertscript for further information. A line in the file is produced upon
17c0b746e5SOllivier Robertreception of each valid update from a configured peer.
18c0b746e5SOllivier Robert
19c0b746e5SOllivier Robert  49236 30.756 140.173.96.1 9474 0.000603 0.37532
20c0b746e5SOllivier Robert
21c0b746e5SOllivier Robert  49236             modified Julian day number
22c0b746e5SOllivier Robert  30.756            time of day (s) past midnight UTC
23c0b746e5SOllivier Robert  140.173.96.1      peer identifier (IP address or receiver identifier)
24c0b746e5SOllivier Robert  9474              peer status word (hex) (see NTP specification)
25c0b746e5SOllivier Robert  0.000603          offset (s)
26c0b746e5SOllivier Robert  0.08929           delay (s)
27c0b746e5SOllivier Robert  0.37532           dispersion (s)
28c0b746e5SOllivier Robert
29c0b746e5SOllivier Robertloopstats
30c0b746e5SOllivier Robert
31c0b746e5SOllivier RobertThe following data are collected in the loopstats files. The files are
32c0b746e5SOllivier Robertreduced to summary data using the loop.sh shell script. See the loop.awk
33c0b746e5SOllivier Robertscript for further information. A line in the file is produced at each
34c0b746e5SOllivier Robertvalid update of the local clock.
35c0b746e5SOllivier Robert
36c0b746e5SOllivier Robert  49236 11.897 -0.000004 -35.9384 0
37c0b746e5SOllivier Robert
38c0b746e5SOllivier Robert  49236             modified Julian day number
39c0b746e5SOllivier Robert  11.897            time of day (s) past midnight UTC
40c0b746e5SOllivier Robert  -0.000004         time offset (s)
41c0b746e5SOllivier Robert  -35.9384          frequency offset (ppm)
42c0b746e5SOllivier Robert  0                 phase-lock loop time constant
43c0b746e5SOllivier Robert
44c0b746e5SOllivier Robertclockstats
45c0b746e5SOllivier Robert
46c0b746e5SOllivier RobertThe following data are collected in the clockstats files. The files are
47c0b746e5SOllivier Robertreduced to summary data using the clock.sh shell script, which also
48c0b746e5SOllivier Robertupdates the ensemble, etf, itf and tdata data files as well. See the
49c0b746e5SOllivier Robertclock.awk, ensemble.awk, etf.awk, itf.awk and tdta.awk scripts for
50c0b746e5SOllivier Robertfurther information. A line in the file is produced at each valid update
51c0b746e5SOllivier Robertreceived from a configured radio clock. Data are at present recorded for
52c0b746e5SOllivier Robertseveral radios. The first part of each data line is similar for all
53c0b746e5SOllivier Robertradios, e.g.:
54c0b746e5SOllivier Robert
55c0b746e5SOllivier Robert  49234 60517.826 127.127.4.1   93 247 16:48:21.814
56c0b746e5SOllivier Robert
57c0b746e5SOllivier Robert  49234             modified Julian day number
58c0b746e5SOllivier Robert  60517.826         time of day (s) past midnight UTC
59c0b746e5SOllivier Robert  127.127.4.1       receiver identifier (Spectracom 8170/Netclock-2)
60c0b746e5SOllivier Robert  93 247 16:48:21.814  timecode (format varies)
61c0b746e5SOllivier Robert
62c0b746e5SOllivier RobertIn the case of the Austron GPS receiver, a good deal of additional
63c0b746e5SOllivier Robertinformation is extracted from the radio, as described below. The formats
64c0b746e5SOllivier Robertshown consist of one line with all the fields shown in order. The
65c0b746e5SOllivier Roberttimecode formats specific to each radio follow. See the file
66c0b746e5SOllivier RobertREADME.timecodes for detailed information on the timecode formats used
67c0b746e5SOllivier Robertby these radios.
68c0b746e5SOllivier Robert
69c0b746e5SOllivier RobertSpectracom 8170/Netclock-2 WWVB receiver
70c0b746e5SOllivier Robert
71c0b746e5SOllivier Robert  49234 60517.826 127.127.4.1 ?A93 247 16:48:21.814
72c0b746e5SOllivier Robert
73c0b746e5SOllivier Robert  The '?' and 'A' characters are present only when the receiver is
74c0b746e5SOllivier Robert  unsynchronized; otherwise, they are replaced by space ' ' characters.
75c0b746e5SOllivier Robert
76c0b746e5SOllivier RobertIRIG audio decoder
77c0b746e5SOllivier Robert
78c0b746e5SOllivier Robert  49234 60517.826 127.127.6.0 247 16:48:21?
79c0b746e5SOllivier Robert
80c0b746e5SOllivier Robert  The '?' character is present only when the receiver is unsynchronized.
81c0b746e5SOllivier Robert
82c0b746e5SOllivier RobertAustron 2200A/2201A GPS receiver
83c0b746e5SOllivier Robert
84c0b746e5SOllivier Robert  49234 60580.843 127.127.10.1 93:247:16:49:24.814?
85c0b746e5SOllivier Robert
86c0b746e5SOllivier Robert  The '?' character is present only when the receiver is unsynchronized.
87c0b746e5SOllivier Robert
88c0b746e5SOllivier RobertDepending on the installed options, the Austron 2200A/2201A recognizes a
89c0b746e5SOllivier Robertnumber of special commands that report various data items. See the
90c0b746e5SOllivier Robertrefclock_as2201.c source module for a list of the commands used. These
91c0b746e5SOllivier Robertdata are collected only if the following line is included in the
92c0b746e5SOllivier Robertconfiguration file ntp.conf:
93c0b746e5SOllivier Robert
94c0b746e5SOllivier Robert  fudge 127.127.10.1 flag4 1    # enable extended statistics collection
95c0b746e5SOllivier Robert
96c0b746e5SOllivier RobertThe format of each data line returned is summarized in the following
97c0b746e5SOllivier Robertlist.
98c0b746e5SOllivier Robert
99c0b746e5SOllivier RobertExternal time/frequency data (requires input buffer option IN)
100c0b746e5SOllivier Robert
101c0b746e5SOllivier RobertThese data determine the deviations of external time/frequency inputs
102c0b746e5SOllivier Robertrelative to receiver oscillator time. The following data are typical
103c0b746e5SOllivier Robertusing an external cesium oscillator PPS and 5-MHz outputs.
104c0b746e5SOllivier Robert
105c0b746e5SOllivier Robert  49234 60580.843 127.127.10.1 93:247:16:49:24.814 ETF
106c0b746e5SOllivier Robert
107c0b746e5SOllivier Robert  -85.9             time interval (ns)
108c0b746e5SOllivier Robert  -89.0             average time interval (ns)
109c0b746e5SOllivier Robert  4.0               time interval sigma (ns)
110c0b746e5SOllivier Robert  +1.510E-11        time interval rate
111c0b746e5SOllivier Robert  -4.500E-11        deltaf/f
112c0b746e5SOllivier Robert  +1.592E-11        average deltaf/f
113c0b746e5SOllivier Robert  5.297E-13         sigma deltaf/f
114c0b746e5SOllivier Robert  500               number of samples
115c0b746e5SOllivier Robert
116c0b746e5SOllivier RobertModel and option identifiers
117c0b746e5SOllivier Robert
118c0b746e5SOllivier RobertThese data show the receiver model number and option configuration.
119c0b746e5SOllivier Robert
120c0b746e5SOllivier Robert  49234 60708.848 127.127.10.1 93:247:16:51:32.817 ID;OPT;VER
121c0b746e5SOllivier Robert
122c0b746e5SOllivier Robert  GPS 2201A         model ident (must be "GPS 2200A" or "GPS 2201A")
123c0b746e5SOllivier Robert  TTY1              rs232 option present (required)
124c0b746e5SOllivier Robert  TC1               IRIG option present (optional)
125c0b746e5SOllivier Robert  LORAN             LORAN assist option present (optional)
126c0b746e5SOllivier Robert  IN                input buffer option present (optional)
127c0b746e5SOllivier Robert  OUT1              output buffer option present (required)
128c0b746e5SOllivier Robert  B.00              data processor software version ("B.00" or later)
129c0b746e5SOllivier Robert  B.00              signal processor software version ("B.00" or later)
130c0b746e5SOllivier Robert  28-Apr-93         software version date ("28-Apr-93" or later)
131c0b746e5SOllivier Robert
132c0b746e5SOllivier RobertInternal time/frequency data
133c0b746e5SOllivier Robert
134c0b746e5SOllivier RobertThese data determine the deviations of the receiver oscillator with
135c0b746e5SOllivier Robertrespect to satellite time.
136c0b746e5SOllivier Robert
137c0b746e5SOllivier Robert  49234 60564.846 127.127.10.1 93:247:16:49:08.816 ITF
138c0b746e5SOllivier Robert
139c0b746e5SOllivier Robert  COCO              current mode (must be "COCO")
140c0b746e5SOllivier Robert  0                 code coast mode (must be zero)
141c0b746e5SOllivier Robert  +6.6152E-08       code sigma (s)
142c0b746e5SOllivier Robert  -3.5053E-08       code delta t (s)
143c0b746e5SOllivier Robert  -4.0361E-11       deltat/t
144c0b746e5SOllivier Robert  -6.4746E-11       oscillator ageing rate
145c0b746e5SOllivier Robert  500.00            loop time constant
146c0b746e5SOllivier Robert  4.984072          electrical tuning (V)
147c0b746e5SOllivier Robert
148c0b746e5SOllivier RobertGPS/LORAN ensemble data (requires LORAN assist option LORAN)
149c0b746e5SOllivier Robert
150c0b746e5SOllivier RobertThese data determine the deviations and weights to calculate ensemble
151c0b746e5SOllivier Roberttime from GPS and LORAN data.
152c0b746e5SOllivier Robert
153c0b746e5SOllivier Robert  49234 60596.852 127.127.10.1 93:247:16:49:40.812 LORAN ENSEMBLE
154c0b746e5SOllivier Robert
155c0b746e5SOllivier Robert  +9.06E-08         GPS t (s)
156c0b746e5SOllivier Robert  +3.53E-08         GPS sigma (s)
157c0b746e5SOllivier Robert  .532              GPS weight
158c0b746e5SOllivier Robert  +3.71E-08         LORAN t (s)
159c0b746e5SOllivier Robert  +3.76E-08         LORAN sigma (s)
160c0b746e5SOllivier Robert  .468              LORAN weight
161c0b746e5SOllivier Robert  +6.56E-08         ensemble t
162c0b746e5SOllivier Robert  +6.94E-08         ensemble sigma (s)
163c0b746e5SOllivier Robert
164c0b746e5SOllivier RobertLORAN stationkeeping data (requires LORAN assist option LORAN)
165c0b746e5SOllivier Robert
166c0b746e5SOllivier RobertThese data determine which stations of the LORAN chain are being
167c0b746e5SOllivier Roberttracked, together with individual signal/noise ratios, deviations and
168c0b746e5SOllivier Robertweights.
169c0b746e5SOllivier Robert
170c0b746e5SOllivier Robert  49234 60532.850 127.127.10.1 93:247:16:48:36.820 LORAN TDATA
171c0b746e5SOllivier Robert
172c0b746e5SOllivier Robert  M                 station identifier; data follows
173c0b746e5SOllivier Robert  OK                status (must be "OK" for tracking)
174c0b746e5SOllivier Robert  0                 cw flag
175c0b746e5SOllivier Robert  0                 sw flag
176c0b746e5SOllivier Robert  1162.17           time of arrival
177c0b746e5SOllivier Robert  -4.6              snr (-30.0 if not "OK" status)
178c0b746e5SOllivier Robert  1.67E-07          2-sample phase-time deviation
179c0b746e5SOllivier Robert  .507              weight (included only if "OK" status)
180c0b746e5SOllivier Robert  W AQ 0 0 3387.80 -31.0  station identifier and data
181c0b746e5SOllivier Robert  X OK 0 0 1740.27 -11.2 2.20E-07 .294  station identifier and data
182c0b746e5SOllivier Robert  Y OK 0 0 2180.71 -4.6 2.68E-07 .198  station identifier and data
183c0b746e5SOllivier Robert  Z CV 0 0 3392.94 -30.0  station identifier and data
184c0b746e5SOllivier Robert
185c0b746e5SOllivier RobertOscillator status and environment
186c0b746e5SOllivier Robert
187c0b746e5SOllivier RobertThese data determine the receiver oscillator type, mode, status and
188c0b746e5SOllivier Robertenvironment. Nominal operating conditions are shown below.
189c0b746e5SOllivier Robert
190c0b746e5SOllivier Robert  49234 60628.847 127.127.10.1 93:247:16:50:12.817 OSC;ET;TEMP
191c0b746e5SOllivier Robert
192c0b746e5SOllivier Robert  1121 Software     Control  oscillator model and mode (must be
193c0b746e5SOllivier Robert                    "Software Control")
194c0b746e5SOllivier Robert  Locked            status (must be "Locked")
195c0b746e5SOllivier Robert  4.979905          electrical tuning (V)
196c0b746e5SOllivier Robert  44.81             oscillator cavity temperature
197c0b746e5SOllivier Robert
198c0b746e5SOllivier RobertReceiver position, status and offsets
199c0b746e5SOllivier Robert
200c0b746e5SOllivier RobertThese data determine the receiver position and elevation, together with
201c0b746e5SOllivier Robertprogrammable delay corrections for the antenna cable and receiver.
202c0b746e5SOllivier Robert
203c0b746e5SOllivier Robert  49234 60788.847 127.127.10.1 93:247:16:52:52.817 POS;PPS;PPSOFF
204c0b746e5SOllivier Robert
205c0b746e5SOllivier Robert  +39:40:48.425     receiver latitude (N)
206c0b746e5SOllivier Robert  -075:45:02.392    receiver longitude (E)
207c0b746e5SOllivier Robert  +74.09            receiver elevation (m)
208c0b746e5SOllivier Robert  Stored            position status (must be "Stored")
209c0b746e5SOllivier Robert  UTC               PPS/PPM alignment (must be "UTC")
210c0b746e5SOllivier Robert  0                 receiver delay (ns) (should be zero for calibrated
211c0b746e5SOllivier Robert                    receiver)
212c0b746e5SOllivier Robert  200               cable delay (ns)
213c0b746e5SOllivier Robert  0                 user time bias (ns) (must be zero)
214c0b746e5SOllivier Robert
215c0b746e5SOllivier RobertSatellite tracking status
216c0b746e5SOllivier Robert
217c0b746e5SOllivier RobertThese data determine how many satellites are being tracked. At the
218c0b746e5SOllivier Robertpresent state of constellation development, there should be at least
219c0b746e5SOllivier Robertthree visible satellites in view. Much of the time the maximum of
220c0b746e5SOllivier Robertseven are being tracked; rarely this number drops to two.
221c0b746e5SOllivier Robert
222c0b746e5SOllivier Robert  49234 60612.850 127.127.10.1 93:247:16:49:56.820 TRSTAT
223c0b746e5SOllivier Robert
224c0b746e5SOllivier Robert  24 T              satellite prn and status (T = track, A = acquire)
225c0b746e5SOllivier Robert  16 A 13 T 20 T 18 T 07 T 12 T  list continued
226c0b746e5SOllivier Robert
227c0b746e5SOllivier RobertUTC leap-second information
228c0b746e5SOllivier Robert
229c0b746e5SOllivier RobertThese data determine when the next leap second is to occur. The exact
230c0b746e5SOllivier Robertmethod to use is obscure.
231c0b746e5SOllivier Robert
232c0b746e5SOllivier Robert  49234 60548.847 127.127.10.1 93:247:16:48:52.818 UTC
233c0b746e5SOllivier Robert
234c0b746e5SOllivier Robert  -1.2107E-08       A0 term (s)
235c0b746e5SOllivier Robert  -1.2790E-13       A1 term (s)
236c0b746e5SOllivier Robert  +9.0000E+00       current leap seconds (s)
237c0b746e5SOllivier Robert  +2.0480E+05       time for leap seconds (s)
238c0b746e5SOllivier Robert  +2.0100E+02       week number for delta leap (weeks)
239c0b746e5SOllivier Robert  +1.9100E+02       week number for future leap (weeks)
240c0b746e5SOllivier Robert  +4.0000E+00       day number for future leap (days)
241c0b746e5SOllivier Robert  +9.0000E+00       future leap seconds (s)
242c0b746e5SOllivier Robert
243c0b746e5SOllivier RobertDavid L. Mills
244c0b746e5SOllivier RobertUniversity of Delaware
245c0b746e5SOllivier Robertmills@udel.edu
246c0b746e5SOllivier Robert23 October 1993
247