How to look for userSessionTimeout in Spotfire Web Player logs

Date Posted: 2020-05-16
Product: TIBCO Spotfire®

Problem:

Solution:

How to look for UserSessionTimeout in Spotfire Web Player logs

Spotfire starts checking for inactive user sessions on Web Player when 'checkUserSessionTimeoutIntervalSeconds' time is met and closes idle user sessions if there are any and user will be logged out of Web Player. 'checkUserSessionTimeoutIntervalSeconds' specifies how often, in seconds, a check should be made to determine whether a user has timed out on the service. Default value is 120. This is found in Web Player’s Spotfire.Dxp.Worker.Web.Config configuration file.

Log entries for 'checkUserSessionTimeoutIntervalSeconds' and 'UserSessionTimeout' are captured when logging is set to 'DEBUG' mode and will be found in web player logs (Spotfire.Dxp.Worker.Host.Debug.xxx.log) since UserSessionTimeout is a service level configuration.

Below line will be logged when 'checkUserSessionTimeoutIntervalSeconds' time is met and Spotfire starts checking for idle user sessions on Web Player.
----------------------------------------
DEBUG;2020-02-17T10:28:42,270-06:00;2020-02-17 16:28:42,270;3f134018-02da-471b-9bcb-3309f829d210;1709559790EGrL;BG Thread Cleanup CWUS 88;;;Spotfire.Dxp.Web.SiteManager;"Timer for checking user sessions in the worker started."
----------------------------------------

Below entries will be logged if any idle user sessions are found and user will be logout out of Web Player and user session will be removed.
---------------------------------------
DEBUG;2020-02-17T10:28:42,270-06:00;2020-02-17 16:28:42,270;3f134018-02da-471b-9bcb-3309f829d210;1709559790EGrL;BG Thread Cleanup CWUS 88;arpitha;8475c7208b845de73f0b3a626577fbdc;Spotfire.Dxp.Web.SiteManager;"Logging out user 'arpitha' (arpitha) with sessionId '8475c7208b845de73f0b3a626577fbdc'."
DEBUG;2020-02-17T10:28:42,270-06:00;2020-02-17 16:28:42,270;3f134018-02da-471b-9bcb-3309f829d210;1709559790EGrL;BG Thread Cleanup CWUS 88;arpitha;8475c7208b845de73f0b3a626577fbdc;Spotfire.Dxp.Web.UserSession;"Disposing user session '8475c7208b845de73f0b3a626577fbdc' for 'arpitha'."
DEBUG;2020-02-17T10:28:42,270-06:00;2020-02-17 16:28:42,270;3f134018-02da-471b-9bcb-3309f829d210;1709559790EGrL;BG Thread Cleanup CWUS 88;arpitha;8475c7208b845de73f0b3a626577fbdc;Spotfire.Dxp.Framework.Utilities.ServerLoggerManager;"Server log manager logged Audit: 2020-02-17T10:28:42,270-06:00, 10.98.48.192, auth_wp, logout, True, arpitha, , , , 8475c7208b845de73f0b3a626577fbdc, , 3f134018-02da-471b-9bcb-3309f829d210."
---------------------------------------

In user action logs, LOG_CATEGORY=auth_wp and LOG_ACTION=logout will be logged when user session is closed due to inactivity.

On the browser 'the page has been closed due to inactivity. Thank you for using TIBCO Spotfire' message will be displayed with 'Log in' button if user is on 'Analytics' page.
User-added image

If user has any analysis file open which is closed due to inactivity then 'Your analysis has been closed.' message that is displayed when inactivity timeout is met will not change to 'the page has been closed due to inactivity. Thank you for using TIBCO Spotfire' message when userSessionTimeout is met.