Forum | Synoptix

Learn, Create, Report
It is currently Wed Aug 21, 2019 12:00 pm

All times are UTC - 7 hours [ DST ]

Post new topic Reply to topic  [ 1 post ] 
Author Message
PostPosted: Mon Jun 03, 2019 12:58 pm 
Site Admin
User avatar

Joined: Tue Dec 10, 2013 3:27 pm
Posts: 413
Tomcat memory configurations & optimizing the scheduler

Download a PDF of this guide here:
Downloaded 7 times

Watch this in action in our Installation Tutorial Video at segment 6:35

Tomcat Requirements
The new 8.0 browser scheduler uses Apache Tomcat (version 8.5 or later) with our own ROOT.war code supplanted. It runs off of one internal server that needs to have adequate memory in order to process reports run in real time and scheduled reports. This guide reviews those settings and how to configure your server to ensure the scheduler is optimized to process reports users are running through the browser.

Available Physical Memory | RAM | Virtual Memory
•Available physical memory is more critical to the functionality of the scheduler than the RAM of the machine. RAM is how much physical memory is installed to the workstation, and available physical memory is what is not being occupied by other processes. Available physical memory is what
should be referenced in regards to Tomcat calculations. Note that because users accessing the browser are all drawing on the single Tomcat server, you must have enough memory available for all users to run reports. If you have many users employing the browser scheduler simultaneously, you should allocate more available physical memory to the machine.
•If you are using virtual memory to extend the RAM size, please note that this cause slower performance in the browser scheduler. Virtual memory access goes through a system check via memory controller hardware. Accessing available physical memory takes nanoseconds, while accessing disk takes milliseconds, Additional delays are dependent upon OS and computer architecture. This is why we do not recommend relying on virtual memory to run the scheduler.
•You can view these memory allocations within your System Information Summary screen.
Remember that browser memory allocations only apply to the server running Apache Tomcat, and not individual user workstations that access the scheduler.


Tomcat configurations & browser memory configurations
•There are settings to be adjusted within both the Tomcat configuration and the browser admin setup. These memory settings are separate, but both draw on the available physical memory of the machine.

Tomcat configuration settings: accessed when running reports in real time (from the Reports tab)
Browser memory settings: accessed when running scheduled reports & when users drilldown in the browser


Configuration Terms

Within Apache Tomcat configuration > Java tab
Initial memory pool: what the java virtual machine allocates every time a Tomcat task begins. This number should be kept low. We advise keeping it at the default of 128 MB. If it is increased, that much memory will always be allocated whenever Tomcat tasks begin, even if they are undemanding processes (such as searching for a schedule in the browser).
Maximum memory pool: memory allocated for entire Tomcat service to run for all users (remember these settings are for the whole Tomcat server). This space is allocated for all users, and may become burdened when multiple users are running reports in real time, simultaneously. The required amount this should be set to when Tomcat is installed to run the scheduler is 1024. Significant performance improvements have been observed when it is set to 2048 MB. We recommend setting it to 2048 MB (as seen in image above) if your RAM allows it.

Within the browser scheduler Setup > Admin Setup menu
Reports: the simultaneous reports setting is how many reports can run at once. It reads each individual filter as a unique report. When a report with filters is run, it will kick off as many java.exe tasks as you have the simultaneous reports number set to. Once it finishes a java.exe, it will start another one until it goes through all filters. You can view how much memory each filter takes by opening the task manager while a scheduled report is running.
Memory: the amount of available physical memory that each one of those report threads can use. The minimum setting for this number is 1024 and we recommend keeping it at 1024. If you would like to increase the speed at which a report can run, you can increase the number of simultaneous reports. This is the more effective method, rather than increasing the memory. Remember to check if you have enough resources before adjusting the reports or memory settings in the browser, as they draw heavily on the available memory of the machine.

Recommendation: ​we have observed optimal performance with users when the Tomcat configuration has a maximum memory pool of ​2048​, and the browser admin setup memory is set to ​1024​, with 3-4 simultaneous
report threads. Please note to accommodate these recommended settings, you should have at least the minimum recommended amount of available physical memory on the machine (8 GB).

Memory Calculations

•You can perform a simple calculation to see how much memory is being consumed by the scheduler and ensure you have enough resources allocated. In the browser scheduler Setup > Admin Setup, multiple the Reports number by the Memory allocation. Note that Memory must be set to at least 1024, and based on the resources of the server, we recommend keeping the Reports setting between 2 and 5.
•Once you have made this calculation, add the final total to the Maximum memory pool amount within the Tomcat configuration.
You can compare this to the available physical memory on the machine to ensure you do not hit a ceiling with your Tomcat memory, which can cause slowness, scheduler errors, or emails not being sent out.
•Remember that other programs also draw on your available physical memory; for example, a Google Chrome instance with several tabs can occupy 2 GB of RAM. Take the task and program load of the server into account when making these calculations, to ensure other applications running on the server will not exceed the resources.


For more information on the scheduler:

Overview of the Scheduler Guide
Common Scheduler Errors & How to Resolve Them

For details on system configuration and install requirements, see our System Requirements article.
If you have additional questions, please submit a ticket to Support.

Available physical memory calculation.png [37.56 KiB]
Not downloaded yet
Browser memory calculation.png [52.1 KiB]
Not downloaded yet
browser memory settings.png [13.51 KiB]
Not downloaded yet
Memory allocation comparison.png [53.28 KiB]
Not downloaded yet
system Info memory.png [13.04 KiB]
Not downloaded yet
Tomcat minimum req.png [24.4 KiB]
Not downloaded yet
Downloaded 11 times
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 1 post ] 

All times are UTC - 7 hours [ DST ]

Who is online

Users browsing this forum: No registered users and 5 guests

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Powered by phpBB® Forum Software © phpBB Group
Powered by Reputation System © Pico88