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