AlarmRule#
Note
This page is generated by python script generate_cet.py.
Commands#
acknowledge#
Description: Acknowledge the alarm of the rule.
- EFDB_Topic:
AlarmRule_command_acknowledge
configure#
Description: Configure an alarm rule.
- EFDB_Topic:
AlarmRule_command_configure
config#
- IDL_Type:
string
- Units:
unitless
Description: Configuration as yaml text that is parsed to make a keyword argument dict for the alarm rule’s configure method.
mute#
Description: Mute the alarm of the rule.
- EFDB_Topic:
AlarmRule_command_mute
unacknowledge#
Description: Unacknowledge the alarm of the rule.
- EFDB_Topic:
AlarmRule_command_unacknowledge
unmute#
Description: Unmute the alarm of the rule.
- EFDB_Topic:
AlarmRule_command_unmute
setLogLevel#
Description: Set the logging level.
- EFDB_Topic:
SALGeneric_command_setLogLevel
- Category:
csc
level#
- IDL_Type:
int
- Units:
unitless
Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem#
- IDL_Type:
string
- Units:
unitless
Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.
Enumerations#
- AlarmRuleState:
Unconfigured
Configuring
Configured
Running
Ending
Stopping
Failing
Stopped
Failed
ConfigureFailed
Events#
alarm#
Description: AlarmRule alarm.
- EFDB_Topic:
AlarmRule_logevent_alarm
classname#
- IDL_Type:
string
- Units:
unitless
Description: Name of alarm rule class.
severity#
- IDL_Type:
byte
- Units:
unitless
- Enumeration:
NONE,WARNING,SERIOUS,CRITICAL
Description: An AlarmSeverity enum indicating the alarm rule severity.
reason#
- IDL_Type:
string
- Units:
unitless
Description: The reason for the alarm.
muted#
- IDL_Type:
boolean
- Units:
unitless
Description: Was the alarm muted or not?
acknowledged#
- IDL_Type:
boolean
- Units:
unitless
Description: Was the alarm acknowledged or not?
description#
Description: Class name, description, and a list of the remotes it uses – basically metadata that does not usually depend on configuration.
- EFDB_Topic:
AlarmRule_logevent_description
classname#
- IDL_Type:
string
- Units:
unitless
Description: Name of alarm rule class.
description#
- IDL_Type:
string
- Units:
unitless
Description: Brief description of the alarm rule.
remotes#
- IDL_Type:
string
- Units:
unitless
Description: Names of remote SAL components used by the alarm rule as a comma-separated list. Each name is appended with :<index> if the component is indexed (and possibly with :0 if not indexed).
state#
Description: AlarmRule state.
- EFDB_Topic:
AlarmRule_logevent_state
classname#
- IDL_Type:
string
- Units:
unitless
Description: Name of alarm rule class.
state#
- IDL_Type:
byte
- Units:
unitless
- Enumeration:
Unconfigured,Configured,Running,Paused,Ending,Stopping,Failing,Stopped,Failed,ConfigureFailed
Description: An AlarmRuleState enum indicating the alarm rule state.
reason#
- IDL_Type:
string
- Units:
unitless
Description: More information about the state change; typically a reason for failure if the state is FAILED.
heartbeat#
Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.
- EFDB_Topic:
SALGeneric_logevent_heartbeat
- Category:
mandatory
heartbeat#
- IDL_Type:
boolean
- Units:
unitless
Description: Deprecated field that you should ignore.
logLevel#
Description: Current logging level.
- EFDB_Topic:
SALGeneric_logevent_logLevel
- Category:
mandatory
level#
- IDL_Type:
int
- Units:
unitless
Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.
subsystem#
- IDL_Type:
string
- Units:
unitless
Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.
logMessage#
Description: A log message.
- EFDB_Topic:
SALGeneric_logevent_logMessage
- Category:
mandatory
name#
- IDL_Type:
string
- Units:
unitless
Description: Log name.
level#
- IDL_Type:
int
- Units:
unitless
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
message#
- IDL_Type:
string
- Units:
unitless
Description: Log message.
traceback#
- IDL_Type:
string
- Units:
unitless
Description: Exception traceback; “” if not an exception.
filePath#
- IDL_Type:
string
- Units:
unitless
Description: Path to source file.
functionName#
- IDL_Type:
string
- Units:
unitless
Description: Function or method name.
lineNumber#
- IDL_Type:
long
- Units:
unitless
Description: Line number in the file specified by filePath.
process#
- IDL_Type:
long
- Units:
unitless
Description: Process ID.
timestamp#
- IDL_Type:
double
- Units:
second
Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.
softwareVersions#
Description: Current versions of software in use by CSC.
- EFDB_Topic:
SALGeneric_logevent_softwareVersions
- Category:
mandatory
salVersion#
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of SAL generation.
xmlVersion#
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: This is the current version of CSC XML.
cscVersion#
- IDL_Type:
string
- IDL_Size:
256
- Units:
unitless
Description: The software version of this CSC.
subsystemVersions#
- IDL_Type:
string
- Units:
unitless
Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within this CSC.