Reporting Engine: General Tab

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

The General tab for the Reporting Engine service controls several settings that can tune the performance of a service and specify the user credentials for the service. Navigate to Services > View > Config > Reporting Engine > General. These settings are used for the Reporting Engine service exclusively.

The required permission to access this view is Manage Services.

Workflow to explain the additional Reporting Engine settings

What do you want to do?

                                                
Role I want to ...Refer to...
AdministratorConfigure Data Source to Reporting EngineConfigure the Data Sources
AdministratorConfigure Data Source Permissions for Reporting EngineConfigure Data Source Permissions
AdministratorConfigure Data Privacy for Reporting EngineConfigure Data Privacy for the Reporting Engine
AdministratorDefine Reports, Charts, and AlertsDefine Reports, Charts and Alerts
AdministratorConfigure Reporting Engine SettingsConfigure Reporting Engine Settings
Administrator / SOC Manager

Configure System Settings*

Configure Reporting Engine General Settings
Administrator / SOC Manager

Configure Logging*

Configure Reporting Engine General Settings

*You can complete these tasks here.

Related Topics

Quick Look

Here is example of the General tab where service configurations are displayed.

                         
1Displays all the available configurable tabs.
2Displays the available configuration parameters for the system.
3Displays the name of the parameter.
4Displays the set values for each parameter.
5Applies the changes. 

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. The default values are designed to accommodate most environments and recommends that you do not edit these values because it may adversely affect performance.

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

Reporting engine system configuration page

The following table describes the System Configuration panel features.

                                                                                           
NameConfig Value
Allow Administrators Full Access

Select the checkbox if you want to access all the Reporting Engine 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 Reporting Engine objects that were enabled by selecting 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 count

The 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 Respond

Select the checkbox to forward all the alerts to Respond. By default, this is not enabled.

Max# of Concurrent Alerts

The 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 Charts

The maximum number of charts that can be run simultaneously. A valid value is an integer (10 default).

Max # of Concurrent LookupAndAdd Queries

The 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 Reports

The maximum number of list value reports per schedule that can be generated in parallel. A valid value is an integer (default).

Max # List Value Reports

The 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).

Maximum disk space threshold

The maximum disk space threshold allotted (in GB) to execute reports, alerts and charts. The initial value is configured based on the available system space.

Minimum disk space threshold

The minimum disk space threshold allotted (in percentage) required to execute reports, charts, and alerts. By default, this is value is set to 5.

Note: If the minimum threshold is reached, then the execution of reports, charts and alerts will stop even if the service is running.

NWDB Info Queries Time Out

The info queries time out in seconds for NWDB server. A valid value is an integer (1800 default).

NWDB Maximum aggregate Rows

The 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 out

The time out in seconds for NWDB server to time out the rule execution, if it cannot process the result in configured time. A valid value is an integer (259200000 default).

Process output actions for successful reports only

Select 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 # days

The maximum number of days to retain the alert history and alert status. A valid value is an integer (100 default).

Retain Chart history for # days

The maximum number of days to retain the chart history and chart status. A valid value is an integer (30 default).

Retain Report history for # days

The maximum number of days the system retains report history and report status. A valid value is an integer (100 default).

Schedule Thread pool count

The 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 of the Reporting Engine manages the 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 of the Reporting Engine.

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

Reporting engine logging configuration page.

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 Files

The maximum number of backup log files the system retains. A valid value is an integer (9 default).

Max Log Size

The 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 Accessing Reporting Engine Log Files.

Warehouse Kerberos Configuration

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

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

Reporting Engine warehouse analytics kerberos configuration

The following table describes the Kerberos Configuration panel features:

               
NameConfig Value
Kerberos Keytab File

The Kerberos keytab file location. For example:

/var/netwitness/re-server/rsa/soc/reporting-engine/conf/hive.keytab

The default Kerberos configuration file is located at, /etc/kbr5.conf in the Reporting Engine. You can modify the configuration file to provide details for Kerberos realms and other parameters related to Kerberos.

Added the host name (or FQDN) and IP address of the Horton Works nodes and Warehouse Connector to the DNS server.  If the DNS server is not configured, add the host name (or FQDN) and IP address of the Horton Works nodes and Warehouse Connector to the /etc/hosts file in the host on which the Warehouse Connector service is installed.

You are here
Table of Contents > Reporting Engine Reference > Reporting Engine General Tab

Attachments

    Outcomes