Log Extractor Config Options

This section contains options used to configure the Workbench Log Extractor application object. Unless otherwise stated, all configuration options are set using GAX in the Application Options tab of the Workbench Log Extractor application object. You may need to create a section before you can add some options listed below.

app_config Section

The options in this section correspond to the host object to which the Log File Management Tool (LFMT) Collector will connect.

This section must be called app_config.

cls_location

Default Value: No default value
Valid Values: The Central Log Storage directory for the Log File Management Tool.
Changes Take Effect: After restart of Workbench Log Extractor.
Specifies the Central Log Storage directory where log files will be accessed.

log Section

The options in this section correspond to the host object to which the Log File Management Tool (LFMT) Collector will connect.

This section must be called log.

all

Default value: No default value
Valid Values: [filename]
Changes Take Effect: After restart of Workbench Log Extractor.
Specifies the file location to which the application sends all log events.

expire

Default value: 20
Valid Values: [number] Specify a number from 1–1000.
Changes Take Effect: After restart of Workbench Log Extractor.
Determines how many log file snapshots exist before the oldest snapshot is deleted.

segment

Default value: 10000
Valid Values: [number] - Specify a value in kilobytes.
Changes Take Effect: After restart of Workbench Log Extractor.
Determines the rollover size of the log files.

verbose

Default value: info

Valid Values:

• all - All log events are printed.
• trace - All log events are printed.
• debug - DEBUG, INFO, WARN, FATAL, and ERROR log events are printed.
• info - INFO, WARN, FATAL, and ERROR log events are printed.
• warn - WARN, FATAL, and ERROR log events are printed.
• error - FATAL and ERROR log events are printed.
• fatal - Only FATAL log events are printed.
• off - No log events are printed.

Changes Take Effect: After restart of Workbench Log Extractor.

Specifies the default logging level for the Workbench Log Extractor application.

security Section

protocol

Default Value: None
Valid Values: TLSv1.2
Changes Take Effect: After restart of Workbench Log Extractor
Identifies the protocol to be used for SSL communication between the Workbench components.

enabled_ciphers

Default value: None
Valid value = TLS_RSA_WITH_AES_128_CBC_SHA
Changes Take Effect: After restart of Workbench Log Extractor.
This value is auto-populated when the WBLogExtractor application template is imported. The value should not be changed.

mutual_tls

Default value: None
Valid values = true, false
Changes Take Effect: After restart of Workbench Log Extractor.
Indicates whether mutual TLS is enabled for file transfer.

security.keystore Section

path

Default value: None
Valid values = System path to the keystore that will be used by Workbench Log Extractor
Changes Take Effect: After restart of Workbench Log Extractor.
Identifies the path to the local keystore to be used by Workbench Log Extractor to load the necessary keys.

password

Default value: n/a
Valid values = n/a (whatever password you used when creating the keystore)
Changes Take Effect: After restart of Workbench Log Extractor.
The password for accessing the keystore

security.truststore Section

path

Default value: None
Valid values = System path to the truststore that will be used by Workbench Log Extractor
Changes Take Effect: After restart of Workbench Log Extractor.
Identifies the path to the truststore to be used by Workbench Log Extractor to load the necessary certificates.

password

Default value: n/a
Valid values = n/a (whatever password you used when creating the truststore)
Changes Take Effect: After restart of Workbench Log Extractor.
The password for accessing the truststore.

Ports Tab

Add the following listening ports on the Ports tab.

default

Default Value: 9999
Valid Values: Valid port number
Changes Take Effect: On Workbench startup
Workbench Log Extractor uses this port to communicate with other applications, including Workbench.

messaging

Default Value: 2558
Valid Values: Valid port number
Changes Take Effect: On Workbench startup
Workbench Log Extractor starts its TCP messaging system on this port. All other Workbench components located on remote machines (for example, Log Extractor) can connect to Workbench on this port to send and receive messages.