1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
NOTES on picalib alarms
=======================
* COMMON VARIABLES
------------------
Most of this alarms have two configuration variables:
- remind: time to wait (in seconds) before notifying an already notified
situation
- proactive: flag that indicates if the alarm should take proactive measures
to correct the situation
* COMMON PARAMETERS
-------------------
ALL alarms should support ALL these parameters, even if they do nothing...
* Proactive Flag: "-n/-p" will set "proactive" to "0/1". It takes precedence
over the variable. -n will have precedence over -p
* Notifications: "-q" the alarm won't send ANY notification. (it won't print
anything), even if there where errors. This may seem stupid, but we could
want to CORRECT (proactive=1) things without notifying it...
* Verbosity: "-v" The alarm will execute in "verbose" mode, and will give
info
* OBJECT FILES
--------------
* To allow objects to add new configuration to alarms, the alarms should
read their main object file, and any file located within a directory named
as the alarm. This way PICA objects can add files to that directory and
they will be read by the alarm. To simplify this task the alarm can call
the function readObjectFiles, that will read all this files and return
them in an array. The alarm will have to process the array because the
format can be different for each alarm...
TODO:
All the alarms should have a -h option that gives the following information:
- Name: the name of the alarm
- Description: What it does
- Variables: Global variables it understand
- Parameters: Parameters it accepts, and what they mean (including this -h)
- Config files: Path to the config files they use
- History: Persistent values it uses, and their current value
|
