How to change the log level on Spotfire server when Admin UI is not accessible

How to change the log level on Spotfire server when Admin UI is not accessible

book

Article ID: KB0083633

calendar_today

Updated On:

Products Versions
Spotfire Server 7.9, 7.10

Description

If there is a need to change the logging level on a Spotfire Server when the Spotfire Server fails to work, the log4j files can be modified to capture valuable information.

Issue/Introduction

This article discusses how to change the log level in a Spotfire server when the Administration user interface (Admin UI) is not accessible.

Environment

All supported environments

Resolution

The log level is now mentioned in the file called logging-levels.properties, which is located in the following directory:
 
     [SpotfireServer7.9installation]\tomcat\spotfire-config

Each of the logging properties files (logging-debug.properties, logging-trace.properties, etc.) defines the log levels for the classes for which the information must be logged in the Spotfire Server logs.

When the log level is set to the default (Standard), the file will have a single entry:

     ActiveConfig=default

To change the log level to:


Debug -

1). Edit the logging-levels.properties file and set the value for ActiveConfig to logging-debug.properties.

2). Copy all the contents from SpotfireServer7.9installation\tomcat\spotfire-config\logging-debug.properties and add them to the logging-levels.properties file. Make sure the entry for ActiveConfig is not overwritten.

3). Save the logging-levels.properties file. Now all information in the server logs will be logged at the debug level.


Trace -

1). Edit the logging-levels.properties file and set the value for ActiveConfig to logging-trace.properties.

2). Copy all the contents from SpotfireServer7.9installation\tomcat\spotfire-config\logging-trace.properties and add them to the logging-levels.properties file. Make sure the entry for ActiveConfig is not overwritten.

3). Save the logging-levels.properties file.  Now all information in the server logs will be logged at the trace level.


Minimal -

1). Edit the logging-levels.properties file and set the value for ActiveConfig to logging-minimal.properties.

2). Copy all the contents from SpotfireServer7.9installation\tomcat\spotfire-config\logging-minimal.properties and add them to the logging-levels.properties file. Make sure the entry for ActiveConfig is not overwritten.

3). Save the logging-levels.properties file.  Now all information in the server logs will be logged at the minimal level.


Reset back to Standard logging -

1). Edit the logging-levels.properties file and set the value for ActiveConfig to default.

2). Remove all the other entries in the logging-levels.properties file except for ActiveConfig.

3). This will reset the logging level back to Standard (default)..