1CFETOOLCHECK(1) User Contributed Perl Documentation CFETOOLCHECK(1)
2
6 cfetool check - Check a new value against the averages currently in the
7 database
8
10 cfetool check name --value⎪-V value [--path⎪-p directory name]
11 [--time⎪-t seconds] [--daily⎪-d] [--weekly⎪-w] [--yearly⎪-y] [--his‐
12 tograms⎪-H] [--verbose⎪-v] [--help⎪-h]
13
15 Takes a new value and checks it against the averages currently in the
16 database specified by name, located at the path specified by the -p
17 argument, or the current working directory if the -p argument is ommit‐
18 ted. The value will be associated with the current time, unless the -t
19 option is given. The output indicates how much higher or lower the new
20 value is compared to the averages in the database, in terms of the num‐
21 ber of standard deviations.
22 The -d, -w and -y options specify the databases to check the new value
24 against. If all three options are omitted, only the weekly database
25 will be accessed.
26
28 --value⎪-v value
29 Specifies the new value to check against the database averages.
30 --path⎪-p directory name
32 The directory in which the database specified by name can be found.
33 --time⎪-t
35 The time the value was collected, in seconds since epoch (January
36 1st, 1970). If this argument is omitted, the current time will be
37 used.
38 --daily⎪-d
40 Check the new value against the daily averages database.
41 --weekly⎪-w
43 Check the new value against the weekly averages database.
44 --yearly⎪-y
46 Check the new value against the yearly averages database.
47 --histograms⎪-H
49 Check which histogram bucket the new value would fall into. The
50 histogram is divided into 64 buckets, which represent distances
51 from the mean value. Bucket 64 represents two standard deviations
52 above the expected value, and bucket 0 represents two standard
53 deviations below the expected value.
54 --verbose⎪-v
56 Print details of the command's execution to the standard output
57 stream.
58 --help⎪-h
60 Print a short help message and then exit.
61
63 Before exiting, "cfetool check" will print one line to the standard
64 output stream, in the following format:
65 yrly=ynum,bkt=ybkt;wkly=wnum,bkt=wbkt;dly=dnum,bkt=dbkt
67 ybkt, wbkt and dbkt represent the histogram bucket the given value
69 falls into, and will be 0 for databases that are not being checked
70 against, and if there is no histogram file or the -H option was not
71 specified.
72 ynum, wnum and dnum will be either the number 0 if the corresponding
74 database was not updated, or a code indicating the state of the given
75 statistic, as compared to an average of equivalent earlier times, as
76 specified below:
77 code high⎪low⎪normal meaning
79 -------------------------------------------------------------
80 -2 - no sigma variation
81 -------------------------------------------------------------
82 -4 low within noise threshold, and within
83 -5 normal 2 standard deviations from
84 -6 high expected value
85 -------------------------------------------------------------
86 -14 low microanomaly: within noise
87 -15 normal threshold, but 2 or more standard
88 -16 high deviations from expected value
89 -------------------------------------------------------------
90 -24 low normal; within 1 standard deviation
91 -25 normal from the expected value
92 -26 high
93 -------------------------------------------------------------
94 -34 low dev1; more than 1 standard
95 -35 normal deviation from the expected
96 -36 high value
97 ------------------------------------------------------------
98 -44 low dev2; more than 2 standard
99 -45 normal deviations from the expected
100 -46 high value
101 -------------------------------------------------------------
102 -54 low anomaly; more than 3 standard
103 -55 normal deviations from the expected
104 -56 high value
105 Where "low" indicates that the current value is below both the expected
107 value for the current time position, and the global average value.
108 "high" indicates that the current value is above those values. "normal"
109 indicates that the current value is within the range of expected val‐
110 ues.
111 "cfetool check" also exits with a code corresponding to the above ta‐
113 ble. If more than one database is being checked against, the most nega‐
114 tive result from all checks is returned, and the individual results
115 must be obtained from the standard output stream, as described above.
116
118 % cfetool check temperature --path /my/path --value 20 --histograms
119 yrly=0,bkt=0;wkly=-6,bkt=51;dly=0,bkt=0
120 Checks the value 20 against the weekly temperature database and his‐
122 togram files located in /my/path/ using the current time. The output
123 indicates that the new value given was within cfetool's noise thresh‐
124 old, and also within 2 standard deviations of the previous average
125 stored in the weekly database.
126
128 The code and documentation were contributed by Stanford Linear Acceler‐
129 ator Center, a department of Stanford University. This documentation
130 was written by
131 Elizabeth Cassell <e_a_c@mailsnare.net> and
133 Alf Wachsmann <alfw@slac.stanford.edu>
134
136 Copyright 2004 Alf Wachsmann <alfw@slac.stanford.edu> and
137 Elizabeth Cassell <e_a_c@mailsnare.net>
138 All rights reserved.
139perl v5.8.4 2004-09-21 CFETOOLCHECK(1)