Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit a56ea6e

Browse files
authored
Update rules-engine-matching-conditions.rst
Added a section on new Routing Key matching functionality, cleaned up some miscellaneous language, and added a section on rule processing order
1 parent f226324 commit a56ea6e

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

sp-oncall/alerts/rules-engine/rules-engine-matching-conditions.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,13 @@ Matching conditions for the Rule Engine
1313

1414
Matching conditions determine when a rule is applied. You can choose any field that exists within the payload of an alert and match on a specific value for that field using a direct match, wildcard matching, or by using a regular expression.
1515

16-
By default, the Rules Engine only uses wildcard matching. If you want to turn on regular expressions, contact Splunk On-Call support.
17-
1816
Requirements
1917
==================
2018

2119
This integration is compatible with the following versions of Splunk On-Call:
2220

2321
- Enterprise
2422

25-
All users have the ability to reach out to Splunk On-Call support at any time with questions.
26-
27-
Live Chat: If you are logged into your Splunk On-Call instance, you will have the ability to Live Chat with the Splunk On-Call Support team.
28-
29-
3023
Field names
3124
==================
3225

@@ -116,6 +109,13 @@ Regular expression examples
116109
- ``cat`` |br| ``car`` |br| ``catalyst`` |br| ``carbon`` |br| ``a la carte``
117110
- ``chart`` |br| ``clark``
118111

112+
Routing Key matching
113+
===================================
114+
115+
In addition to Wildcard and Regular expression matching, you can explicitly define routing key matching via the :guilabel:`Associated routing key` selector. This provides AND logic to the matching parameters specified in your Wildcard or RegEx matching section.
116+
117+
.. note:: Routing Key matching via the :guilabel:`Associated routing key` selector is unable to match on other routing keys via the top-bar Wildcard or RegEx matching criteria or manipulate routing keys via the :guilabel:`Transform these alert fields` section. It only provides an AND matching condition, specifically for a routing key, for use alongside your other matching and transformation parameters.
118+
119119
Boolean logic
120120
===================================
121121

@@ -139,3 +139,12 @@ The matching condition for the second rule, which you must position below the fi
139139
.. image:: /_images/spoc/matching4.png
140140
:width: 100%
141141
:alt: VictorOps Alert Rules Engine, when new_matching_field matches *stage-db-26* set message_type to INFO
142+
143+
Rule processing order
144+
===================================
145+
Alert Rules consider three criteria for the order in which they'll be processed.
146+
1. Top-to-bottom order of the alert rules
147+
2. The optional :guilabel:`Stop after this rule has been applied` setting on each rule
148+
3. Rules with Routing Key matching via the :guilabel:`Associated routing key` selector
149+
150+
For each alert that is ingested, all rules without an :guilabel:`Associated routing key` match will first process in top-to-bottom order. If a rule matches with the :guilabel:`Stop after this rule has been applied` setting, it will stop the application of alert rules for that alert. Lastly, rules with a specific routing key match via the :guilabel:`Associated routing key` selector will apply. Having these types of rules apply last allows them to match on the final routing key of an alert in case this value is changed by a different alert rule.

0 commit comments

Comments
 (0)