Alerting: Rule Builder Tab

Document created by RSA Information Design and Development on Jul 26, 2016Last modified by RSA Information Design and Development on Jul 26, 2016
Version 2Show Document
  • View in full screen mode
 

This topic describes the components of the Rule Builder tab that you use to define rule criteria. 

The Rule Builder tab enables you to define a Rule Builder rule.

To access the Rule Builder tab:

  1. In the Security Analytics menu, select Alerts > Configure.
    The Configure view is displayed with the Rules tab open by default.
  2. In the Rule Library toolbar, select addList.PNG > Rule Builder.
    The Rule Builder tab is displayed.

The following figure shows the Rule Builder tab.

NwBasRuleTb.png

Features

The following table lists the parameters in the Rule Builder tab.

                       
ParametersDescription
Rule NamePurpose of the ESA rule.
Description Summary of what the ESA rule detects.
Trial RuleDeployment mode to see if the rule runs efficiently.
Severity Threat level of alert triggered by the rule.
QueryEPL query that defines rule criteria.

The Rule Builder tab includes the following components:

  • Conditions section
  • Notifications section
  • Enrichments section

Conditions Section

In the Conditions section of the Rule Builder tab, you define what the rule detects.

The following figure shows the Conditions section.

RBCond5F1S.png

The following table lists the parameters of the Conditions section.

                                            
ParameterDescription
Add iconAdd a statement.
Delete iconRemove selected statement.
Edit iconEdit selected statement.
StatementLogical group of conditions for one operation.
OccursAlert frequency if the condition is met. For a single statement, Occurs is only valid when you use followed by or Group By. This specifies that there must be at least that many events that satisfy the criteria  in order to trigger an alert. The time window in minutes binds the Occurs count.
ConnectorOptions to specify relationship among the statements:
  • followed by
  • not followed by
  • AND
  • OR
The Connector joins two statements with AND, OR, or followed by. When followed by is used, it specifies that there is a sequencing of those events. AND and OR build one large criteria. The followed by creates distinct criteria that occurs in sequence.
Correlated OnOption for the "Not followed by" connector. Specify the meta key for the field that you want to ensure does not follow in the sequence.
occurs within minutesAlert frequency if all conditions are met.
Group ByMeta key by which to group results. For example, suppose that there are three users; Joe, Jane, and John and you use the Group By meta, user_dst. The result will show events grouped under Joe, Jane, and John.

Notifications

In the Notifications section, you can choose how to be notified when ESA generates an alert for the rule.

For more information on the alert notifications, see Add Notification Method to a Rule.

The following figure shows the Notifications section.

NotificationAdded.png

                                    
ParameterDescription
To add an alert notification type.
To delete the selected alert notification.
OutputAlert notification type. Options are:
  • Email
  • SNMP
  • Syslog
  • Script
NotificationName of previously configured output, such as an email distribution list.
Notification ServerName of server that sends the output.
TemplateName of template for the alert notification.
Output Suppression of every    Option to specify alert frequency.
MinutesAlert frequency in minutes.

Enrichments

In the Enrichments section, you can add a data enrichment source to a rule.

For more information on the enrichments, see Add an Enrichment to a Rule.

The following figure shows the Enrichments section.
RuleEnrSec.png

                            
ParameterDescription
ic-addList.PNGTo add an enrichment.
To delete the selected enrichment.
OutputEnrichment source type. Options are:
  • In-Memory Table
  • External DB Reference
  • Warehouse Analytics
  • GeoIP
Enrichment SourceName of previously configured enrichment source, such as a .CSV filename for an In-Memory Table.
ESA Event Stream MetaESA meta key whose value will be used as one operand of join condition.
Enrichment Source Column NameEnrichment source column name whose value will be used as the other operand of the join condition.
You are here: References > Rule Builder Tab

Attachments

    Outcomes