Archiver Services Config View - General Tab

Document created by RSA Information Design and Development on Sep 26, 2017Last modified by RSA Information Design and Development on Oct 4, 2017
Version 3Show Document
  • View in full screen mode
  

The General tab for an Archiver in the Services Config view helps manage basic service configuration, configure the aggregate service, and configure the aggregation process between an Archiver and the aggregate service.

To access the General tab, go to ADMIN > Services, select an Archiver service, then select View > Config.

Workflow

This workflow illustrates the end-to-end installation and configuration process for an Archiver.

Configuring the aggregate service (whose data is consumed and aggregated) includes:

  • Adding, editing, and deleting Archivers as aggregate services
  • Toggling an aggregate service online and offline
  • Monitoring statistics for aggregate services
  • Starting and stopping aggregation

Configuring the aggregation process includes setting:

  • Aggregation autostart
  • Timing and performance parameters, such as the number of sessions per round of aggregation and time between rounds
  • The timing of attempts to restart, reconnect, or take offline a non-responsive aggregate service

What do you want to do?

                       
RoleI want to...Show me how...
Administrator

Start and Stop aggregation

Add, edit, delete, and toggle an aggregate service

Aggregate Services Section

Administrator

Manage System Configuration

System Configuration Section

Related Topics

Configure Archiver Monitoring

Quick Look

This is an example of the General tab.

General Tab is displayed.

These are the three major sections in the General tab for Archivers:

  • Aggregate Services
  • System Configuration
  • Aggregation Configuration

Aggregate Services Section

The Aggregate Services section provides a way to start and stop aggregation, as well as add, edit, delete, and toggle an aggregate service. This is an example of the Aggregate Services section for a Concentrator. 

The Aggregate Services section toolbar offers these options.

                                   
OptionDescription

Opens a dialog in which you can add a Concentrator, Decoder, or Log Decoder as an aggregate service. 

Removes the selected aggregate service.

Opens a dialog to edit Meta Fields and Filter values.

When aggregation has been stopped or has not started, starts aggregating data from the online service in the list using the rules defined for the service.

When aggregation is in progress, stops aggregation on the Broker or Concentrator. This stops all services and flushes the index, which may take several minutes to complete. It is necessary to stop aggregate services in order to perform various administrative procedures.

Toggles the state of a service between offline and online. Only data from online service is consumed during aggregation.

The Aggregate Services section list has these columns.

                                                       
ColumnDescription
AddressLists the address of the service.
PortLists the port on which the service listens. The default ports are:
  • 50001 for Log Collectors
  • 50002 for Log Decoders
  • 50003 for Brokers
  • 50004 for Decoders
  • 50005 for Concentrators
  • 50007 for other services
RateLists the number of metadata objects being written to the database per second. Values are rolling average samples over a short time period (10 seconds). After capture stops, the rate is reset to 0.
MaxLists the maximum number of metadata objects written to the database per second since capture started. Values are rolling average samples over a short time period (10 seconds). After capture stops, Max continues to show the maximum value during capture.
BehindLists the number of sessions on the service that need to be aggregated. 
CollectionFor Brokers only, indicates the collection that was selected when the Analyst Workbench service was added to the Aggregate Services section.
Meta FieldsFor Concentrators only, lists the types of metadata being consumed by the aggregate service.
FilterFor Concentrators only, lists any filter being applied to the metadata being consumed by the aggregate service. 
Meta IncludeFor Concentrators only, lists the number of types of meta included in the aggregate service.
GroupedWhether or not the aggregate service is part of a group.
StatusLists the current status of the service:
  • online = available to provide data for consumption by the Broker or Concentrator
  • offline = not available to provide data for consumption by the Broker or Concentrator
  • consuming = providing data for consumption by the Broker or Concentrator

System Configuration Section

The System Configuration section manages service configuration for a service. When a service is first added, default values are in effect. You can edit these values to tune performance.

The System Configuration section has these parameters.

                                   
ParameterDescription
CompressionThe minimum number of bytes that must be transmitted per response before compression. A setting of 0 disables compression. The default value is 0.
A change in value is effective immediately for all subsequent connections.
PortThe port on which the service listens. The default ports are:
  • 50001 for Log Collectors
  • 50002 for Log Decoders
  • 50003 for Brokers
  • 50004 for Decoders
  • 50005 for Concentrators
  • 50007 for other services
SSL FIPS ModeWhen enabled (on), the security of data transmission is managed by encrypting information and providing authentication with SSL certificates. The default value is off.
SSL PortIndicates the SSL port.
Stat Update IntervalThe number of milliseconds between statistic updates on the system. Lower numbers cause more frequent updates and can slow down other processes. The default value is 1000.
A change in value is effective immediately.
ThreadsThe number of threads in the thread pool to handle incoming requests. A setting of 0 lets the system decide. The default value is 15
A change takes effect on service restart.

Aggregation Configuration Section

The Aggregation Configuration section provides configuration settings that affect various aspects of the aggregation process. When you click Apply, the changes are saved; however, not all settings take effect immediately. The tables for Aggregation Settings and Service Heartbeat provide details.

Caution: Do not edit any of these settings without guidance from Customer Support.

You are here
Table of Contents > Archiver References > Archiver Services Config View - General Tab

Attachments

    Outcomes