Host GS: Decoder and Log Decoder Common Configuration

Document created by RSA Information Design and Development on Mar 21, 2017
Version 1Show Document
  • View in full screen mode
  

This topic lists and describes the configuration parameters that are identical on both packet decoder and log decoder services.

Decoder Configuration Settings

This table lists and describes the Decoder and Log Decoder shared configuration settings.

                                                                                                                                                      
Decoder Configuration Path/decoder/config
aggregate.buffer.sizeDisplays the size of the buffer (default unit is KB) used per round of aggregation. Larger buffers may improve aggregation performance but could impact capture performance. Change takes effect after capture restart.
aggregate.precacheDetermines if the decoder will precache the next round of aggregation for upstream services. Can improve aggregation performance but could impact capture performance. Change takes effect immediately.
assembler.pool.ratioDisplays the percentage of pool pages that assembler manages and uses for the assembly process. Change takes effect on service restart.
assembler.session.flushFlushes sessions when they are complete (1) or flushes sessions when they are parsed (2). Change takes effect on service restart.
assembler.session.poolLists the number of entries in the session pool. Change takes effect on service restart.
assembler.size.maxLists the maximum size that a session will obtain. A setting of 0 removes the session size limit. Change takes effect immediately.
assembler.size.minLists the minimum size that a session must be before persisting. Change takes effect immediately.
assembler.timeout.packetLists the number of seconds before packets are timed out. Change takes effect immediately.
assembler.timeout.sessionLists the number of seconds before sessions are timed out. Change takes effect immediately.
assembler.voting.weightsDisplays the weights used to determine which session stream is marked client and server. Change takes effect immediately.
capture.autostartDetermines if capture begins automatically when the service starts. Change takes effect on service restart.
capture.buffer.sizeDisplays capture memory buffer allocation size (default unit is MB). Change takes effect on service restart.
capture.device.paramsDisplays capture service specific parameters. Change takes effect on service restart.
The parameters understood by this field are specific to the currently selected capture device. If any of the parameters are not recognized by the current capture device, they are ignored.

On Log Decoders, there is only the Log Events capture device. It accepts some optional parameters.
  • use-envision-time: If this is set to 1, the time meta for each event will be imported from the Log Collector stream. If this is 0 or not set, the imported event time will be stored in the event.time meta.
  • port: This parameter can be set to a numeric value to override the default syslog port listener, 514.
capture.selectedDisplays current capture service and interface. Change takes effect immediately.
export.expire.minutesLists the number of minutes before export cache files are expired and flushed. Change takes effect immediately.
export.packet.enabledAllows export of packet data, if enabled. Change takes effect on service restart.
export.packet.local.pathDisplays the local location to cache packet exported data. Optional assigned max size (=#unit), units are: t for TB; g for GB, m for MB. Change takes effect on service restart.
export.packet.maxDisplays the maximum packets per exported file. For export file types that cache this determines cached memory sizes. Zero is no limit. Change takes effect immediately.
export.packet.remote.pathLists the remote protocol (nfs://) and location to export data. Change takes effect on service restart.
export.packet.size.maxDisplays the packet maximum bytes per exported file. For export file types that cache this determines cached memory sizes. Zero is no limit. Change takes effect immediately.
export.rollupDetermines the rollup interval for export files. Change takes effect on service restart.
export.session.enabledAllows export of session data, if enabled. Change takes effect on service restart.
export.session.formatDetermines the file format used during session export. Change takes effect on service restart.
export.session.local.pathDisplays the local location to cache session exported data. Optional assigned max size (=#unit), units are: t for TB; g for GB, m for MB. Change takes effect on service restart.
export.session.maxDisplays the maximum sessions per exported file. For export file types that cache this determines cached memory sizes. Zero is no limit. Change takes effect immediately.
export.session.meta.fieldsDetermines which meta fields are exported. Comma list of fields. Star means all fields. Star plus field list means all fields BUT listed fields. Just field list says just include those fields. Change takes effect immediately.
export.session.remote.pathDisplays the remote protocol (nfs://) and location to export data. Change takes effect on service restart.
export.session.size.maxLists the session maximum bytes per exported file. For export file types that cache this determines cached memory sizes. Zero is no limit. Change takes effect immediately.
export.usage.maxLists the session maximum bytes per exported file. For export file types that cache this determines cached memory sizes. Zero is no limit. Change takes effect immediately.
parse.threadsLists the number of parse threads to use for session parsing. Zero means let server decide. Change takes effect on service restart.
pool.packet.page.sizeDisplays the size of a packet page (default is KB). Change takes effect on service restart.
pool.packet.pagesLists the number of packet pages decoder will allocate and use. Change takes effect on service restart.
pool.session.page.sizeDisplays the size of a session page (default is KB). Change takes effect on service restart.
pool.session.pagesLists the number of session pages decoder will allocate and use. Change takes effect on service restart.
You are here
Table of Contents > References > Service Configuration Settings > Decoder and Log Decoder Common Configuration

Attachments

    Outcomes