Skip to main content
Sumo Logic

Write a Threshold Rule

Learn how to write a Threshold rule.

This topic has information about the Threshold rules and how to create them in the CSE UI.

About Threshold rules

A Threshold rule fires when its rule expression is matched at least a certain number times during a specified length of time. For example, if there are five or more failed login attempts for the same IP address within one hour. 

Create a Threshold rule

  1. Choose Rules from the Content menu.
  2. On the Create a Rule page, click Create in the Threshold card. 
    select-rule-type.png
  3. In the rules editor:
    1. Name. Enter a name for the rule. 
    2. Enabled. By default the rule will be enabled. It's good practice to use the slider to disable the rule so that it won’t be applied to incoming Records until you’ve tested it.   
      threshhold.png

Configure “If Triggered” settings

  1. When the expression. Enter the rule expression, a boolean expression that when “true”, causes the rule to fire.
  2. matches n Record. Select how many Records must match the rule expression during the interval you specify below, in the within option.
  3. within. Select the duration within which the rule expression must evaluate to “true” more than the number of times specified in matches n Record for the rule to fire a Signal.
  4. Show advanced. Click this link, in the upper right corner of the If Triggered area, to display advanced options. When you checkmark an advanced option, the If Triggered area refreshes, displaying additional fields.
    advanced-threshold.png
  5. Count only distinct value for a field. Configure this option if you only want to count the number of Records that contain  distinct values of a particular Record field, instead just counting Record that match your rule expression. Use the for field dropdown list to select the desired field. 
  6. group by one or more fields. By default, a threshold rule implicitly groups by the entity field you’ll select below when configuring the Then Create a Signal options. You can select additional “group by” fields with the matches grouped by option, so that a Signal is only created if the count for the group is above the threshold count specified above. 

Test your rule expression

After creating a rule expression, you can test it against existing Records in CSE. 

  1. Click Test Rule above the rule expression. 
  2. The If Triggered section expands, and CSE searches for Records that match the rule expression. If there are no matching Records, you'll see a There aren't any matches for the expression message.
  3. If no matches were returned, try changing the time range. 

Configure “Then Create a Signal” settings

  1. On Entity. Select the Entity field—an IP address, MAC address, hostname, or username—in the Record that the resulting Signal should be associated with. (In CSE, an Insight is a set of Signals with the same Entity field.) Select a value from the pull-down list. 
  2. with the summary.
  3. with the description. Define the description for the Signal. You can use text and Record fields. The Signal description should be a good indication of what the rule looks for.
  4. with a severity of. Severity is an estimate of the criticality of the detected activity, from 1 (lowest) to 10 (highest).
  5. with tags. If desired, you can add metadata tags to your rule. Tags are useful for adding context to items like Rules, Insights, Signals, Entities. You can also search for and filter items by tag. For more information, see Using Tags with Insights, Signals, Entities, and Rules.

Save as prototype

If you are not sure that your rule is ready for prime time, you can save it as a prototype. A prototype rule generates Signals, but those Signals won't contribute to Insights. (Signals generated by a prototype rule do not increment the rule's On Entity entity's Activity Score.) Running the rule as a prototype for a while allows you to determine whether the rule is too noisy and fires too many Signals.

To make the rule a prototype, click the box next to Save this rule as a prototype. When you are satisfied with the rule's behavior you can uncheck the box.

Duplicate Signals?

If you determine that a Threshold, Chain, or Aggregation rule is firing identical Signals for the same conditions during the same time interval, there’s a likely explanation. This situation can arise due to how these rule types are processed: they are evaluated differently than Match rules, because they support time duration conditions. For example, a Threshold rule fires when its rule expression is matched at least a certain number times during a specified length of time.

To successfully apply a rule across a sliding time window, CSE evaluates Records across overlapping time spans. Consider a rule that requires three matches across five minutes. With non-overlapping windows, we could detect one match at the end of one time window, and two more in the following time window. This should cause the rule to fire a Signal, but would not, because the required five minute span is split between two evaluation windows. Overlapping evaluation windows solves this problem. In some cases though, it can also result in duplicate Signals. Note however, as long as you don’t run the rule as a prototype, duplicate Signals will be suppressed, as described in Automatic suppression of redundant Signals