From 7c731103fd73e70a84baa76692ae78fcf268dd02 Mon Sep 17 00:00:00 2001
From: f0o <f0o@librenms.org>
Date: Fri, 19 Jun 2015 17:11:26 +0000
Subject: [PATCH] Add macro `%macros.sensor` to filter out ignored sensors

---
 doc/Extensions/Alerting.md | 12 ++++++++++++
 sql-schema/055.sql         |  1 +
 2 files changed, 13 insertions(+)
 create mode 100644 sql-schema/055.sql

diff --git a/doc/Extensions/Alerting.md b/doc/Extensions/Alerting.md
index f763f32b35..9390e53afe 100644
--- a/doc/Extensions/Alerting.md
+++ b/doc/Extensions/Alerting.md
@@ -49,6 +49,7 @@ Rules must consist of at least 3 elements: An __Entity__, a __Condition__ and a
 Rules can contain braces and __Glues__.  
 __Entities__ are provided as `%`-Noted pair of Table and Field. For Example: `%ports.ifOperStatus`.  
 __Conditions__ can be any of:
+
 - Equals `=`
 - Not Equals `!=`
 - Matches `~`
@@ -67,6 +68,7 @@ Arithmetics are allowed as well.
 ## <a name="rules-examples">Examples</a>
 
 Alert when:
+
 - Device goes down: `%devices.status != '1'`
 - Any port changes: `%ports.ifOperStatus != 'up'`
 - Root-directory gets too full: `%storage.storage_descr = '/' && %storage.storage_perc >= '75'`
@@ -81,12 +83,14 @@ The template-parser understands `if` and `foreach` controls and replaces certain
 ## <a name="templates-syntax">Syntax</a>
 
 Controls:
+
 - if-else (Else can be omitted):  
 `{if %placeholder == 'value'}Some Text{else}Other Text{/if}`
 - foreach-loop:  
 `{foreach %placeholder}Key: %key<br/>Value: %value{/foreach}`
 
 Placeholders:
+
 - Hostname of the Device: `%hostname`
 - Title for the Alert: `%title`
 - Time Elapsed, Only available on recovery (`%state == 0`): `%elapsed`
@@ -490,3 +494,11 @@ Example: `%macros.past_5m` is Last 5 Minutes.
 Resolution: 5,10,15,30,60
 
 Source: `DATE_SUB(NOW(),INTERVAL $ MINUTE)`
+
+## <a name="macros-sensors">Sensors</a> (Boolean)
+
+Entity: `%macros.sensor`
+
+Description: Only select sensors that aren't ignored.
+
+Source: `(%sensors.sensor_alert = 1)`
diff --git a/sql-schema/055.sql b/sql-schema/055.sql
new file mode 100644
index 0000000000..bdcd91be0d
--- /dev/null
+++ b/sql-schema/055.sql
@@ -0,0 +1 @@
+insert into config (config_name,config_value,config_default,config_descr,config_group,config_group_order,config_sub_group,config_sub_group_order,config_hidden,config_disabled) values ('alert.macros.rule.sensor','(%sensors.sensor_alert = 1)','(%sensors.sensor_alert = 1)','Sensors of interest','alerting',0,'macros',0,1,0);