Skip to main content

Search, replay, and session administration

Search, replay, and session administration

Configuring the .LTS properties file for 10.3

Configure the LTS.properties file to control error logging, memory caching, and hit processing for LTS.

Before you configure the LTS.properties file, you must stop the Search Server. After making configuration changes to the LTS.properties file, restart the Search Server. Use information in the following sections to learn how to control various aspects of LTS processing by setting parameters in the LTS.properties file.

Note: Timeouts are not configurable. The ConnectionTimeout is set to be 5 seconds. The ReadTimeout is set to 15 seconds.

LTS extraction utilizes incremental numbering for PDF and .lts files. When you extract an .lts or PDF file for a previously extracted session, the previous versions of the file is not overwritten. Instead, the extraction process adds an incremental numeric to the newly generated file and saves it to the file system. For example, ABC(1).lts or ABC(1).pdf.

Incremental numbering is supported for up to 10 extractions. Any extractions beyond the tenth result in the .lts or PDF file being overwritten.

Configuring error logging in the LTS.properties file

You can set parameters in the LTS.properties file to control error logging levels and other aspects of LTS logging.

The LTSServer.log that is written to <install_directory>\Logs\LTS\LTSServer.log contains all LTS application specific exceptions and information errors.

Use the information listed below to learn how to configure error logging in the LTS.properties file.

  1. Open the LTS.properties file. The LTS.properties is located in the install directory.
    1. For example,install_directory\apache-tomcat\apache\webapps\LTSServer\WEB-INF\classes\LTS.properties.
  2. Set the LOG_LEVEL property to ERROR (the default) or INFO
    1. If you set LOG_LEVEL to ERROR, error events (even those that do not halt processing) are logged.
    2. If you set LOG_LEVEL to INFO, informational messages related to the status and progress of LTS processing are logged. Error logs are also written.
  3. Set the LOG_MAXFILESIZE property to indicate the size of the log file.
    1. The default value for LOG_MAXFILESIZE is 25MB.
    2. If you change the LOG_MAXFILESIZE, you must include the size suffix. Valid suffixes are,  KB for kilobyte, MB for megabyte and GB for gigabyte.
  4. Set the LOG_MAX_FILEBACKUP_INDEX to specify the number of times the log file is to be backed up when it reaches the allowed maximum size. 
    1. By default, log files are backed up 10 times. 
As an example, using the default value of LOG_MAX_FILEBACKUP_INDEX = 10, for up to 10 times, each time the log file reaches the specified maximum size, it is backed up. On the 11th time, the first log file is erased and thereafter, all the logging information will be rolled back from that first log file.

Configuring caching in the LTS.properties file

Caching properties are part of LTS.properties file. Static resources such as CSS files and image files can be cached and the memory size can be set to determine memory allocation for caching. 

Complete the following steps to configure caching in the LTS.properties file. 

  1. Access the LTS.properties file.
    1. The LTS.properties is located in the install directory. For example, <install_directory>\apache-tomcat\apache\webapps\LTSServer\WEB-INF\classes\LTS.properties
  2. Set the CACHE_MAXSIZEINMEMORY property to indicate the allowed memory allocation for caching. The default memory for cache is 500MB.
    1. If you change the CACHE_MAXSIZEINMEMORY, you must include the size suffix. Valid suffixes are KB for kilobyte,MB for megabyte and GB for gigabyte.
  3. Set the CACHE_ITEMEXPIRY_TIME to indicate the time interval that static resources are cached. The value set for this property is always interpreted in hours.
    1. The default number of hours that static resources are cached is 4.
    2. For example, when CACHE_ITEMEXPIRY_TIME is set to 4, a demon thread runs every 4 HOURS to remove expired items (any item that has existed in the cache for more than the hourly values specified in CACHE_ITEMEXPIRY_TIME).
  4. Optionally, set the CACHE_MAX_ASSETS if you want to cache based on the number of static resources.
    1. If the size of the static resources exceeds that which is specified by the least recently used (LRU) caching policy, the memory is trimmed as per the property CACHE_MAXSIZEINMEMORY.
    2. If the memory that you set is under utilized, then the number of static resources can be increased. The default set is 1000 assets / resources.
In cases of an invalid configuration and exception, the CACHE_MAXSIZEINMEMORY parameter always reverts back to the 500MB default value. For example, if you set an invalid value of CACHE_MAXSIZEINMEMORY = 100TB, the setting for the parameter reverts automatically to its default of CACHE_MAXSIZEINMEMORY = 500MB.

Note: Before installing/upgrading to V10.3, Tealeaf requires Java 1.8 installed on all Tealeaf servers running Replay server & LTS server. It can be downloaded from the involved vendor’s website. Apache Tomcat bundled with Tealaf on premises supports following JAVA vendors: IBM JAVA, ORACLE JAVA and OPENJDK.

Configuring Hit exception processing in the LTS.properties file

You can set parameters in the LTS.properties to add Hits for "Server or Resource Not Found" error exceptions.

Use the information here to learn how to add synthetic hits for Server or Resource Not Found error exception.

  1. Access the LTS.properties file.
  2. Set the ADDHITSFOR_RESOURCESNOTFETCHED property to 1 to specify that "synthetic hits" will be added to the .tla file to restrict access to the web in case of "Server or Resource Not Found" exceptions when trying to the host.

All synthetic hits that are added have a status code 200 and status code text of OK in both the request and response files as the replay server does not recognize URLs with other status. If this behavior is not suited to your needs, then set ADDHITSFOR_RESOURCESNOTFETCHED to 0 to stop adding synthetic hits and thus the replay server tries to fetch resources not found within session during replay.

Troubleshooting

If there is a problem running LTS or DOMDiff server, you can check whether the LTS or DomDiff servers are running properly. To do this, check if following URL is accessible when accessed from Replay Server/LTS server machine:

  1. If EnableTLS is off: http://localhost:38007/LTSServer/
  2. If EnableTLS is on: https://localhost:38006/LTSServer/

To further investigate the problem check the Catalina logs in: %Tealeaf_install_directory%\apache-tomcat\apache\logs

Additionally, to verify that the java installation was done properly, run configtest.bat on the command prompt in the following folder:

  • %Tealeaf_install_directory%\apache-tomcat\apache\bin

If due to some environmental issue, the DOMDiff/LTS server doesn't automatically start, run catalina.bat on the command prompt in the following folder:

  • %TEALEAFDIRECTORY%apache-tomcat\apache\bin\

 

Related articles

community icon

Join the community

Ask questions, share best practices, and connect with fellow marketers.

Ask a question

Academy

Read how-to articles, guides, and more to help you on the path to success.

Learn more