Enabling logging

For troubleshooting purposes, you can enable logging in the installed Spotfire client. When you have enabled logging, actions and events in the installed Spotfire client are tracked in log files.

Before you begin

These steps are only applicable to the installed client.

Procedure

On the menu bar, select Help > Support diagnostics and logging.
In the Support Diagnostics and Logging dialog, click the Logging tab.
Click to expand the Log level drop-down list, and then select the log level that you want to use.

Tip: If you want to enable query logging for connectors, select DEBUG or TRACE.
To view the Spotfire log files, click Open Folder.
Click OK.

Results

The changes are saved and the dialog is closed.

The Spotfire log files

The Spotfire client uses separate log files for logging, each designated for specific types of logging information.

Spotfire.Dxp.SupportDiagnostics.log

This is the general purpose log file, to which information about most events and actions in Spotfire is written.

You can control the level of detail of the information that should be captured in this log file, by configuring the log level.

Spotfire.Dxp.QueryLog.log

When you work with data connectors to analyze data from external data sources, information about all queries for data, that are generated and sent to external data sources from connectors, are stored in this log file. Each row in the file represents a query that was generated from a data connector running in Spotfire and sent to an external data source.

Logging of queries is enabled if you set the log level to TRACE or DEBUG.

PerformanceCounterLog.txt

If the log level is INFO or higher, a file called PerformanceCounterLog.txt containing a set of useful performance counters will also be available in the log file folder. At DEBUG level, the set of counters will be bigger.

Tip: If you want to read and analyze your log files in a convenient and powerful way, you can open the logs in Spotfire.