How to capture a trace log of an LDAP synchronization without changing the logging level of the Spotfire server and without restarting the Spotfire server.

How to capture a trace log of an LDAP synchronization without changing the logging level of the Spotfire server and without restarting the Spotfire server.

When troubleshooting LDAP synchronization, it is sometimes necessary to look at a trace log file to see what is going on. This article describes how to manually start an LDAP synchronization and how to capture the sync in a separate trace log file. Version 7.5 through 7.8 (see below for version 7.9 and higher)

Set the logging level to trace for the command line tool "Spotfire Server Configuration tool". All actions executed using the command line tool are captured in the log file "tools.log" To set the logging level of the tools.log log file:

1. Open the file "C:\Tibco\tss\x.x.x\tomcat\webapps\spotfire\WEB-INF\log4j-tools.properties".
2. Change "log4j.logger.com.spotfire=WARN, toollog" to "log4j.logger.com.spotfire=TRACE, toollog" and save the file.

Now you need to start an LDAP sync manually so that we can catch a log file and see what is happening during the LDAP sync.

1. Go into the "logs" folder and move/delete the file named "tools.log". The "logs" folder can be found at "<server install dir>\tomcat\"(default C:\tibco\tss\x.x.x\tomcat\). 
2. Open a command prompt and cd into the "bin" folder of the Spotfire server. "<server install dir>\tomcat\bin"(default C:\tibco\tss\x.x.x\tomcat\bin).
3. In the command prompt run this command without the quotes "config.bat list-users -f".
4. Specify the tool password when prompted.
5. Wait until the command finishes successfully or fails in the command prompt window.

Once the command has finished you'll have a trace log of the whole LDAP sync captured in the "tools.log" log file.

Version 7.9 and higher

To set the logging level of the tools.log log file:

1. Open the file "C:\tibco\tss\x.x.x\tomcat\spotfire-config\log4j2-tools.xml".
2. Change "<Logger name="com.spotfire" level="WARN" additivity="false">" at the bottom of the file, to "<Logger name="com.spotfire" level="TRACE" additivity="false">"
3. Save the file.
4. Now you need to start an LDAP sync manually so that we can catch a log file and see what is happening during the LDAP sync.
5. Go into the "logs" folder and move/delete the file named "tools.log". The "logs" folder can be found at "<server install dir>\tomcat\"(default C:\tibco\tss\x.x.x\tomcat).
6. Open a command prompt and cd into the "bin" folder of the Spotfire server. "<server install dir>\tomcat\bin"(default C:\tibco\tss\x.x.x\tomcat\bin).
7. In the command prompt run this command without the quotes "config.bat list-users -f".
8. Specify the tool password when prompted.

Wait until the command finishes successfully or fails in the command prompt window.
Once the command has finished you'll have a trace log of the whole LDAP sync captured in the "tools.log" log file.