Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Configuring an Alarm Detection

Create an Alarm Detection configuration by clicking the New Configuration button in the upper left part of the Desktop window, and then selecting Alarm Detection from the menu.

...

Select the Workflow Alarm Value Names option to define a variable you can use in the APL code, see the /wiki/spaces/MD82/pages/3781270 APL Reference Guide.

Field/OptionDescription
Alarm Detection EnabledSelect this checkbox to turn on alarm detection.
DescriptionEnter a statement that describes the Alarm Detection that you are defining.
Severity

Select the importance priority of the alarm from the drop-down list. The available severities are:

  • Indeterminate
  • Warning
  • Minor
  • Major
  • Critical 

Adding an Alarm Condition

At the bottom of the Alarm Detection configuration, click the Add button. The Add Alarm Condition dialog box opens.

...

Select a condition in the Alarm Condition drop-down list.

Anchor
AlarmConditions
AlarmConditions
Alarm Conditions

The Alarm conditions enable you to define specific situations or events for which you want the system to produce an alarm. You configure a condition to produce an alarm whenever a certain behavior occurs, within specific limits.

...

  • Host Statistic Value
  • Pico Instance Statistic Value
  • System Event

  • Unreachable Execution Context
  • Workflow Alarm Value

  • Workflow Execution Time

  • Workflow Group Execution Time

  • Workflow Throughput


Host Statistic Value

The Host Statistic Value condition enables you to setup an Alarm Detection for the various statistic values by host.

...

ItemDescription
Event Properties

Host

Select a host for applying the alarm condition.

Statistic Value

The statistic criteria on host includes:

  • Processes Waiting For Run (#)
  • processes In Sleep (#)
  • Processes Swapped Out (#)
  • Swapped In From Disk (blocks/s)
  • Swapped To Disk (blocks/s)
  • Context Switches (/s)
  • CPU User Time (%)
  • CPU System Time (%)

Limits

Specify the condition for the alarm to be triggered. The options are Exceeds or Falls Below the selected statistic value.
Enable "During Last" checkbox to further focus on the X duration of Minutes/ Hour. 

Pico Instance Statistic Value

The Pico Instance Statistic Value condition enables you to setup an Alarm Detection for the various statistic values by pico instances.

...

ItemDescription
Event Properties

Pico Instance

Select a Pico instance for configure alarm, it can be Platform, EC

Statistic Value

The statistic criteria on Pico instance includes:

  • Used Memory (Kb)
  • Garbage Collection Count (#)
  • Garbage Collection Time (ms)
  • Thread Count (#)
  • Open files count (#)
  • CPU usage time (%)

Limits

Specify the condition for the alarm to be triggered. The options are Exceeds or Falls Below the selected statistic value.
Enable "During Last" checkbox to further focus on the X duration of Minutes/ Hour. 

System Event

The System Event condition enables you to setup an Alarm Detection for the various Event types.

...

Info
titleExample - Configuring a System Event condition


Note
titleNote!

The parameters in the following example do not apply to any specific system and are only presented here to enhance understanding of the alarm condition.


  1. Configure an Alarm Detection that applies the System Event condition.

    Configure an Alarm Detection


  2. On the Edit Alarm Condition dialog box, from the Event Type drop-down list, select Workflow State Event.
     

  3. On the Filter table double-click workflowName; the Edit Match Value dialog box opens.
     

  4. Click Add to browse and look for the specific workflow.
     

  5. Enter a limit of occurred more than 3 times during the last 24 hours.

    Select an Alarm Condition

The alarm will be triggered by every 4th occurrence of a "Workflow State Event" during the last 24 hours.

Unreachable Execution Context

The Unreachable Execution Context condition enables you to setup an Alarm Detection base on selected Pico Instance, except platform.

...

ItemDescription
Event Properties

Pico Instance

Select a Pico instance for configure alarm, it can be Platform, EC

Unreachable due to normal shutdown

Unchecked this checkbox to ignore the pico unreachable due to shutdown by purpose.

Limits

Enable "During Last" checkbox to further focus on the X duration of Minutes/ Hour. 

Workflow Alarm Value

The Workflow Alarm Value condition is a customizable alarm condition. It enables you to have the Alarm Detection watch over a variable that you create and assign through the APL code. To apply the Workflow Alarm Condition use the following guidelines:

...

ItemDescription
Workflow Properties

Value

Select an alarm value from the drop-down list.

Workflow

Click Browse... to enter the workflow instance(s) that you want to apply the alarm to.

Limits

Summation: Select this check box to add up the dispatchAlarmValue variable (countBillingFiles in the figure above, The Workflow Alarm Value configuration) whenever it is invoked. Alarm Detector compares this total value with the alarm limit (exceeds or falls below), and generates an alarm message accordingly.

Note: Selecting Summation means that the During Last entry refers to the time period during which a sum is added up. Once the set period has ended, that sum is compared with the limit value.

For All Workflows: Select this check box to add up the values (see Summation above) of all the workflows that the alarm supervises. Alarm Detector compares this total value with the alarm limit (exceeds or falls below), and generates an alarm message accordingly. Note: This check box can only be selected when Workflow is set to Any.

For further information about Limits see the section above, Host Statistic Value.

Workflow Execution Time

The Workflow Execution Time condition enables you to generate an alarm whenever the execution time of a particular, or all workflows, exceed or fall below the time limit that you specify.

...

Info
titleExample - Configuring a Workflow Execution Time condition


Note
titleNote!

The parameters in the following example do not apply to any specific system and are only presented here to enhance understanding of the alarm condition.

A telecom provider wants the system to identify a workflow that has recently run out of input, and to generate an alarm that warns about a processing time that is too short.

  1. Configure an Alarm Detection to use the Workflow Execution Time condition.

    Configure an Alarm Detection

  2. Click Browse...; the Workflow Instance Selection dialog box opens.

  3. At the bottom of the dialog box click Any or select the workflow specific for this alarm.

    1. Set a limit to generate an alarm if the workflow execution time Falls below 2 seconds.

      Configure the Alarm Condition

An alarm is generated whenever an active workflow seems to process data too fast (in less than 2 seconds).

Workflow Group Execution Time

The Workflow Group Execution Time alarm condition enables you to generate an alarm whenever the execution time of a workflow group exceeds or falls below the time limit that you specify.

...

Info
titleExample - Configuring a Workflow Group Execution Time condition


Note
titleNote!

The parameters in the following example do not apply to any specific system and are only presented here to enhance understanding of the alarm condition.

You want the system to generate an alarm if a billing workflow group has been active longer than 3 hours.

  1. Configure an Alarm Detection that uses the Workflow Group Execution Time condition.

    Configure an Alarm Detection
  2. On the Edit Alarm Condition dialog box click Browse... to enter the workflow group you want the alarm detection to supervise.

    Configure the Alarm Condition
  3. Enter a limit of Exceeds 3 hours.

The alarm will be triggered if the workflow group has been active longer than 3 hours.

Workflow Throughput

The Workflow Throughput alarm condition enables you to create an alarm if the volume-per-time processing rate of a particular workflow exceeds, or falls below, the throughput limit that you specify.

...