User Action Log Panel

The configuration tool includes a panel to set options for logging user action. The table in this topic provides a brief description of the options.

You can select any or all of the following action loggers.

Enable database logger: Select Yes to write an action log to the database. Selecting Yes enables options in the Database logger configuration section. See Setting action logging to write to a database using the configuration tool for more information.
Enable file logger: Select Yes to write an action log to a file. See Setting action logging to write to a file using the configuration tool for more information.
Enable web service: Select Yes to collect logging from the Spotfire Server and specified services (Spotfire Analyst, Web Player and Automation Services). Selecting Yes enables options in the Web service configuration section. See Configuring the action log web service using the configuration tool for more information.
Enable categories: Select All to log all categories. Select Some Categories to display a list of available categories to log and prioritize in the logs. See Action log categories for links to the descriptions of the available categories.

Table 1. Configuration tool options for configuring the user action log
Option	Description
Driver template	The database driver you are using, selected from the list of supported databases.
Hostname	The server name. For example, spotfireserver.example.com
Port	The port number that the Spotfire Server uses to communicate to the database.
Identifier	Service identifier for the database.
Username	The database account user name.
Password	The database account password.
URL	The JDBC URL to the database. Generated from the selections made in the other options in this section.
Driver class	The name of the JDBC driver class. For example, `yourcompanyname.jdbc.oracle.OracleDriver`
Log in local time	The log time stamps should reflect the local time or the time where the server is located.
Block on full queue	Logging should be blocked when the queue is full.
Queue size	The maximum number of log events in the queue.
Wait on full queue time (ms)	The time (in milliseconds) to wait before retrying to place a new log event on the queue after being rejected by a full queue.
Wait on empty queue time (ms)	The time (in milliseconds) to wait before trying to create a batch from the queue after an empty queue has been encountered.
Thread pool size	The number of threads available for the batch insert workers.
Workers	The maximum number of batch insert workers at any given time.
Commit period	The frequency (in seconds) that log events should be committed from the queue to the database when the queue is not full.
Batch size	The number of log events that should be moved from the queue to the database in each batch insert.
Grace period	The grace period for the database logger (in seconds). This is the period that the database logger is given at server shutdown to move all items from the queue to the database.
Pruning period (hrs)	The maximum time (in hours) that logged items are kept in the database. Pruning takes place at server startup, and then at one hour intervals, when all items older than the specified number of hours are deleted. To disable pruning, set to `0`.
Monitoring period(s)	How often monitoring properties are reported.
Monitoring retention span (hrs)	The length of time in hours that monitoring entries should be saved before they are crunched into averages.
Monitoring average period (s)	The period between two averaged measurements.
Allowed host (regex)	Part of the web service configuration. A regular expression that sets the hosts allowed to use the logger web service. To enable all hosts, specify `.*`
Allowed categories	Part of the web service configuration. Select All to log all available categories, or select Some Categories to display and select specific categories to log through the web service.