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 TERR service and Spotfire Service for Python, JMX is the only
way to capture logs. For more information, see the following.
- "Monitoring the TERR service using JMX" in TIBCO® Enterprise Runtime for R - Server Edition.
- "Monitoring Spotfire Service for Python using JMX" in TIBCO® Spotfire Service for Python.
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
|
|
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.
|
MonitoringEventsLog.<ID>.txt | INFO
|
|
OpenFilesStatisticsLog.<ID>.txt | OFF
|
The open analyses sampled regularly. |
PerformanceCounterLog.<ID>.txt | INFO
|
Standard and custom performance counters logged regularly. |
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.
|
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.
- General logging properties
The properties listed here are logged for all service log files. - Auditlog
The Auditlog properties listed in this topic are written to the log file named AuditLog.<ID>.txt. By default, the logging level is set to INFO. - DateTimesLog
DateTimesLog supports writing to the log file using only the%message
format. The default level for DateTimesLog properties is OFF. - DocumentCacheStatisticsLog
The DocumentCacheStatisticsLog properties listed in this topic are written to the log file named DocumentCacheStatisticsLog.<ID>.txt. By default, the logging level is set to OFF. - MemoryStatisticsLog
The MemoryStatisticsLog properties listed in this topic are written to the log file named MemoryStatisticsLog.<ID>.txt. By default, the logging level is set to OFF. - MonitoringEventsLog
The MonitoringEventsLog properties listed in this topic are written to the log file named MonitoringEventsLog.<ID>.txt. By default, the logging level is set to INFO. - OpenFilesStatisticsLog
The OpenFilesStatisticsLog properties listed in this topic are written to the log file named AuditLOpenFilesStatisticsLogog.<ID>.txt. By default, the logging level is set to OFF. - PerformanceCounterLog
The PerformanceCounterLog properties listed in this topic are written to the log file named PerformanceCounterLog.<ID>.txt. By default, the logging level is set to INFO. - QueryLog
The QueryLog properties listed in this topic are written to the log file named QueryLog.<ID>.txt. Each row in the log represents a query, which was generated from a data connector running on the Spotfire instance and sent to an external data source. By default, the logging level is set to OFF. - Spotfire.Dxp.Worker.Host and Spotfire.Dxp.Worker.Host.Debug
The properties for Spotfire.Dxp.Worker.Host and Spotfire.Dxp.Worker.Host.Debug are written to the log files Spotfire.Dxp.Worker.Host.ID.log and Spotfire.Dxp.Worker.Host.Debug.ID.log. These are general purpose log files for all logging levels, and for logging levels down toINFO
, respectively. For the properties listed in this topic, you cannot use the standard Apache log4net pattern strings. - TimingLog
The TimingLog properties listed in this topic are written to the log file named TimingLog.<ID>.txt. By default, the logging level is set to INFO. - UserSessionStatisticsLog
The UserSessionStatisticsLog properties listed in this topic are written to the log file named UserSessionStatisticsLog.<ID>.txt. By default, the logging level is set to OFF.
Parent topic: Accessing services logs