How to enable DEBUG logging on the TIBCO Spotfire Server

Product:TIBCO Spotfire Server
Versions:Spotfire Server versions 7.0 and earlier

Summary:
How to enable DEBUG logging on the TIBCO Spotfire Server

Details:
This article lists the steps to enable DEBUG logging on the TIBCO Spotfire Server.

Resolution:
------------------------------------------------------------------------------------------------------------------
Note: You need to have Spotfire Administrator privileges to perform these steps.
------------------------------------------------------------------------------------------------------------------

There are two different sets of steps to enable DEBUG logging, based on whether the Spotfire Server is accessible or not.
 

Scenario 1: If the Spotfire Server has started and is accessible, then follow the steps given below to enable DEBUG Logging:

   1). Start a Web Browser and go to the server start page. (e.g., http://<server host name>/Spotfire)
   2). Click the button "Open Logs and Diagnostics".
   3). Login using a Spotfire account with Spotfire Administrator privileges.
   4). In the "Server Log Files" tab, set Current Log Configuration to "log4j-debug.properties".
   5). Click on "Set Configuration" to apply the change. You will find all the log files under "<Spotfire Server install directory>\tss\<version>\tomcat\logs".
 

Scenario 2: If the Spotfire Server has not started or the Spotfire Administrator is unable to login to the Spotfire page, then follow the steps below to enable DEBUG logging:

    Note: In this scenario, Spotfire service has to be restarted for changes to take effect.

   1). Edit the "web.xml" file in notepad. The file is located at: "<Spotfire Server installation folder>\tss\<version>\tomcat\webapps\spotfire\WEB-INF".
   2). Search for "log4j.properties" and replace it with "log4j-debug.properties".
   3). Save and close the file.
   4). Launch the Windows Services located in "Control Panel -> Administrative Tools" and restart the "TIBCO Spotfire Server <version>" service. You will find all the log files under "<Spotfire Server install directory>\tss\<version>\tomcat\logs".