contrib/ntp/scripts/stats/README

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