Versions Compared

Key

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

...

An Alarm Detection configuration enables you to define criteria for the generation of alarm messages. You select a condition, or combine a set of conditions, that within specific limits, generate an alarm message. To monitor the system alarms, you use the  Image Removed Web Interfacethe Usage Engine web interface. You can send alarm messages to SNMP monitoring systems, as well.

Alarm Detection Buttons

The contents of the button panel may change depending on which configuration type has been opened in the currently displayed tab. Alarm Detection uses the standard buttons that are visible for all configurations.

There is one button that is specific for Alarm Detection.

Button

Description

Workflow Alarm Value Names

To define a variable to use in the APL code, see the APL Reference Guide(4.0) , and the section below, Workflow Alarm Value for further information.

Defining an Alarm Detection

An Alarm Detection definition is made up of:

...

  • 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.

Item

Description

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.

Item

Description

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 set up an Alarm Detection for the various Event types.

Setting

Description

Type

Select an event-related reason for an alarm to be invoked. For a detailed description of every event type, see Event Types(4.0).

Filter

Use this table to define a filter of criteria for the alarm messages that you are interested in.

To define an entry, double-click on the row.

The Edit Match Value dialog box opens. Click the Add button to add a value.

Limits

See the section above, Host Statistic Value

Specify the condition for the alarm to be triggered. The options are based on the number and frequency of occurrence of the event: Occurred Once, Occurred More Than, Occurred Less Than. In During Last, specify the time frame during which the Limits value should be compared. If a match is detected, an alarm is invoked.

Info

Example - 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.

  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.

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

...

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

Item

Description

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. 

Anchor
wfalarmvalue
wfalarmvalue
Workflow Alarm Value

...

  1. At the bottom of the Alarm Detection configuration, click Add; the Add Alarm Condition dialog box opens.

  2.  From the Alarm Condition drop-down list select Workflow Alarm Value.

  3.  From theValue  drop-down list, select the name of the variable that you created.

  4.  Click Browse... to select the Workflow that the Alarm Detection should guard.

  5.  Configure the Limits according to the description of The Workflow Alarm Value and click OK.

Setting

Description

Value

Select an alarm value from the drop-down list.

Workflow

Click Browse... to enter the workflow(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, https://infozone.atlassian.net/wiki/spaces/UEPE4D/pages/233285792#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.

Setting

Description

Workflow

The default workflow value is Any. Use this value when you want to apply the condition to all the Workflows. Otherwise, click Browse to select a Workflow that you apply the condition to.

Info

Example - 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

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

  3. At the bottom of the dialog box click Any.

  4. Set a limit of Falls below 2 seconds

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

...

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.

Setting

Description

Workflow Group

Enter the address of the workflow group to which you want to apply the alarm.

Info

Example - 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.

  2. On the Edit Alarm Condition dialog box, enter the workflow group you want the alarm detection to supervise.

  3. Enter a limit of Exceeds 3 hours.

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

...

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.

Setting

Description

Workflow

Select a workflow with the throughput value, the processing speed, that you want to supervise. For further information about the throughput value calculation, see Throughput Calculation in Workflow Properties (4.0). An alarm is generated if the throughput value is not within the condition limits.

Limits

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

Info

Example - Configuring a Workflow Throughput 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 warn you on detection of decreased processing rate.

  1. Configure an Alarm Detection to use the workflow throughput condition

  2. On the Edit Alarm Condition dialog box, select the workflow with the processing rate that you want to supervise.

  3. Enter a limit of Falls Below 50000 (batches, UDRs, Bytearray).

The alarm will be triggered by every occurrence of a workflow slowing down its processing rate to a throughput that is lower than 50000 units per second.

Activating an Alarm Detection

For a configured alarm detection to become active it needs to be activated using the Alarm Detection Enabled setting.

...

The alarm detection enable/disable toggle button in the Desktop Online will allow you to enable or disable individual alarms using the toggle button available next to the name of the alarm. You can also enable or disable all available alarms at one go using the Enable All or Disable All buttons.

...

Note

Note!

When importing an Alarm Detection configuration using system import or as part of workflow packages, the configuration is disabled. 

...