Action logs and system monitoring
Action logs collect user actions. System monitoring collects information about the performance of the Spotfire Server and the services. Information from action logs and from system monitoring is written to the same files or database; therefore, you can use the data you collect to correlate the usage with the system performance.
Action logging and system monitoring are disabled by default.
- To log such information from Spotfire Server, you must enable writing to files, to a database, or to both files and database.
- To also log information from non-server nodes, such as information from Spotfire Analyst, Automation Services and Spotfire Web Player (from Business Author and Consumer users), then you must configure Spotfire Server to accept incoming log events through web service calls.
- If you write the logs to a Microsoft SQL Server or Oracle database, then you can import the enclosed library import file, which contains information links for logging categories, as well as a sample Spotfire analysis file to your library. The information model and analysis file can be configured easily to read the logs from the database. This is a good starting point to analyze the logs.
Action logging and system monitoring | Comments |
---|---|
Writing to files. | Log files are not pruned. By default, a new log file is created every day; although you can change the action log interval, you must ensure the file system has enough free space. |
Writing to a database. | You can set an option to remove entries that are older than a certain number of hours.
Spotfire provides an information model and an analysis file that you can use to start analyzing usage patterns.
Tip: If you are logging to a database, then consider including your database administrator to monitor the usage regularly and see if indices should be rebuilt or dropped. If no pruning is enabled, then manual pruning or partitioning must eventually be performed on the database.
|
Capturing service logs. | You can specify the service or services for which to capture logging information. If you do not configure any web services, then only actions performed on the server are logged. |
You can enable and configure Spotfire Server for action logging and system monitoring either from the command line or from the configuration tool.
- To enable and configure action logging and system monitoring from the command line, follow the steps under Configure action logging using the command line.
- To enable and configure action logging and system monitoring using the configuration tool, follow the steps under Configure action logging using the configuration tool.
Note: Log points represent events in the system. There can be cases where log results are not directly connected to a user action. For example, when using NTLM, you might see more login actions than expected. If you follow those events on the network during a normal session, you notice that several logins occur during the session. Another case is when a session is automatically closed. A session has a maximum life span. In the logs, you will see an event even if the user has not actively closed the session. You can also see that there might not be a session when these events are logged, because the session has already ended.
- Configure action logging using the command line
By default, user action logging with system monitoring is not enabled or configured. You can enable and configure it from the server command line. - Configure action logging using the configuration tool
By default, user action logging with system monitoring is not enabled or configured. You can enable and configure it from the Spotfire Server configuration tool. - Importing a library for analyzing action logs in Spotfire Analyst
The installation kit includes a library import file containing information links and a sample analysis file so that you can easily analyze your user action logs (only available for Microsoft SQL Server and Oracle databases). - Setting the action log interval
If you configure the Spotfire Server to write an action log to a database or a file, then the log is updated and events are logged when an action is performed. If you write the action log to a file, by default, a new file is created on a daily basis, but you can change this setting by editing the log4j2.xml configuration file. - Database logging
When you configure Spotfire Server to log user actions to a database, you create a dependent and integrated system that you can tune to your logging needs. You can monitor its health with a JMX-compatible application such as JConsole. - Action log reference
Spotfire Server action logs capture usage data, such as when a user logs in, opens a file from the library, adds bookmarks, pages through analyses, and so on. Action logs capture events from Spotfire Server and can also be configured to capture events from Automation Services, Spotfire Analyst, and Spotfire Business Author. - System monitoring reference
System monitoring saves information about the performance of Spotfire Server and the services in the same database or files as the action logs. - Update action logs and system monitoring
If you have been running action logging with a previous release of Spotfire Server, then logging should continue to run, out of the box, after a successful upgrade. However, you might not be able to make full use of any new functionality unless you perform some manual changes. If you upgrade by installing new computers, you must ensure that the new hardware can connect to the database.
Parent topic: Monitoring and diagnostics
Related concepts