How to permanently enable Monitoring logging on your Web Player service

Products	Versions
Spotfire Server	7.5 and higher

Description

You can enable monitoring for your Web Player service via the TIBCO Spotfire Server web user interface in Monitoring & Diagnostics ("Enable Monitoring Logging"). But this will be reset when the service is restarted. It might be necessary to enable full monitoring logging for longer periods, in which case you can use this method to enable DEBUG logging on all appenders permanently.

Issue/Introduction

How to permanently enable Monitoring logging on your Web Player service.

Resolution

1. Open a command-line interface on the TIBCO Spotfire Server and export the service configuration by using the export-service-config command. Specify the Web Player capability and the deployment area, for example:

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

By default, the output files are located in the <install dir>\tomcat\bin\config\root directory if you do not specify a source directory

2. Open the log4net.config log4net.config in a text editor or XML editor.

3. Find all occurrences of:

<level value="INFO"/>

or

<level value="OFF"/>

Replace it with:

<level value="DEBUG"/>

Note: The primary appender is already in DEBUG level by default.

4. Save the file.

5. In the command-line interface, import the configuration file back into Spotfire Server, and name the configuration by using the import-service-config command.

import-service-config --config-name=WebPlayerConfiguration

6. Assign the created configuration to your service.

Option 1: In the command-line interface, assign the created Spotfire Web Player configuration to the Spotfire Server to make it possible to use for the service:

set-service-config --service-id=value --config-name=WebPlayerConfiguration

Option 2: In the Spotfire Server web interface:

Log in to Spotfire Server > Nodes & Services > Nodes > Select your service on the left > Click Edit
In the 'Edit service' dialog, select your imported configuration in the 'Configuration' dropdown
Click 'Update' (Note: This will trigger a restart of the instances)