Spotfire: How to increase the log files retention period on the TIBCO Spotfire Web Player

This article describes on how to increase the log file retention on the TIBCO Spotfire Web Player.

This article describes how to increase the log file retention on the TIBCO Spotfire Web Player so that there is a longer time interval recorded in the logs.

Note: Before increasing the log retention per this article, ensure you have sufficient disk space for the larger volume of logs that will be kept. Having insufficient disk space can cause system stability issues.

Resolution:

 1) Open a command line and export the service configuration files from Spotfire Server by using the export-service-config command. Specify the Web Player capability and the deployment area.
Example: 

config export-service-config --capability=WEB_PLAYER --deployment-area=Production 

2) Open the configuration file "Log4net.config" from the location <Server installation>\tomcat\bin\config\root in a plain text editor or XML editor. Search for the following settings and change the parameters <maxSizeRollBackups value="25" /> and <maximumFileSize value="200MB" /> per your needs. Increasing either of these values will increase the overall retention period of the logs: 

• MaxSizeRollBackups - The maximum number of backup files that are kept before the oldest is erased

• MaximumFileSize - The maximum size that the output file is allowed to reach before being rolled over to backup files. 

Here is an example for the "Spotfire.Dxp.Worker.Host.Debug" log appender:

<appender name="FileAppenderDebug" type="Spotfire.Dxp.Internal.Diagnostics.WebLoggerFileAppender">
      <encoding value="utf-8" />
      <PreserveLogFileNameExtension value="true" />
      <file type="log4net.Util.PatternString" value="..\..\logs\Spotfire.Dxp.Worker.Host.Debug%property{serviceIdWithPeriod}.log" />
      <appendToFile value="true" />
      <rollingStyle value="Size" />
      <maxSizeRollBackups value="25" />
      <maximumFileSize value="200MB" />
      <staticLogFileName value="false" />
      <layout type="log4net.Layout.PatternLayout">
        <header value="Level;TimeStamp;UTC Timestamp;ServiceInstanceId;InstanceId;Thread;User;Logger;Message&#13;&#10;String;DateTime;DateTime;String;String;String;String;String;String&#13;&#10;" />
        <conversionPattern value="%-5level;%date{yyyy-MM-dd'T'HH:mm:ss,fffzzz};%utcdate{ISO8601};%property{serviceId};%property{instanceId};%thread;%property{user};%logger;&#34;%message%&#34;%newline" />
      </layout>
      <filter type="log4net.Filter.LoggerMatchFilter">
        <param name="AcceptOnMatch" value="false" />
        <param name="LoggerToMatch" value="WebLogger." />
      </filter>
      <!-- An example how to filter out logging rows from a specific logger.-->
      <!--<filter type="log4net.Filter.LoggerMatchFilter">
        <loggerToMatch value="Spotfire.Dxp.Framework.Utilities.ServerLoggerManager" />
        <acceptOnMatch value="false" />
      </filter>-->
    </appender>

3) Save the file and import the configuration using following command: 

config import-service-config --config-name= Serviceconfiguration 

4) Apply the configuration to Web Player services via the Spotfire Administration web interface  (Nodes & Services > Web Player Services > Edit > Select the new configuration that you just configured) or via command line as below: 

config set-server-service-config --capability=WEB_PLAYER --config-name=Serviceconfiguration 

Reference:

Doc: Manually editing service configuration files

https://docs.tibco.com/pub/spotfire_server/7.11.0/doc/html/TIB_sfire_server_tsas_admin_help/GUID-958A3AB5-7243-4837-9AEA-78AA274A6F7E.html 

External: MaxSizeRollBackups 

https://logging.apache.org/log4net/log4net-1.2.13/release/sdk/log4net.Appender.RollingFileAppender.MaxSizeRollBackups.html 

External: MaximumFileSize 

https://logging.apache.org/log4net/log4net-1.2.12/release/sdk/log4net.Appender.RollingFileAppender.MaximumFileSize.html