Skip navigation
All Places > Products > RSA NetWitness Platform > RSA NetWitness Platform Online Documentation > Documents
Log in to create and rate content, and to follow, bookmark, and share content with other members.

Alerting: Deployment Panel

Document created by RSA Information Design and Development Employee on Sep 12, 2017Last modified by RSA Information Design and Development Employee on Sep 8, 2020
Version 16Show Document
  • View in full screen mode
 

ESA rule deployments map rules from your rule library to the appropriate ESA Services and data sources. The Deployment panel ( (Configure) > ESA Rules > Rules tab) enables you to create and configure ESA rule deployments that specify:

  • ESA Services
  • Data Sources (This is available in NetWitness Platform version 11.3 and later.)
  • ESA Rules

When you are ready to start aggregating data and generating alerts from an ESA rule deployment, you deploy the ESA rule deployment to activate it.

Note: An ESA rule deployment can have only one ESA service. You can, however, use the same ESA service in multiple deployments.
In NetWitness Platform version 11.2 and earlier, the ESA service is the Event Stream Analysis service. In version 11.3 and later, it is the ESA Correlation service.

What do you want to do?

                          
Role I want to ...Show me how
Content ExpertAdd an ESA rule deployment.ESA Rule Deployment Steps
Content ExpertManage deployments.Additional ESA Rule Deployment Procedures

Related Topics

Quick Look

The following figure shows the Deployment panel.

Rules Tab Deployment Panel diagram

                                     
1Shows the options panel. Click the deployment in the options panel to view the deployment in the Deployment panel on the right.
2Shows the Deployment panel.
3Shows the ESA rule deployment name.
4The ESA Services section shows the ESA Correlation service that processes the ESA rules and creates alerts.
5The Data Sources section shows the data sources, such as Concentrators, that provide the data for the deployment.
6The deployment options enable you to view the changes to the deployment (Show Updates) and deploy the ESA rule deployment on ESA (Deploy Now). The (Configure) > ESA Rules > Services tab shows the status of the deployment after it is deployed.
7The ESA Rules section shows the rules that are used to trigger alerts in the deployment.
8The Data Source Filter (Optional) section enables you to add a filter query to forward only the data relevant to this deployment to ESA. The data source filter is for advanced users familiar with Decoder application rules.

ESA Services Section

In the ESA Services section, you can manage each ESA service in the deployment.

The following table describes the actions you can perform in the ESA Services section.

                    
TaskDescription
Add icon Adds an ESA service to the deployment. 
Delete icon Removes the selected ESA service from the deployment.

The following table describes the columns in the ESA Services section.

                               
TitleDescription
StatusIndicates if the deployment status is AddedDeployedUpdated, or Failed.
NameName of the ESA service.
AddressIP address of the host where the ESA service is installed.
VersionVersion of the ESA service.
Last Deployment DateThe date and time when the ESA service was last deployed.

Data Sources Section

Note: This option is available in NetWitness Platform version 11.3 and later.

In the Data Sources section, you can select one or more data sources, such as Concentrators, to use for your selected ESA Service.

The following table describes the actions you can perform in the Data Sources section.

                          
TaskDescription
Add icon Adds a data source for the selected ESA service to the deployment. 
Delete icon Removes a data source for the selected ESA service from the deployment.
Edit icon (This option is available in NetWitness Platform version 11.3.0.2 and later.) Enables you to change the configuration of a data source in an ESA rule deployment. You can change the data source password, SSL, port, and compression settings. When a data source password changes, it is important to change the password on the data source so that ESA can continue to communicate with the data source.

Note: If you make any ESA service, data source, or ESA rule changes to an ESA rule deployment, you need to redeploy the deployment. For example, if you change the configuration of a data source in an ESA rule deployment, you must redeploy all the ESA rule deployments that contain that data source.
When you set the compression level for a Concentrator on ESA, it sets the same compression level for that Concentrator for ESA Correlation Rules.

The following table describes the columns in the Data Sources section.

                     
TitleDescription
(Status)Shows the status of the data source. A solid colored green circle indicates a running service and a white circle indicates a stopped service.
NameShows the name of the data sources used by the selected ESA service. You can specify the data sources separately for each ESA rule deployment.
TypeShows the type of the data sources. Data sources can be Concentrators or Decoders. It is important that you choose data sources that have the appropriate data for the rules in the deployment. For example, if you have NetWitness Endpoint and you want to deploy the Endpoint Risk Scoring Rules Bundle, you must choose endpoint data sources.

Note: You can add a Log Decoder as a data source for ESA, but it is better to add a Concentrator to take advantage of undivided aggregation as the Decoder may have other processes aggregating from it.

Deployment Options

There are two deployment options below the Data Sources section. These options apply to the entire ESA rule deployment.

The following table describes these deployment options.

                    
TaskDescription
Show UpdatesEnables you to view a history of updates to the deployment.
Deploy NowActivates the ESA rule deployment. The selected ESA service starts aggregating data and generating alerts using the specified ESA rules in the deployment. You need to add ESA Rules to the deployment before deploying the ESA rule deployment.

ESA Rules Section

In the ESA Rules section, you manage rules in the deployment. This section lists all rules that are currently in the deployment. 

The following table describes the actions you can perform in the ESA Rules section.

                            
TaskDescription
Add icon Opens the Deploy ESA Rules dialog, where you can select a rule.
Delete icon Removes the selected ESA rules from the deployment.
Filter icon Filters the list of rules.
Search field Enables you to search for a rule.

The following table describes the columns in the ESA Rules section.

                                       
TitleDescription
StatusIndicates the rule status:
  • Deployed - the rule is deployed.
  • Updated - the rule has been updated since the last deployment.
  • Added - the rule has been added since the last deployment.
  • Disabled - the rule is disabled due to an error in the rule or an error during the deployment of the rule.
In NetWitness Platform version 11.3.0.2 and later, if a disabled rule has an error message, it shows ESA disabled rule error message icon in the Status field. Hover over the rule to view the error message tooltip.
Disabled rule tooltip showing an error message
Rule NameDescribes the purpose of the ESA rule.
Trial RuleIndicates whether the rule is Deployment mode to see if the rule runs efficiently.
SeverityShows the threat level of alert triggered by the rule.
TypeShows the type of the ESA rule. For more information, see ESA Rule Types.
Email, SNMP, Syslog, ScriptIndicates which notification types are used for alerts generated by the rules. (ESA SNMP notifications are not supported in NetWitness Platform version 11.3 and later.)
Last ModifiedShows the date and time when the ESA rule was last modified.

Data Source Filter (Optional) Section

Note: This option is available in NetWitness Platform version 11.5 and later.

The data source filter is optional. If you have a medium to large NetWitness Platform deployment and you have high throughputs, you can add a filter query to forward only the data relevant to this deployment to ESA. This helps to filter out certain types of traffic that does not add value to the analysis of the data in the ESA rule deployment.

Caution: The data source filter is intended for advanced users familiar with Decoder application rules. Improper filtering can cause the required data to not be forwarded to and analyzed by ESA.

Using a data source filter can be performance intensive for data aggregation. A filter slows the event aggregation rate, but when you are filtering a large amount of traffic, it can have performance benefits on ESA Correlation server. However, if you use a complex filter and do not filter a large amount of traffic, the event aggregation rate may be lower than expected.

IMPORTANT: If an application rule linked to a data source filter is modified on a Decoder, the filter must be removed, added again, and redeployed. The changes take effect on ESA after the deployment is redeployed.

The Data Source Filter section with a filter query added

The following table describes the columns in the Data Source Filter (Optional) section.

                            
TitleDescription
Checkbox iconEnables you to select and remove a data source filter.
StatusIndicates the data source filter status:
  • Added - the filter is added to the deployment, but it is not yet deployed.
  • Deployed - the filter is actively streaming only the relevant data as defined in the filter query.
Filter QueryShows the query that contains the application rules. Each application rule query is separated by an "or" condition. You can use either the simple or advanced option to create the data source filter. You can only have one data source filter per deployment for your selected data sources.
Last ModifiedShows the date that the filter was added to the ESA rule deployment.

Create Data Source Filter Dialog - Simple

When you create the data source filter, you select application rules to be included in the filter query. The application rules that you select must be enabled on the Decoders that feed the data sources in this deployment. ESA Correlation uses the filtered event data to process the ESA rules.

Caution: The data source filter is for advanced users familiar with Decoder application rules. Improper filtering can cause the required data to not be forwarded to and analyzed by ESA.

Create Data Source Filter dialog

The following table describes the columns in the Create Data Source Filter dialog.

                                
TitleDescription
Search field Enables you to search for a rule. For example, you can type "account" to search for application rules that contain that word.
Application Rule NameShows the names of the application rules on the Decoders mapped to the data sources in this deployment.
Alert FieldShows the meta key used in the alert.
Present OnShows the number of Decoders mapped to the data sources in this deployment that have the listed application rule. If the rule is not present on all of the Decoders, you can hover over the Information icon icon to view the names of the Decoders that contain the rule.
Absent OnShows the number of Decoders mapped to the data sources in this deployment that do not have the listed application rule. If a rule is not present on all of the Decoders, you can hover over the Information icon icon to view the names of the Decoders that do not contain the rule.

For more information, see "Configure Application Rules" in the Decoder and Log Decoder Configuration Guide.

Create Data Source Filter - Advanced

If necessary, you can use the advanced filter instead of the simple filter to add your data source filter query directly. The individual application rule queries must be separated by an "or" condition. For more information on creating and writing Decoder rules, see "Configure Application Rules" in the Decoder and Log Decoder Configuration Guide.

Caution: The data source filter is for advanced users familiar with Decoder application rules. Improper filtering can cause the required data to not be forwarded to and analyzed by ESA.

Create Data Source Filter dialog - Advanced Filter

Previous Topic:Rule Syntax Dialog
You are here
Table of Contents > ESA Alert References > Deployment Panel

Attachments

    Outcomes