Spotfire Server and Environment - Quick Start

Service logs

The service logs listed in this topic are available for both Web Player services and Automation Services. You can configure the log files listed here in the file log4net.config.

To track the resource usage for services, you can enable logging and monitoring of the services by configuring log files in the log4net.config file. See Customizing the service logging configuration for information about exporting and editing this file.

Note: The log4net tool is part of the Apache product family. For more information, see https://logging.apache.org/log4net/.
  • In the configuration, specify writing all information to a log file by using the default format %message.
  • For most log files, you can specify the logging level to write, and which properties to write.
For the data function services, JMX is the only way to capture logs. For more information, see the topic "Monitoring the service using JMX" in the following documentation.

General logging properties are written into each of the log files listed below. For more detailed information about the additional properties that can be written to each log file, see its linked reference topic.

Log file Default level Description
AuditLog.<ID>.txt INFO
  • At the INFO (default) level, for example, user login and logout, and analysis open and close are logged.
  • At the DEBUG level, state changes (apply and save) are also logged.
DateTimesLog.<ID>.txt OFF Time points from the services logs are collected in this file to simplify joins between tables. If logging is set to the DEBUG level, this file can get very large, so time points are not written at the microsecond level.
DocumentCacheStatisticsLog.<ID>.txt OFF The cached analyses are sampled regularly.
MemoryStatisticsLog.<ID>.txt OFF Writes resource usage per document. Logs the amount of memory used by tables and views, the number of internal document nodes, and the execution time.
  • At the INFO level, the total values per document are logged/
  • At the DEBUG level, detailed information per table is recorded.
MonitoringEventsLog.<ID>.txt INFO
  • At the INFO level, the start up and shut down of the service are logged.
  • At the DEBUG level, session create and remove, analyses open and close, and cached analyses add and remove are also logged.
OpenFilesStatisticsLog.<ID>.txt OFF The open analyses sampled regularly.
OutgoingRequestLog.<ID>.txt OFF Logs information about all outgoing SOAP requests to the server.
PerformanceCounterLog.<ID>.txt INFO Standard and custom performance counters logged regularly.
RequestLog.<ID>.txt OFF Logs information about all incoming requests to the Web Player and the Automation Services service.
QueryLog.<ID>.txt OFF Logs all queries for data that are generated and sent to external data sources, when working with data connectors.
Spotfire.Dxp.Worker.Host.Debug.<ID>.log and Spotfire.Dxp.Worker.Host.<ID>.log n/a The general purpose log files.
  • Spotfire.Dxp.Worker.Host.Debug.<ID>.log writes all logging levels.
  • Spotfire.Dxp.Worker.Host.<ID>.log writes logging levels down to INFO
TimingLog.<ID>.txt INFO Logs similar information as the AuditLog, except all events also log a start time, an end time, and a duration.
UserSessionStatisticsLog.<ID>.txt OFF The existing sessions are sampled regularly.
For more information about other logs, see the following topics.