xref: /freebsd-src/contrib/ntp/scripts/stats/README (revision c0b746e5e8d9479f05b3749cbf1f73b8928719bd)
1*c0b746e5SOllivier RobertStatistics processing scripts (README)
2*c0b746e5SOllivier Robert
3*c0b746e5SOllivier RobertThis directory contains a number of scripts for use with the filegen
4*c0b746e5SOllivier Robertfacility. Those files ending in .awk are for the Unix awk utility, while
5*c0b746e5SOllivier Robertthose ending in .sh are for the csh utility. Normally, the summary.sh
6*c0b746e5SOllivier Robertscript is called from a cron job once per day. This script processes the
7*c0b746e5SOllivier Robertdaily loopstats, peerstats and clockstats files produced by the daemon,
8*c0b746e5SOllivier Robertupdates the loop_summary, peer_summary and clock_summary archive files,
9*c0b746e5SOllivier Robertand deletes the daily files.
10*c0b746e5SOllivier Robert
11*c0b746e5SOllivier RobertIn the case of the Austron 2201A GPS receiver, the clockstats file
12*c0b746e5SOllivier Robertcontains a wealth of additional monitoring data. These data are summarized
13*c0b746e5SOllivier Robertand writted to the clock_summary file, then a series of special files are
14*c0b746e5SOllivier Robertconstructed for later processing by the S utility.
15*c0b746e5SOllivier Robert
16*c0b746e5SOllivier RobertThe summary.sh script invokes a number of awk scripts to actually produce
17*c0b746e5SOllivier Robertthe data. This may result in multiple scans of the same input file.
18*c0b746e5SOllivier RobertThe input file is deleted after processing. In fact, the shell scripts will
19*c0b746e5SOllivier Robertprocess all input files found of the correct type in chronological order,
20*c0b746e5SOllivier Robertdeleting each one as it is scanned, except the current day file.
21*c0b746e5SOllivier Robert
22*c0b746e5SOllivier RobertThe summary.sh script can produce input files for the S utility, if it
23*c0b746e5SOllivier Robertis found on the search path. This utility makes PostScript graphs of the
24*c0b746e5SOllivier Robertloopstats data for each day, as well as various statistics produced by
25*c0b746e5SOllivier Robertthe Austorn 220aA GPS receiver. The S utility is automatically run
26*c0b746e5SOllivier Robertas a background job. Its control files have the .S extension.
27*c0b746e5SOllivier Robert
28*c0b746e5SOllivier RobertThe psummary.awk script can be used to scan the peer_summary file and
29*c0b746e5SOllivier Robertconstruct an historical reprise of the daily summaries.
30*c0b746e5SOllivier Robert
31*c0b746e5SOllivier RobertThe file formats are documented in the README.stats file and in the
32*c0b746e5SOllivier Robertscripts themselves. Further detail on the radio clock ASCII timecode
33*c0b746e5SOllivier Robertformats and related data are in the README.timecode file.
34*c0b746e5SOllivier Robert
35*c0b746e5SOllivier RobertDavid L. Mills
36*c0b746e5SOllivier RobertUniversity of Delaware
37*c0b746e5SOllivier Robertmills@udel.edu
38*c0b746e5SOllivier Robert1 November 1993
39*c0b746e5SOllivier RobertRevised 12 April 1994
40