How to enable DEBUG or TRACE logging for TERR Service.

How to enable DEBUG or TRACE logging for TERR Service.

book

Article ID: KB0074649

calendar_today

Updated On:

Products Versions
Spotfire Enterprise Runtime for R - Server Edition All Versions

Description

This article provides steps on how to enable DEBUG or TRACE logging for TERR Service installed under Node Manager. Changing the logging level is useful when troubleshooting problems related to the TERR service.

Environment

All Supported OS

Resolution

Follow the below steps to enable DEBUG or TRACE logging:

- On the Spotfire Server machine, launch a command prompt as an Administrator.
- Browse to \tomcat\bin folder(if you are using Spotfire server version 10.0.x to 10.2.x) OR browse to \tomcat\spotfire-bin folder (if you are using Spotfire server version 10.3.x and above) and export the Web Player Configuration using the "export-service-config" command.
- Example command follows.
---------
config export-service-config --deployment-area="Production" --capability=TERR
---------
- If you are using Spotfire server version 10.0.x to 10.2.x, the exported configuration files will be saved under the  \tomcat\bin\config\root  folder.
- if you are using Spotfire server version 10.3.x and above,  the exported configuration files will be saved under the  \tomcat\spotfire-bin\config\root\conf folder.
- Under conf folder, take a backup of the file -> "custom.properties".

- Now, open "custom.properties" file.

A) If you want to enable DEBUG logging, add below property setting in custom.properties file :

From:
--------------
# The log4j2 logging level.

loggingLevel: INFO
--------------

To:
--------------
# The log4j2 logging level.

loggingLevel: INFO
loggingLevel: DEBUG
--------------- 

B)  If you want to enable TRACE logging, add below property setting in custom.properties file :

From:
--------------
# The log4j2 logging level.

loggingLevel: INFO
--------------

To:
--------------
# The log4j2 logging level.

loggingLevel: INFO
loggingLevel: TRACE
--------------- 

- Save the file.
- Import the modified configuration using "import-service-config" command.
- Enter the "config-name" value relevant to the changes made. This is the configuration that needs to be used for TERR service.
- Example command follows.
---------
config import-service-config --config-name="Enable DEBUG/TRACE logging"
---------
- Launch the Spotfire Admin UI and browse to "Nodes & Services".
- Edit the TERR Service to use to the updated configuration.
- Look for the "config-name" value that you entered while importing the service configuration and update the service with configuration.

Issue/Introduction

How to enable DEBUG or TRACE logging for TERR Service.

Additional Information

https://docs.tibco.com/pub/terrsrv/1.2.0/doc/html/GUID-ABE2360C-DA12-4521-A5B1-05C835EC0AEB.html