The RuleBaseEngine:suspendAllAlerts Method
The RuleBaseEngine:suspendAllAlerts method suspends all current and future alerts in the rulebase engine for the specified number of milliseconds.
Remarks
If a specific rulebase is provided as an argument, this method applies only the alerts generated by that rulebase.
This method is generally used as an Action to a Rule using RBE:onAlertRate as a data source to create an alert-rate circuit breaker.
RuleBaseEngine:suspendAllAlerts takes a rulebase argument. If empty, it suspends all alerts on all rulebases. After suspending all alerts, a high level alert (one per rulebase) is issued to indicate that the rulebase has been suspended. That alert will be cleared when the suspension period expires.
When a rulebase is suspended, all its current and future alerts are suspended for the specified interval. Note that all other monitoring activity continues. For example, actions that send email or invoke scripts or other methods continue to operate normally.
Arguments
| Name | Type | Description |
|---|---|---|
| RuleBaseName | String | The name of the rulebase whose alerts will be suspended. If omitted, this method applies to all rulebases. |
| Time | Long | The suspension period in milliseconds. Cannot be zero or negative. |
| Reason | String | The reason for this suspension. It is useful to also provide the time and source of suspension in this string. Cannot be empty string. |