Reporting Engine General Tab

Document created by RSA Information Design and Development on Nov 23, 2016Last modified by RSA Information Design and Development on Feb 6, 2017
Version 4Show Document
  • View in full screen mode
  

This topic introduces the Services Config view > General tab for the Reporting Engine. The General tab for the Reporting Engine service in the Services Config view controls several settings that can tune the performance of a service and specify the user credentials for the service. These settings are used for the Reporting Engine service exclusively.

Procedure

The required permission to access this view is Manage Services.

To access this view:

  1. In the Security Analytics menu, click Administration Services.
  2. In the Services grid, select a Reporting Engine service.
  3. Click  > View > Config.

    The Services Config view is displayed with the Reporting Engine General tab open.

An example of the General tab for a IPDB Extractor service is displayed.

Features

The Reporting Engine General tab includes six panels:

  • System Configuration
  • Logging Configuration
  • IPDB Database Configuration
  • Warehouse Analytics Output Configuration
  • Warehouse Analytics Model Configuration
  • Warehouse Kerberos Configuration

System Configuration

The System Configuration panel parameters for the Reporting Engine manage service configuration for a Reporting Engine service. When you add a Reporting Engine service, default values are in effect. RSA designed the default values to accommodate most environments and recommends that you do not edit these values because it may adversely affect performance.

The following figure shows the fields that can be configured in the System Configuration panel:

The following table describes the System Configuration panel features.

                                                                                     
NameConfig Value
Allow Administrators Full AccessSelect the checkbox if you want to access all the RE objects (Reports, Rule, Charts, Schedule, and List) created by other users (non-admin). By default, this is not enabled.

Note: If you enable the checkbox and then disable it, the access on all RE objects that was enabled by checking the checkbox will not be accessible. But, if you have defined the access on specific objects via Permissions window (Reports > Manage > RE Object >  > Permissions), enabling/disabling this checkbox will not have impact on these objects.

Common thread pool countThe number of thread pools assigned for executing common tasks on the Reporting Engine. A valid value is an integer (20 default).
Enable Output Actions for Completed Reports

Select the checkbox to process the output actions only for reports with all rule executions  successful. By default, this is enabled. If disabled the output actions are processed for all scenarios (completed, partial, failure). 

Forward Alerts to IMSelect the checkbox to forward all the alerts to Incident Management. By default, this is not enabled.
IPDB thread pool countThe number of thread pools assigned for executing IPDB tasks on the Reporting Engine. A valid value is an integer (10 default).
Max# of Concurrent AlertsThe maximum number of alerts that can be run simultaneously. This has a direct impact on the RSA service against which the alerts are run, as each alert consumes a query thread on the RSA service. A valid value is an integer (10 default). 
Max # of Concurrent ChartsThe maximum number of charts that can be run simultaneously. A valid value is an integer (10 default).
Max # of Concurrent LookupAndAdd QueriesThe maximum number of parallel LookupAndAdd Queries that can be run per NWDB rule. A valid value is an integer (2 default). 

When you increase this value, for better performance, you must ensure the NWDB data source is configured to handle the parallel queries.
Max # Concurrent List Value ReportsThe maximum number of list value reports per schedule that can be generated in parallel. A valid value is an integer (default).
Max # List Value ReportsThe maximum number of list value reports generated, irrespective of the number of values in the list. A valid value is an integer (10000 default).
Max rows stored per Rule (Billions)The maximum number of rows that a rule can fetch when queried. A valid value is an integer (100 default).
NWDB Info Queries Time OutThe info queries time out in seconds for NWDB server. A valid value is an integer (default).
NWDB Maximum aggregate RowsThe maximum number of rows that is returned when an aggregation is used in the NWDB rule. A valid value is an integer (1000 default).
NWDB Query Time outThe time out in seconds for NWDB server to time out the rule execution, if it cannot process the result in configured time. The default value is set to 0 which implies that there is no time out. A valid value is an integer.
Process output actions for successful reports onlySelect this checkbox to process output actions only for reports whose all rule executions are successful. When you de-select this checkbox, output action will be triggered for partial, completed, and failed reports.

Note: This is applicable for all output actions except for dynamic list output actions.

Retain Alert history for # daysThe maximum number of days to retain the alert history and alert status. A valid value is an integer (100 default).
Retain Chart history for # daysThe maximum number of days to retain the chart history and chart status. A valid value is an integer (30 default).
Retain Report history for # daysThe maximum number of days the system retains report history and report status. A valid value is an integer (100 default).
Schedule Thread pool countThe number of thread pools assigned for scheduled tasks (for example, clearing history) on the Reporting Engine.  A valid value is an integer (5 default).

Logging Configuration

The Logging Configuration panel parameters for the Reporting Engine manages logging configuration for a Reporting Engine service. When you add a Reporting Engine service, default values are in effect. RSA designed the default values to accommodate most environments and recommends that you do not edit these values because it may adversely affect performance.

The following figure shows the fields that can be configured in the Logging Configuration panel.

The following table describes the Logging Configuration panel features.

                     
NameConfig Value
Log Level

The logging level that determines the scope of information included in log files.  Possible values are:

  • ERROR
  • WARN
  • INFO (default)
  • DEBUG
  • ALL
Maximum # Backup FilesThe maximum number of backup log files the system retains. A valid value is an integer (9 default).
Max Log SizeThe maximum size (in bytes) of the primary log file. A valid value is an integer (4194304 default).

For more information on Reporting Engine logging, see Reporting Engine Log File Parameters.

IPDB Database Configuration

The IPDB Database Configuration panel provides a way to specify the IPDB password when implementing the IPDB on this Reporting Engine.

The following figure shows the fields that can be configured in the IPDB Database Configuration panel:

The following table describes the IPDB Database Configuration panel features.

                 
NameConfig Value
PasswordThe password for nwipdbadptr user. RSA inserts a temporary password that you must replace with the actual IPDB password when you implement the IPDB on this Reporting Engine.
User Namenwipdbadptr You cannot edit this field.

Warehouse Analytics Output Configuration

The Warehouse Analytics Output Configuration panel provides a way to specify the Warehouse Analytics Output configuration on this Reporting Engine.

The following figure shows the fields that can be configured in the Warehouse Analytics Output Configuration panel:

The following table describes the Warehouse Analytics Output Configuration panel features.

                               
NameConfig Value
NameConfig Value
UsernameThe username for the warehouse analytics user. 
PortThe port for the output Mongo DB used by warehouse analytics.
HostThe host for the output Mongo DB used by warehouse analytics.
PasswordThe password for the warehouse analytics user. 

Warehouse Analytics Model Configuration

The Warehouse Analytics Model Configuration panel provides a way to specify the Warehouse Analytics Model configuration on this Reporting Engine.

The following figure shows the fields that can be configured in the Warehouse Analytics Model Configuration panel:

The following table describes the Warehouse Analytics Model Configuration panel features:

                                               
NameConfig Value
Mapreduce Java OptionsThe JVM Parameters for Hadoop MapReduce task tracker child JVM. By default, the value is -Xmx1024m.
Mapreduce Map Java OptionsThe parameter which controls the JVM parameters for Map jobs inside the Hadoop cluster. By default, the value is -Xmx1024m.
MapReduce Reduce Java OptionsThe parameter which controls the JVM parameters for Reduce jobs inside the Hadoop cluster. By default, the value is -Xmx1024m.
Mapreduce Task Timeout (Minutes)The number of minutes before a task is terminated when a MapReduce framework titles it as non-responsive or idle. A valid value is an integer (20 default).        
Max HDFS History DaysThe maximum number of days to maintain the temporary and output files of the job in HDFS. A valid value is an integer (2 default).        
Max History DaysThe maximum number of days to maintain the job output in Mongo DB. A valid value is an integer (6 default).        
Max Simultaneous Warehouse JobsThe parameter which controls the maximum number of parallel jobs executed through the Warehouse Analytics framework. A valid value is an integer (1 default).        
Save If Last Seen (Hours)The parameter to save the keys from the job output is they were not seen in the last 'n' hours. A valid value is an integer (800000 default).        
Threshold ScoreThe parameter to save the keys from the job output to watchlists for use by ESA only if the score is greater than 'n'. A valid value is an integer (55 default).        

Warehouse Kerberos Configuration

The Warehouse Kerberos Configuration panel provides a way to specify the Kerberos Keytab file on this Reporting Engine. 

The following figure shows the field that can be configured in the Warehouse Kerberos Configuration panel:

The following table describes the Kerberos Configuration panel features:

               
NameConfig Value
Kerberos Keytab FileThe Kerberos keytab file location. For example, /home/rsasoc/rsa/soc/reporting-engine/conf/hive.keytab.
Previous Topic:References
You are here
Table of Contents > References > Reporting Engine General Tab

Attachments

    Outcomes