1CFETOOLUPDATE(1) User Contributed Perl Documentation CFETOOLUPDATE(1)
2
3
4
6 cfetool update - Update the database with a new value
7
9 cfetool update name --value⎪-V value [--path⎪-p directory name]
10 [--time⎪-t seconds] [--daily⎪-d] [--weekly⎪-w] [--yearly⎪-y]
11 [--cfenvd⎪-c] [--histograms⎪-H] [--verbose⎪-v] [--help⎪-h]
12
14 Takes a new value and uses it to update the database specified by name,
15 located at the path specified by the -p argument, or the current work‐
16 ing directory if the -p argument is ommitted. The value will be associ‐
17 ated with the current time, unless the -t option is given. In order for
18 cfetool to function properly, this command should be issued at least
19 once during each interval specified by the --step option of "cfetool
20 create".
21
22 The -d, -w and -y options specify the databases to update. If all three
23 options are omitted, only the weekly database will be updated.
24
26 --value⎪-v value
27 Specifies a new value to update the database with.
28
29 --path⎪-p directory name
30 The directory in which the database specified by name can be found.
31
32 --time⎪-t
33 The time the value was collected, in seconds since epoch (January
34 1st, 1970). If this argument is omitted, the current time will be
35 used.
36
37 --daily⎪-d
38 Update the daily averages database.
39
40 --weekly⎪-w
41 Update the weekly averages database.
42
43 --yearly⎪-y
44 Update the yearly averages database.
45
46 --cfenvd⎪-c
47 Communicate with cfengine. If this option is specified, cfetool
48 will define classes understandable by cfagent. For more informa‐
49 tion, refer to the documentation for cfenvd.
50
51 --histograms⎪-H
52 Collect histogram information about the probability distribiution
53 of fluctuations about the mean value over all times of day. Cfetool
54 won't write anything to this file for the first four weeks, as it
55 has to have reliable mean values in order to accurately calculate
56 it.
57
58 --verbose⎪-v
59 Print details of the command's execution to the standard output
60 stream.
61
62 --help⎪-h
63 Print a short help message and then exit.
64
66 Before exiting, "cfetool update" will print one line to the standard
67 output stream in the following format:
68
69 yrly=ynum,wkly=wnum,dly=dnum
70
71 ynum, wnum and dnum will be either the number 0 if the corresponding
72 database was not updated, or a code indicating the state of the given
73 statistic, as compared to an average of equivalent earlier times, as
74 specified below:
75
76 code high⎪low⎪normal meaning
77 -------------------------------------------------------------
78 -2 - no sigma variation
79 -------------------------------------------------------------
80 -4 low within noise threshold, and within
81 -5 normal 2 standard deviations from
82 -6 high expected value
83 -------------------------------------------------------------
84 -14 low microanomaly: within noise
85 -15 normal threshold, but 2 or more standard
86 -16 high deviations from expected value
87 -------------------------------------------------------------
88 -24 low normal; within 1 standard deviation
89 -25 normal from the expected value
90 -26 high
91 -------------------------------------------------------------
92 -34 low dev1; more than 1 standard
93 -35 normal deviation from the expected
94 -36 high value
95 ------------------------------------------------------------
96 -44 low dev2; more than 2 standard
97 -45 normal deviations from the expected
98 -46 high value
99 -------------------------------------------------------------
100 -54 low anomaly; more than 3 standard
101 -55 normal deviations from the expected
102 -56 high value
103
104 Where "low" indicates that the current value is below both the expected
105 value for the current time position, and the global average value.
106 "high" indicates that the current value is above those values. "normal"
107 indicates that the current value is within the range of expected val‐
108 ues.
109
110 "cfetool update" also exits with a code corresponding to the above ta‐
111 ble. If more than one database is being updated, the most negative
112 result from the updates is returned, and the individual results must be
113 obtained from the standard output stream, as described above.
114
116 % cfetool update temperature --path /my/path --value 14.5 --histograms
117 yrly=0,wkly=-6,dly=0
118
119 Updates the weekly temperature database and histogram files located in
120 /my/path/ with the value 14.5 using the current time as the update
121 time. The output indicates that only a weekly database was updated, and
122 the new value given was within cfetool's noise threshold, and also
123 within 2 standard deviations of the previous average stored in the
124 database.
125
127 The code and documentation were contributed by Stanford Linear Acceler‐
128 ator Center, a department of Stanford University. This documentation
129 was written by
130
131 Elizabeth Cassell <e_a_c@mailsnare.net> and
132 Alf Wachsmann <alfw@slac.stanford.edu>
133
135 Copyright 2004 Alf Wachsmann <alfw@slac.stanford.edu> and
136 Elizabeth Cassell <e_a_c@mailsnare.net>
137 All rights reserved.
138
139
140
141perl v5.8.4 2004-09-21 CFETOOLUPDATE(1)