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