xref: /freebsd/contrib/ntp/scripts/monitoring/loopwatch.config.SAMPLE (revision c0b746e5e8d9479f05b3749cbf1f73b8928719bd)
1c0b746e5SOllivier Robert# sample configuration and control file for ntploowatch
2c0b746e5SOllivier Robert#
3c0b746e5SOllivier Robert# delay:	sampling interval in seconds
4c0b746e5SOllivier Robertdelay=60
5c0b746e5SOllivier Robert# samples:	use only last # samples
6c0b746e5SOllivier Robertsamples=600
7c0b746e5SOllivier Robert# DO NOT USE srcprefix in shared config files
8c0b746e5SOllivier Robert# srcprefix:	name of file to read samples from
9c0b746e5SOllivier Robert#  		current time suffix (month name) is appended
10c0b746e5SOllivier Robert#		defaults to "./var@$STATHOST/loopstats."
11c0b746e5SOllivier Robert#		The string "$STATHOST"is replaced by the name of the host
12c0b746e5SOllivier Robert#		being monitored
13c0b746e5SOllivier Robert#srcprefix=./var@$STATHOST/loopstats.
14c0b746e5SOllivier Robert#
15c0b746e5SOllivier Robert# showoffs:	yes/no control display of offset values
16c0b746e5SOllivier Robertshowoffs=yes
17c0b746e5SOllivier Robert#
18c0b746e5SOllivier Robert# showfreq:	yes/no control display of frequency values
19c0b746e5SOllivier Robertshowfreq=yes
20c0b746e5SOllivier Robert#
21c0b746e5SOllivier Robert# showcmpl:	yes/no control display of compliance values
22c0b746e5SOllivier Robertshowcmpl=no
23c0b746e5SOllivier Robert#
24c0b746e5SOllivier Robert# showoreg:	yes/no control display of linear regression of offset values
25c0b746e5SOllivier Robertshoworeg=no
26c0b746e5SOllivier Robert#
27c0b746e5SOllivier Robert# showfreg:	yes/no control display of linear regression of frequency values
28c0b746e5SOllivier Robertshowfreg=no
29c0b746e5SOllivier Robert#
30c0b746e5SOllivier Robert# timebase:	dynamic/ISO_DATE_TIME point of zero for linear regression
31c0b746e5SOllivier Robert#		ISO_DATE_TIME:  yyyy-mm-dd_hh:mm:ss.ms
32c0b746e5SOllivier Robert#		values are interpreted using local time zone
33c0b746e5SOllivier Robert#		parts omitted from front default to current date/time
34c0b746e5SOllivier Robert#		parts omitted from end  default to lowest permitted values
35c0b746e5SOllivier Robert#		to get aa:bb being interpreted as minutes:seconds use aa:bb.0
36c0b746e5SOllivier Robert#		for dynamic '00:00:00.0 of current day' is used
37c0b746e5SOllivier Roberttimebase=dynamic
38c0b746e5SOllivier Robert#
39c0b746e5SOllivier Robert# freqbase:	dynamic/<baseval>
40c0b746e5SOllivier Robert#		if a number is given, subtract this from sampling values for display
41c0b746e5SOllivier Robert#		if dynamic is selected, freqbase is adjusted to fit into the range of
42c0b746e5SOllivier Robert#		offset values
43c0b746e5SOllivier Robertfreqbase=dynamic
44c0b746e5SOllivier Robert#
45c0b746e5SOllivier Robert# cmplscale:	dynamic/<scaling>
46c0b746e5SOllivier Robert#		if a number is given, the sampling values are divided by this number
47c0b746e5SOllivier Robert#		if dynamic is selected, cmplscale is adjusted to fit into the range of
48c0b746e5SOllivier Robert#		offset values
49c0b746e5SOllivier Robertcmplscale=dynamic
50c0b746e5SOllivier Robert#
51c0b746e5SOllivier Robert# DumbScale:	0/1
52c0b746e5SOllivier Robert#		0 enables dynamic adjust of value ranges for freqbase and cmplscale
53c0b746e5SOllivier Robert#		  timescale is labeled with human readable times
54c0b746e5SOllivier Robert#		1 only uses explicit scaling for numbers
55c0b746e5SOllivier Robert#		  timescale is labeled with hours relative to timebase
56c0b746e5SOllivier RobertDumbScale=0
57c0b746e5SOllivier Robert#
58c0b746e5SOllivier Robert# StartTime:	none/ISO_DATE_TIME
59c0b746e5SOllivier Robert#		ignore any samples before the specified date
60c0b746e5SOllivier RobertStartTime=none
61c0b746e5SOllivier Robert#
62c0b746e5SOllivier Robert# EndTime:	none/ISO_DATE_TIME
63c0b746e5SOllivier Robert#		ignore any samples after the specified date
64c0b746e5SOllivier Robert#
65c0b746e5SOllivier Robert#		if both StartTime and EndTime are specified
66c0b746e5SOllivier Robert#		the value specified for samples is ignored
67c0b746e5SOllivier RobertEndTime=none
68c0b746e5SOllivier Robert#
69c0b746e5SOllivier Robert# MaxOffs:	none/<number>
70c0b746e5SOllivier Robert#		limit display (y-axis) to values not larger than <number>
71c0b746e5SOllivier RobertMaxOffset=none
72c0b746e5SOllivier Robert#
73c0b746e5SOllivier Robert# MinOffs:	none/<number>
74c0b746e5SOllivier Robert#		limit display (y-axis) to values not smaller than <number>
75c0b746e5SOllivier RobertMinOffset=none
76c0b746e5SOllivier Robert
77c0b746e5SOllivier Robert#
78c0b746e5SOllivier Robert# verbose:	<number>
79c0b746e5SOllivier Robert# 		specify level for debugging
80c0b746e5SOllivier Robert#		default is 0 for printing and 1 for monitoring
81c0b746e5SOllivier Robert#		level 1 will just print a timestamp for any display update
82c0b746e5SOllivier Robert#		(this is every delay seconds)
83c0b746e5SOllivier Robertverbose=1
84c0b746e5SOllivier Robert#
85c0b746e5SOllivier Robert# deltaT:	<seconds>
86c0b746e5SOllivier Robert#		mark `holes' in the sample data grater than <seconds>
87c0b746e5SOllivier Robert#		by a break in the plot
88c0b746e5SOllivier Robert#		default: 512 seconds
89c0b746e5SOllivier RobertdeltaT=512
90