From 3e9158d11a07148499caaa52adc4a185908fe6da Mon Sep 17 00:00:00 2001 From: Eldon Koyle Date: Fri, 4 Dec 2015 11:37:37 -0700 Subject: [PATCH 1/2] Add more docs on alerting foo --- doc/Extensions/Alerting.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/Extensions/Alerting.md b/doc/Extensions/Alerting.md index d87d30a110..6a7947f380 100644 --- a/doc/Extensions/Alerting.md +++ b/doc/Extensions/Alerting.md @@ -33,6 +33,10 @@ Table of Content: - [Device](#macros-device) - [Port](#macros-port) - [Time](#macros-time) +- [Additional Options](#extra) + - [Max](#extra-max) + - [Delay](#extra-delay) + - [Interval](#extra-interval) # About @@ -633,4 +637,18 @@ Description: Packet loss % value for the device within the last 15 minutes. Example: `%macros.packet_loss_15m` > 50 +# Additional Options +Here are some of the other available options for an alert rule. + +## Max + +The maximum number of alerts sent for the event. `-1` means unlimited. + +## Delay + +The amount of time to wait after a rule is matched before sending an alert. + +## Interval + +The interval of time between alerts for an event until Max is reached. From 475a72178784f0db816d5bd4f3cd665b4f189aa8 Mon Sep 17 00:00:00 2001 From: Eldon Koyle Date: Fri, 4 Dec 2015 11:54:50 -0700 Subject: [PATCH 2/2] Save some space, add a few more options --- doc/Extensions/Alerting.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/doc/Extensions/Alerting.md b/doc/Extensions/Alerting.md index 6a7947f380..80ddab7dc3 100644 --- a/doc/Extensions/Alerting.md +++ b/doc/Extensions/Alerting.md @@ -34,9 +34,6 @@ Table of Content: - [Port](#macros-port) - [Time](#macros-time) - [Additional Options](#extra) - - [Max](#extra-max) - - [Delay](#extra-delay) - - [Interval](#extra-interval) # About @@ -639,16 +636,12 @@ Example: `%macros.packet_loss_15m` > 50 # Additional Options -Here are some of the other available options for an alert rule. +Here are some of the other options available when adding an alerting rule: -## Max - -The maximum number of alerts sent for the event. `-1` means unlimited. - -## Delay - -The amount of time to wait after a rule is matched before sending an alert. - -## Interval - -The interval of time between alerts for an event until Max is reached. +- Rule name: The name associated with the rule. +- Severity: How "important" the rule is. +- Max alerts: The maximum number of alerts sent for the event. `-1` means unlimited. +- Delay: The amount of time to wait after a rule is matched before sending an alert. +- Interval: The interval of time between alerts for an event until Max is reached. +- Mute alerts: Disable sending alerts for this rule. +- Invert match: Invert the matching rule (ie. alert on items that _don't_ match the rule).