Fine Tuning Studio Sessions

Setting Timeouts

Data Studio user login sessions are logged out automatically after a set amount of time. It is recommended to set the appropriate session timeouts in the config.sh file.

Note:

Trigger the install.sh file with the -u option if any changes have been made in the config.sh file post installation.

Table 6-7 Timeout Settings

Timeout Type	Description	Example Configuration	Additional Remarks
Absolute Session Timeout	You can configure the user login sessions to be logged out automatically after a set amount of time. The number specifies the amount of milliseconds that are required to be passed after a session is created. When the timeout expires, the session is no longer valid. Here, the word login referes to when the user logs in to the Compliance Studio application. When a user session ends, all associated executions will also be killed.	studio-server: security: absolute-session-timeout-ms: 86400000 // 24 hours	Ends the session and kills the executions. It is recommended to set this. A value of 0 means that the sessions will never time out.
Relative Session Timeout	You can configure the user login sessions to be renewed as per the activity. The number specifies the amount of milliseconds a user session will be renewed to after an activity. When there is no user-activity within the specified relative timeout, the session expires and is no longer valid. Here activity refers to the editing of paragraph content, addition or deletion of paragraph(s), execution of paragraph(s), etc.	studio-server: security: session-timeout-ms: 3600000 // 1 hour	This is based on the user activity such as editing or executing. It is recommended to set this. A value of 0 means that the sessions will never be renewed.
Paragraph Execution Timeout	You can configure this to automatically cancel a paragraph execution after a set amount of time. When the timeout expires, Data Studio will automatically interrupt the execution of the paragraph.	studio-server: interpreter: execution: run-timeout: 12h	Prevents runaway jobs. You can set the timeout to 0 to disable the timeout entirely. When the timeout is disabled, paragraphs will run either until they finish or are being manually cancelled.
Execution Idle Timeout	The amount of time an interpreter session can stay idle before being invalidated by the application to free up resources. An interpreter session is considered idle when it is not running any tasks. You can consider the interpreter session to be equivalent to the python sessions that gets created for a notebook execution. Here idle refers to paragraphs that are not being executed.	studio-server: interpreter: deployment: host: idle-session-timeout: 1h	Frees up memory and compute. It is recommended to set this.
Incomplete Job Cleanup	You can configure how often a cleanup job will be run to mark unfinished jobs as incomplete by setting studio-server.jobs.incomplete.scheduled-cleanup-delay value. A job can be in incomplete state if the server restarts in the middle of a Job execution or if it takes longer the specified timeout (studio-server.jobs.incomplete.timeout).	studio-server: jobs: incomplete: timeout: 18h scheduled-cleanup-delay: 2h	Useful for crash recovery.