Mar 4, 2023
Making TM1 REST API queries faster
Pulse is mainly making three REST API queries (one to get the sessions, one to get the threads, and one to get the logs). This article shares some recommendations to make these queries even faster.
Reducing the size of the tm1server.log file
When Pulse is asking IBM Planning Analytics (TM1) to get the logs, TM1 is then reading the tm1server.log file. The size of this file will impact the speed of this query. Therefore it is recommended to keep the size of the tm1server.log file under 500 MB.
To reduce the size of the tm1server.log file, you need to use the parameter MaxFileSize in the tm1s-log.properties.
Reducing the number of files inside the TM1 logs folder
When the tm1server.log file reaches the MaxFileSize limit then TM1 is going to create a new file and the current file will become a backup file inside the logs folder. The number of backup files impacts the speed of the REST API query. Therefore it is recommended to reduce the MaxBackupIndex (driving the number of backup files).
Reducing the number of sessions
The number of sessions will impact the speed of the REST API query. Therefore it is recommended to reduce the number of Idle sessions. To do that you could reduce the HTTPSessionTimeoutMinutes in the tm1s.cfg file.
Check the authentication to the TM1 REST API
Pulse needs to authenticate to TM1 to get a session ID (Once the session ID is retrieved, Pulse does not need to authenticate again until Pulse logs out once a day). During this authentication, Pulse will not be able to track what is happening. Pulse includes scripts to test your REST API authentication. If the authentication takes more than 10 seconds then you should contact IBM to improve the REST API authentication process.