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