Creating a log4j engine logging file

The default TIBCO Spotfire® Statistics Services engine log file can be configured to provide a logging level different from the default level (which is DEBUG). If the default level of logging displayed in engine.log is not the level you need, you can create a file to use for configuring engine logging.

Procedure

  1. Create a file named engine-log4j.properties.
  2. Provide in the file a basic configuration, such as the following: 
    #Loggers.
log4j.logger.com.insightful.splusserver.engine=DEBUG

    The engine's log configuration file does not include appender information (unlike the log4j.properties file). It need only include a directive for package-level logging. To disable most logging, set the configuration value as follows: 

    #Loggers.
log4j.logger.com.insightful.splusserver.engine=INFO
    Note: The INFO log option results in only exceptional cases being logged. In most cases, such a setting produces a zero-length engine.log file for each job.
  3. Save the file in the folder SPSERVER_HOME/conf (for a standalone installation) or SPSERVER_SHARE/conf (for a cluster installation).

Result

You can use this file in the future to set the logging level to one of the four available levels:
Log Threshold Description
DEBUG Messages for troubleshooting/debugging purposes.
INFO Messages indicating the server is healthy and active.
WARN Messages indicating a potential issue.
ERROR Messages indicating an issue has occurred.
FATAL Messages indicating a catastrophic event has occurred.
Note: If you change the logging level in the engine-log4j.properties file, you must restart the service to force the change to take effect.