> For the complete documentation index, see [llms.txt](https://help.boomerang3.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.boomerang3.com/boomerang-3-domain-administrator-manual/dashboard/alarms_and_warnings/alarm-filter.md).

# Alarm filter

An alarm limit has a parameter called Alarm Filter.

The Alarm Filter can be defined as a number of consecutive readings beyond a limit, that must be registered before the alarm detection will be armed.

To trigger an alarm, the system uses an internal counter C which:

* is initially equal to the Alarm Filter value,
* is decreased by 1 after a reading outside the limits is registered,
* is set back to the Alarm Filter value when a reading is within the limits,
* is set back to the Alarm Filter value when the alarm for the MP is signed.

If C = 0 then alarm detection is armed and the next reading outside the limits will trigger an alarm.

Below there are some examples showing the alarm triggering for different Alarm Filter values.

### Example 1

<figure><img src="/files/NGmsc0BjChJLhmpzPzwl" alt=""><figcaption></figcaption></figure>

Alarm Filter = 0, initial C = 0, alarm detection is always armed.

Alarm is triggered at the first reading outside the limits.

### Example 2

<figure><img src="/files/ZAhvswy6aVYZCeMt4Ku0" alt=""><figcaption></figcaption></figure>

Alarm Filter = 2, initial C = 2, alarm detection is armed after 2 readings outside the limits.

Alarm is triggered at the third consecutive reading outside the limits.

### Example 3

<figure><img src="/files/zGuJhg8K7hCvA8P98nDk" alt=""><figcaption></figcaption></figure>

Alarm Filter = 2, initial C = 2, alarm detection is armed after 2 readings outside the limits.

Alarm is not triggered because the reading registered when C = 0 is within the limits which sets the counter C back to 2.

This method has the following consequences:

* If an active (not signed) alarm exists and any next reading was back within the limits, the next alarming sequence will generate another active alarm.
* If there is an active alarm and the readings are still beyond the limits, no new alarm will be activated. On the other hand, if the readings are still outside the limits, and an active alarm is signed, it will be generated again as soon as the alarm filter conditions are met.

The Alarm Filter is used to properly handle the real life scenarios where we want to observe a parameter frequently but the alarms shall only be activated if multiple readings are outside the limits.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.boomerang3.com/boomerang-3-domain-administrator-manual/dashboard/alarms_and_warnings/alarm-filter.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.