Jump to: navigation, search

LFMT Collector Configuration Options

This section contains options used to configure the LFMT Collector.

Unless otherwise stated, all configuration options are set with GAX in the Application Options tab of the LFMT Collector object.

Examples:

LFMT Collector Options.png

app_config Section

This section contains options for general configuration of the application; this section must be called app_config.

app_type

Default Value: collector
Valid Values: collector
Changes Take Effect: After restart of LFMT Collector.
Description: Specifies the type of Generic Genesys Server this application represents.

cls_location

Default Value: No default value - please enter a value here
Valid Values: Valid path through the system (i.e. C:\CLS or /home/genesys/gcti/LFMT_CLS)
Changes Take Effect: After restart of LFMT Collector.
Description: Specifies the path (local to the Collector Host and not a mapped network drive) through the system to the folder or directory where the CLS is located, the Workbench Agent 8.5 will transfer files to this location. For example, C:/GCTI/CLS.

Important
  • Please ensure this option is set with a valid path, and the user has write permissions to the path, before starting the LFMT Collector(s) application

collection_period

Default Value: 3
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.
Description: Specifies the maximum number of historical days that LFMT Collector will attempt to collect log files; this value should less than or equal to the value of the LFMT Indexer application retention_period option.

collection_timeout_mins

Default Value: 2
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.
Description: This option controls the length of time in minutes for which a transfer should be cancelled if the global collection request has not fully completed. For example, if 5 applications are selected in a collection request (scheduled or manual), the logs from all 5 of these applications must be fully transferred to the LFMT host before this time-out period elapses.

file_transfer_timeout

Default Value: 5
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.
Description: This option controls when the connection between the collector and the workbench agent is terminated because of timeout conditions. If terminated prematurely, the transfer of files from agent(s) will be terminated and not all files may be transferred.

max_disk_utilization

Default Value: 85
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.
Description: Specifies the maximum percentage of HDD space that will be utilized for storing log files in the CLS. The default value 85 indicates that, up to 85% of the HDD space will be used. After reaching this threshold, further transfers will not be executed.

package_location

Default Value: No default value - please enter a value here (i.e. /home/genesys/gcti/LFMT_PKG)
Valid Values: Valid path through the system (network)
Changes Take Effect: After restart of LFMT Collector.
Description: Specifies the path through the system to the folder or directory where the LFMT Collector packages will be created.

Important
  • Please ensure this option is set with a valid path, and the user has write permissions to the path, before starting the LFMT Collector(s) application

package_retention

Default Value: 2
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.
Description: Specifies the number days that LFMT Collector will keeps log file packages created from the LFMT Client before deletion.

server_max_connections

Default Value: 1024
Valid Values: Any positive integer greater than 0.
Changes Take Effect: After restart of LFMT Collector.
Description: Identifies the total number of connections allowed from all LFMT agents to transfer files.

tmp_folder_location

Default Value: OS Temp folder (if no option configured) - (i.e. /home/genesys/gcti/LFMT_TMP)
Valid Values: Valid path through the system (network)
Changes Take Effect: After restart of LFMT Collector.
Description: Specifies the path through the system to the folder or directory where the temporary files for LFMT are to be located. For example, /home/genesys/gcti/LFMT_TMP.

Important
  • If set, please ensure this is different/separate to the "cls_location" option else LFMT Collector(s) will incorrectly process .tmp files
    • also ensure this option is set with a valid path, and the user has write permissions to the path

log Section

This section contains all options relating to creating, viewing, and otherwise using the Centralized Log facility in Genesys software; this section must be called log.

all

Default value: No default value
Valid Values: [path/filename] (i.e. /home/genesys/gcti/_logs/LFMT_Collector/LFMT_Collector)
Changes Take Effect: After restart of LFMT Indexer.
Description: Specifies the file location to which the application sends all log events.

expire

Default value: 10
Valid Values: [number] Specify a number from 1–1000.
Changes Take Effect: After restart of LFMT Indexer.
Description: Determines how many log files are kept before they are deleted.

segment

Default value: 5000
Valid Values: [number] - Specify a value in kilobytes.
Changes Take Effect: After restart of LFMT Indexer.
Description: Determines the rollover size of the log files.

verbose

Default value: all
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 LFMT Indexer.
    Description: Specifies the log level.

    security Section

    This section contains all options relating to securing communication between the LFMT Collector and the Workbench Agent. The section is optional and is required only if the communication between the Workbench and the LFMT Collector has to be secured; this section must be called security.

    mutual_tls

    Default value: None
    Valid Values: true,false
    Changes Take Effect: After restart of LFMT Collector.
    Description: Indicates whether mutual TLS is enabled for messaging and file transfer.

    provider

    Default value: None
    Valid Values: JKS,
    Changes Take Effect: After restart of LFMT Collector.
    Description: The key provider.

    protocol

    Default value: None
    Valid Values: TLSv1.2
    Changes Take Effect: After restart of LFMT Collector.
    Description: Identifies the protocol to be used for the SSL communication between the LFMT Collector and the LFMT Agent.

    enabled_ciphers

    Default value: None
    Valid Values: Any valid Java cipher suite. i.e "TLS_RSA_WITH_AES_256_CBC_SHA256" (see Java documentation for valid list)
    Changes Take Effect: After restart of LFMT Collector.
    Description: Identifies the cipher suite to be used for TLS communication between the LFMT Collector/LFMT Client and LFMT Collector/Workbench Agent.

    Note: Ensure any configured cipher suite is enabled to be used by the Java instance on the host. See Java documentation for enabling/disabling cipher suites. The Client and Agent(s) that the Collector is connecting to will need to be configured with the same cipher suite.

    security.keystore Section

    The security.keystore section of the LFMT Collector application options is used to identify the keystore properties through which LFMT Collector will load the necessary keys for secure communications; this section must be called security.keystore.

    path

    Default value: No default value
    Valid Values: A file path to the keystore located on the host. Note: The security certificates must be generated using the SHA-2 secure hash algorithm.
    Changes Take Effect: After restart of LFMT Collector.
    Description: Identifies the path to the local keystore to be used by LFMT Agent to load the necessary keys.

    password

    Default value: No default value
    Valid Values: A valid password associated with the keystore defined in the path option of the security.keystore section
    Changes Take Effect: After restart of LFMT Collector.
    Description: The password to be used by LFMT Agent to access the keystore.

    security.truststore Section

    The security.truststore section of the LFMT Collector application options is used to identify the truststore properties through which LFMT Collector will load the necessary certificates for secure communications; this section must be called security.truststore.

    path

    Default value: No default value
    Valid Values: A file path to the truststore located on the host. Note: The security certificates must be generated using the SHA-2 secure hash algorithm.
    Changes Take Effect: After restart of LFMT Collector.
    Description: Identifies the path to the truststore to be used by LFMT Collector to load the necessary certificates.

    password

    Default value: No default value
    Valid Values: A valid password associated with the truststore identified in the path option of the security.truststore section
    Changes Take Effect: After restart of LFMT Collector.
    Description: The password to be used by LFMT Collector to access the truststore.

    This page was last edited on March 8, 2022, at 11:56.
    Comments or questions about this documentation? Contact us for support!