Memory Management Settings: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
Memory usage settings manage, how long objects are kept in the memory, affecting both the memory usage and performance. The longer objects are in the memory, the more memory is consumed, but on the other hand users perceive better performance as analyses are more likely to be available in the memory already calculated. Memory usage settings can be defined for the system level in the [[Web.config_file_in_QPR_ProcessAnalyzer#Qpr.ProcessAnalyzer.Common.Properties.Settings_Section|web.config]] file and for each model separately.
Memory management settings determine, how long models and calculation results are kept in the memory, balancing between the performance and memory consumption. The longer the items are in the memory, the more memory is reserved, but on the other hand users perceive better performance as models and calculation results are more often available in the memory cache (i.e., higher hit rate). Models loaded into memory reserve the space they need and they are not dropped there automatically. The rest of the space is available for other cached objects, which may be dropped if memory is becoming full.


== Model Memory Settings ==
== Drop Unused Filters After setting ==
Model level settings can be set in the Model properties dialog. The following settings are available:
For models, there is the '''Drop Unused Filters After''' setting available in the [[QPR_ProcessAnalyzer_Project_Workspace#Editing_Model_Settings|Model properties]] dialog. The setting determines the duration after which the unused filters in the model are dropped from the memory. The Drop Unused Filters After setting is defined in format ''HH:mm:ss'' or ''d.HH:mm:ss'', for example 01:00:00 (one hour), 00:30:00 (30 minutes) or 1.00:00:00 (24 hours). If this setting is not defined, the server level [[Installing_QPR_ProcessAnalyzer_Server#Server_settings_file_(appsettings.json)|default setting]] is used. When any calculation is performed using a filter, the filter's last used time is updated. Note that the allowed value for this setting is greater than zero seconds.
in the  file and for each model separately in the model settings.
* '''Drop Unused Model After''': Duration after which the unused model, is dropped from the memory. Defined in format ''HH:mm:ss'' or ''d.HH:mm:ss'', for example 01:00:00 (one hour), 00:30:00 (30 minutes) or 1.00:00:00 (24 hours). When an analysis is requested for a model, the model's last used time is updated (also filter's last used time is updated). If this setting is not defined, the server level [[Web.config_file_in_QPR_ProcessAnalyzer#Qpr.ProcessAnalyzer.Common.Properties.Settings_Section|default setting]] is used.
* '''Drop Unused Filters After''': Duration after which the model's unused filters, are dropped from the memory. Defined in format ''HH:mm:ss'' or ''d.HH:mm:ss'', for example 01:00:00 (one hour), 00:30:00 (30 minutes) or 1.00:00:00 (24 hours). When an analysis is requested for a filter , the filter's last used time is updated (also model's last used time is updated). If this setting is not defined, the server level [[Web.config_file_in_QPR_ProcessAnalyzer#Qpr.ProcessAnalyzer.Common.Properties.Settings_Section|default setting]] is used.


==Configuration Examples==
== Best practices for memory management ==
The following values keep the model in memory for 1 hour and filters for 30 minutes.
Follow these best practices for the QPR ProcessAnalyzer server memory configuration:
* Drop Unused Model After: 1:00:00
* Disable extending memory into disk (the page file), because it will slow down the system remarkably. Instead, make sure that there is enough memory in the system for workloads for QPR ProcessAnalyzer. (more information: https://docs.microsoft.com/en-us/windows/client-management/introduction-page-file)
* Drop Unused Filters After: 00:30:00
* Make sure that there are no more models loaded into memory than there is available space. The more there is simultaneous usage, the caching also requires more memory.


The following values keep the model in memory for 15 minutes and filters for 5 minutes.
==Memory Stored Objects==
* Drop Unused Model After: 0:15:00
There are following types of objects managed in the QPR ProcessAnalyzer server memory:
* Drop Unused Filters After: 00:05:00
 
The following values keep the model in memory for 100 days (practically it's never dropped) and filters for 2 hours.
* Drop Unused Model After: 100.00:00:00
* Drop Unused Filters After: 02:00:00
 
==Memory Objects Summary==
Data handled by QPR ProcessAnalyzer memory is stored in following types of objects:
{| class="wikitable"
{| class="wikitable"
!'''Stored Objects'''
!'''Stored object'''
! '''Contents'''
! '''Contents'''
! '''Unused objects dropped after'''
! '''Unused objects dropped after'''
! '''Time to reload/calculate'''
! '''Time to recreate after dropping'''
! '''Memory consumption'''
! '''Memory consumption'''
|-
|-
||Models
||Models (model eventlogs)
||Models objects contain all data in a QPR ProcessAnalyzer model, such as
||Models contain the eventlog data (events, cases), and objects calculated from the (e.g., event types, variations and flows).
* cases
||Models are never dropped automatically from the memory, even when there is a memory shortage in the server. To drop a model from memory, you need to [[QPR_ProcessAnalyzer_Project_Workspace#Loading.2C_Dropping_and_Reloading_Model|drop the model]] in the Workspace. Note that if the server has been restarted, only models that have the [[Automatic_Model_Loading_on_Server_Startup|automatic loading set]] are loaded into memory models directly after the restart.
* events
* variations
* event types
* flows
* flow occurrences
||Primarily defined by a model setting ''CacheUsage/DropUnusedModelsAfter''. If the model setting is not defined, the server level setting in the web.config file is used. If the server setting is not defined either, a default value of 10 hours is used. When the is a memory shortage in the server, models are not dropped from the memory.
||'''Slow'''
||'''Slow'''


Line 43: Line 26:
||'''High'''
||'''High'''
|-
|-
||Filters
||Filters (filter eventlogs)
||Filters contain all filtered data in QPR ProcessAnalyzer model, which includes similar data and structures as the models.
||Filters contain all filtered data in model, which includes similar structures than the models.
||Primarily defined by a model setting. If the model setting is not defined, the server setting is used. If the server setting is not defined, a default value of 1 hour is used. When the is a memory shortage in the server, filters may be dropped from the memory to free memory.
||Primarily defined by the ''Drop Unused Filters After'' setting in the Model settings dialog. If this not set for a model, the server level setting in the [[Web.config_file|web.config]] file is used. If the server setting is not defined, a default value of '''1 hour''' is used.
 
When the is a memory shortage in the server, they may be dropped from the memory earlier to free memory.
||'''Fast'''
||'''Fast'''


Line 51: Line 36:
||'''Medium'''
||'''Medium'''
|-
|-
||Analysis results
||Calculation results
||Results of the analysis (in tabular form).
||Results of the calculations made in dashboards.
||Unused analysis results are kept maximum of 30 minutes in the memory if they are not used. When the is a memory shortage in the server, analysis results may be dropped from the memory to free memory.
||Unused calculation results are kept '''30 minutes''' in the memory. When the is a memory shortage in the server, they may be dropped from the memory earlier to free memory.
||'''Fast'''
||'''Fast'''


Line 59: Line 44:
||'''Low'''
||'''Low'''
|-
|-
||Datatable contents
||Datatables
||Contents of datatables.
||Contents of datatables.
||1 hour.
||There is a fixed duration of '''1 hour'''. When the is a memory shortage in the server, they may be dropped from the memory earlier to free memory.
||
||Between slow and fast, depending on how much there is data in the datatable.
 
||Between high and low, depending on how much there is data in the datatable.
||
|-
||Script results
||
||10 minutes.
||
 
||
|}
|}


If the QPR ProcessAnalyzer server doesn't have enough memory to store more objects, already stored objects are dropped from the memory starting from the one having the longest time from the last usage. Thus, when there is a short of memory, objects may be dropped earlier than their settings define. Only filters and analysis results are dropped during the memory shortage, i.e. model objects are not dropped prematurely. This is because recalculating filters and analysis results is usually faster than loading models from the database. That's why, when trying to load more models than there is available memory in the server, an out of memory error situation may occur.
If the QPR ProcessAnalyzer server doesn't have enough memory to store more objects, already stored filters, calculation results and datatables are dropped from the memory starting from the one having the longest time since the last usage. Thus, when there is a memory shortage, objects may be dropped earlier than their settings define. Filters, calculation results and datatables are dropped during the memory shortage, but model are never dropped automatically. This is because recalculating filters and calculation results is usually faster than loading models from the database. That is why, when trying to load more models than there is available memory in the server, an out of memory error situation may occur.


[[Category: QPR ProcessAnalyzer]]
[[Category: QPR ProcessAnalyzer]]

Revision as of 17:33, 5 March 2023

Memory management settings determine, how long models and calculation results are kept in the memory, balancing between the performance and memory consumption. The longer the items are in the memory, the more memory is reserved, but on the other hand users perceive better performance as models and calculation results are more often available in the memory cache (i.e., higher hit rate). Models loaded into memory reserve the space they need and they are not dropped there automatically. The rest of the space is available for other cached objects, which may be dropped if memory is becoming full.

Drop Unused Filters After setting

For models, there is the Drop Unused Filters After setting available in the Model properties dialog. The setting determines the duration after which the unused filters in the model are dropped from the memory. The Drop Unused Filters After setting is defined in format HH:mm:ss or d.HH:mm:ss, for example 01:00:00 (one hour), 00:30:00 (30 minutes) or 1.00:00:00 (24 hours). If this setting is not defined, the server level default setting is used. When any calculation is performed using a filter, the filter's last used time is updated. Note that the allowed value for this setting is greater than zero seconds.

Best practices for memory management

Follow these best practices for the QPR ProcessAnalyzer server memory configuration:

  • Disable extending memory into disk (the page file), because it will slow down the system remarkably. Instead, make sure that there is enough memory in the system for workloads for QPR ProcessAnalyzer. (more information: https://docs.microsoft.com/en-us/windows/client-management/introduction-page-file)
  • Make sure that there are no more models loaded into memory than there is available space. The more there is simultaneous usage, the caching also requires more memory.

Memory Stored Objects

There are following types of objects managed in the QPR ProcessAnalyzer server memory:

Stored object Contents Unused objects dropped after Time to recreate after dropping Memory consumption
Models (model eventlogs) Models contain the eventlog data (events, cases), and objects calculated from the (e.g., event types, variations and flows). Models are never dropped automatically from the memory, even when there is a memory shortage in the server. To drop a model from memory, you need to drop the model in the Workspace. Note that if the server has been restarted, only models that have the automatic loading set are loaded into memory models directly after the restart. Slow

Models are loaded from the database requiring to transfer considerable amount of data, which takes much more time than e.g. calculating filters and analyses.

High
Filters (filter eventlogs) Filters contain all filtered data in model, which includes similar structures than the models. Primarily defined by the Drop Unused Filters After setting in the Model settings dialog. If this not set for a model, the server level setting in the web.config file is used. If the server setting is not defined, a default value of 1 hour is used.

When the is a memory shortage in the server, they may be dropped from the memory earlier to free memory.

Fast

Filters are calculated from the model data that already exists in the memory. Practically, filters are subsets of models.

Medium
Calculation results Results of the calculations made in dashboards. Unused calculation results are kept 30 minutes in the memory. When the is a memory shortage in the server, they may be dropped from the memory earlier to free memory. Fast

Analysis results are calculated from filters, which already exist in memory.

Low
Datatables Contents of datatables. There is a fixed duration of 1 hour. When the is a memory shortage in the server, they may be dropped from the memory earlier to free memory. Between slow and fast, depending on how much there is data in the datatable. Between high and low, depending on how much there is data in the datatable.

If the QPR ProcessAnalyzer server doesn't have enough memory to store more objects, already stored filters, calculation results and datatables are dropped from the memory starting from the one having the longest time since the last usage. Thus, when there is a memory shortage, objects may be dropped earlier than their settings define. Filters, calculation results and datatables are dropped during the memory shortage, but model are never dropped automatically. This is because recalculating filters and calculation results is usually faster than loading models from the database. That is why, when trying to load more models than there is available memory in the server, an out of memory error situation may occur.