How to Configure Alarm Conditions and Alarm Reactions
Although you can configure Alarm Condition objects and Alarm Reaction scripts manually, using Genesys Administrator, the Management Layer provides an automated procedure.
You can configure new Alarm Conditions based on either source for their detection:
- Log Events—These Alarm Conditions trigger an alarm when an application or applications generate a specified log event.
- Alarm Detection Scripts—These Alarm Conditions trigger an alarm when a certain system variable changes in a specified manner.
For alarms based on log events, alarm detection takes place in Message Server. Therefore, if you configure log event–based Alarm Conditions, you must configure your applications to connect to Message Server.
Using Log Events for Alarm Detection
To configure alarm conditions or alarm reactions in Genesys Administrator, create the alarm condition or alarm reaction under Provisioning > Environment > Alarm Conditions, being sure to specify the appropriate log event on the Configuration tab. You can also use pre-configured Alarm Condition objects. Refer to Genesys Administrator Help for detailed instructions about creating and using these necessary objects.
You can also use the Alarm Condition Wizard to associate Alarm Reactions with the Alarm Condition you are configuring.
For complete specifications of log events reported at the Alarm, Interaction, Standard, and Trace levels, see Framework Combined Log Events Help.
Using Detection Scripts for Alarm Detection
Management Layer provides an additional alarm-detection mechanism, called Advanced Alarm Detection. Through this mechanism, you can configure Alarm Conditions:
- Based on the threshold for a system performance variable (CPU or memory usage).
- Based on the threshold for a local or remote SNMP variable (available only when you have enabled SNMP functionality).
Set alarms based on the Advanced Alarm Detection methods using Alarm Detection scripts, and then associate them with corresponding Alarm Conditions. When an Alarm Condition object refers to an Alarm Detection script, the alarm detection for this Alarm Condition is performed as specified by the Alarm Detection script, regardless of whether any log event is specified as a Detection Event.
Using Alarm Detection and Reaction Scripts with Alarm Conditions
To configure an Alarm Detection Script, do the following:
If there is a specific automated action that you want to happen as a result of the alarm, configure an Alarm Reaction script. For example, to generate an SNMP trap when this alarm is triggered, do the following:
To create the corresponding Alarm Condition object, follow these steps:
Types of Alarm Reactions
You can configure alarm reactions of the following types:
- Start a specified application
- Stop a specified application
- Restart the application that generated the alarm
- Start a specified solution
- Send an email
- Send an SNMP trap
- Switch over to the backup application
- Execute OS command
- Change application option
The configuration procedure for most of the alarm reactions is self-explanatory in the Alarm Reaction Wizard. You must supply information for these configuration parameters:
- A unique name for the Alarm Reaction configuration object (for all types of alarm reactions).
- A name of the application or solution the alarm reaction is configured for (for alarm reactions of such types as Start a specified application, Stop a specified application, Start a specified solution, and Restart the application that generated the alarm).
You must provide additional information for alarm reactions of the following types:
When configuring an alarm reaction of the Switchover type, you can specify whether Solution Control Server should perform the switchover when an application, which generates an alarm, is running in a particular mode:
- Select primary if you want SCS to perform a switchover only if the application that has generated an alarm is currently operating in Primary mode.
- Select backup if you want SCS to perform a switchover only if the application that has generated an alarm is currently operating in Backup mode.
- Select perform switchover always if you want SCS to perform a switchover regardless of the operating mode of the application that generates the alarm.
You might use these options, for instance, when associating an alarm reaction of the Switchover type for T-Server with the CTI Link Disconnected log event. Selecting primary for the alarm reaction configuration may prevent an unwanted switchover if the T-Server that produced this log event currently operates in Backup mode.
Send an E-Mail
To configure an alarm reaction of type Send an E-Mail, specify the recipients of the email in the Alarm Reaction Wizard. Then, compose the subject and text of the email message, using reserved variables. See Genesys Administrator Help for detailed instructions on configuring the email script, including an example. See E-Mail Alarm Reactions for more information about the email interface itself.
Send an SNMP Trap
To configure an alarm reaction of the Send an SNMP Trap type, specify a Name for the Alarm Reaction configuration object. All necessary information is automatically provided by SCS, given that the SNMP Master Agent application is configured correctly.
See SNMP Interface for more information about enabling the SNMP alarm signaling.
Execute OS command
To configure an Alarm Reaction of the Execute OS Command type, specify the name of the operating system command that is to be executed when an alarm is detected. If necessary, include the full path to the executed command.
SCS executes all alarm reactions. In the case of an alarm reaction of the Execute OS Command type, SCS executes the specified command on its own host computer. Therefore, a currently logged in user must have sufficient permissions to execute the specified operating system command.
SCS passes information about a detected alarm to the operating system command to be executed. For this purpose, SCS adds command-line arguments (listed in the table below) to the command line you specify in the Command property when you configure the alarm reaction.
Additional Command-Line Parameters
The following table describes the additional command-line parameters that are added to the Command property when you configure an Execute OS Command Alarm Reaction.
The following are examples of how to use and configure Execute OS Command Alarm Reactions. [+] Show examples
Change application option
Management Layer allows execution of Alarm Reactions not only at Alarm activation, but also at Alarm clearance. To achieve this, add the Alarm Reactions that are to be executed when the Alarm is cleared to the Clearance Scripts list of the corresponding Alarm Condition object. You can also use the Alarm Condition Wizard to accomplish this.