In-memory Models Management: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
 
(50 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.
Managing in-memory models means how many models can be loaded in-memory at the same time and how long filter eventlogs and calculation result caches are kept in the memory. Note that this article only concerns the in-memory models in QPR ProcessAnalyzer.


== Model Memory Settings ==
== Memory usage behavior==
Model level settings can be set in the Model properties dialog. The following settings are available:
QPR ProcessAnalyzer uses the automatically running garbage collection mechanism which releases unused objects from the memory when the system needs more resources to store new objects. When models are loaded into memory, QPR ProcessAnalyzer (IIS worker process) memory consumption increases. When models are dropped, memory resources are released. The memory consumption doesn't decrease instantly, and this is because the garbage collection might not run immediately if there is no need for more memory resources. When there is lack of memory, the reserved memory is freed by the garbage collection if it's not currently used by QPR ProcessAnalyzer. When models are loaded into memory after dropping models, the memory consumption might not increase because the reserved memory (previously used by the dropped models) can be used by the newly loaded models.
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==
When using models (e.g., opening dashboards), the memory consumption further increases because filter eventlogs are cached to the memory. If there is lack of memory, older filter eventlogs are dropped from the memory to get more space. This on the other hand decreases performance because if the filter eventlog is needed again, it needs to be recalculated.
The following values keep the model in memory for 1 hour and filters for 30 minutes.
* Drop Unused Model After: 1:00:00
* Drop Unused Filters After: 00:30:00


The following values keep the model in memory for 15 minutes and filters for 5 minutes.
Loaded models are never dropped from the automatically but only when explicitly requested by a user. This is because loading a model from the database usually time consuming operation. When trying to load more models than there is available memory in the server, an out of memory error situation may occur and the QPR ProcessAnalyzer server may restart itself.  
* Drop Unused Model After: 0:15:00
* 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.
Memory not used by model eventlogs, is available for other cached objects, and they may be dropped automatically if memory is becoming full. The more there is memory available, the better the performance because requested filters and calculation results are more often available in the memory cache (i.e., higher hit rate). QPR ProcessAnalyzer is thus flexible in terms of the memory usage, as it will use more memory if there is memory available, but it can also work with less memory (although with decreased performance). Filters and calculation results are dropped 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 default preservation settings define.
* Drop Unused Model After: 100.00:00:00
* Drop Unused Filters After: 02:00:00


==Memory Stored Objects==
== Memory usage monitoring ==
Data handled by QPR ProcessAnalyzer memory is stored in following types of objects:
QPR ProcessAnalyzer memory usage can be monitored in following sources:
* Windows Task Manager shows how much memory is reserved to QPR ProcessAnalyzer server (i.e., IIS worker process, w3wp.exe).
* [[Navigation_Menu#User_Settings|User Settings]] dialog in the QPR ProcessAnalyzer UI shows how much memory is used by QPR ProcessAnalyzer (click '''details''' and see '''QPR ProcessAnalyzer memory usage''').
 
Based on the memory usage, it may be difficult to identify how much there is unused memory in the server because some of the memory may be reserved to the w3wp.exe process but it's not in use. To see how much memory is actually in use, the administrator can run the ''garbage collection'' manually. It can be done in the [[Navigation_Menu#Expression_Designer|Expression Designer]] by running the following commands:
<pre>
GarbageCollection();
Sleep(2000);
GarbageCollection();
Sleep(2000);
GarbageCollection();
Sleep(2000);
"Memory consumption: " + Round((UsedProcessMemory / 1024 / 1024), 0) + "MB"
</pre>
 
These commands runs the garbage collection three times and after that shows the QPR ProcessAnalyzer memory usage (same as in the User Settings dialog).
 
== Best practices for memory management ==
Follow these best practices for managing and optimizing the QPR ProcessAnalyzer server memory usage:
* Make sure that the total ''Estimated memory usage'' as displayed in the ''Models'' ''[[Navigation_Menu#System_Reports|System Reports]]'' is less than the amount of memory available for the QPR ProcessAnalyzer server. The Estimated memory usage takes into account the estimated memory consumption needed for simultaneous user sessions, cached filters, calculation results, working memory and other on-time required computing resources. The actual memory consumption for each model immediately after it has been loaded into the memory is lower than the Estimated memory usage. Please make sure there is enough memory available after the models have been loaded so that the simultaneous usage does not result in running out of memory.
* Model content can be optimized from the memory usage viewpoint. Usually, string type of data consumes most of the memory, and numbers, dates and booleans don't need that much memory. For strings, especially long texts and great number of unique texts consume lot of memory. Consider whether the information can be expressed using numbers, dates and booleans, and prefer them over strings.
* Adjust the ''Drop Unused Filters After'' setting available for models (in the [[QPR_ProcessAnalyzer_Project_Workspace#Editing_Model_Settings|Model properties]] dialog) which determines the duration after which unused filter eventlogs are dropped from the memory. Lower values can be used when there isn't much memory available in the server. 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.
* 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)
 
==Objects stored in memory==
There are following types of in-memory objects that are managed by the QPR ProcessAnalyzer server:
{| class="wikitable"
{| class="wikitable"
!'''Stored&nbsp;object'''
!'''Stored&nbsp;object'''
! '''Contents'''
! '''Contents'''
! '''Unused objects dropped after'''
! '''Unused objects dropped after'''
! '''Time to recreate after dropping'''
! '''Time to recreate'''
! '''Memory&nbsp;consumption'''
! '''Memory&nbsp;consumption'''
|-
|-
||Models (model&nbsp;eventlogs)
||Models (model&nbsp;eventlogs)
||Models contain all data in a model, such as events, cases, event types and variations.
||Models contain the eventlog data (events, cases), and objects calculated from the (e.g., event types, variations and flows).
||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. Even when the is a memory shortage in the server, models are not dropped from the memory.
||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.
||'''Slow'''
||'''Slow'''


Line 38: Line 53:
|-
|-
||Filters (filter&nbsp;eventlogs)
||Filters (filter&nbsp;eventlogs)
||Filters contain all filtered data in 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, they may be dropped from the memory earlier 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 [[Installing_QPR_ProcessAnalyzer_Server#Server_settings_file_(appsettings.json)|DropUnusedFiltersAfter]] 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, they may be dropped from the memory earlier to free memory.
||'''Fast'''
||'''Fast'''


Line 46: Line 63:
|-
|-
||Calculation&nbsp;results
||Calculation&nbsp;results
||Results of the calculations made e.g. for charts.
||Results of the calculations made in dashboards.
||Unused calculation results are kept maximum of '''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.
||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 55: Line 72:
||Datatables
||Datatables
||Contents of datatables.
||Contents of datatables.
||'''1 hour'''. When the is a memory shortage in the server, they may be dropped from the memory earlier to free memory.
||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 datatables.
||Depends on how much there is data in the datatable.
||Between high and low, depending on how much there is data in the datatables.
||Depends 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 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.


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

Latest revision as of 08:26, 26 September 2024

Managing in-memory models means how many models can be loaded in-memory at the same time and how long filter eventlogs and calculation result caches are kept in the memory. Note that this article only concerns the in-memory models in QPR ProcessAnalyzer.

Memory usage behavior

QPR ProcessAnalyzer uses the automatically running garbage collection mechanism which releases unused objects from the memory when the system needs more resources to store new objects. When models are loaded into memory, QPR ProcessAnalyzer (IIS worker process) memory consumption increases. When models are dropped, memory resources are released. The memory consumption doesn't decrease instantly, and this is because the garbage collection might not run immediately if there is no need for more memory resources. When there is lack of memory, the reserved memory is freed by the garbage collection if it's not currently used by QPR ProcessAnalyzer. When models are loaded into memory after dropping models, the memory consumption might not increase because the reserved memory (previously used by the dropped models) can be used by the newly loaded models.

When using models (e.g., opening dashboards), the memory consumption further increases because filter eventlogs are cached to the memory. If there is lack of memory, older filter eventlogs are dropped from the memory to get more space. This on the other hand decreases performance because if the filter eventlog is needed again, it needs to be recalculated.

Loaded models are never dropped from the automatically but only when explicitly requested by a user. This is because loading a model from the database usually time consuming operation. When trying to load more models than there is available memory in the server, an out of memory error situation may occur and the QPR ProcessAnalyzer server may restart itself.

Memory not used by model eventlogs, is available for other cached objects, and they may be dropped automatically if memory is becoming full. The more there is memory available, the better the performance because requested filters and calculation results are more often available in the memory cache (i.e., higher hit rate). QPR ProcessAnalyzer is thus flexible in terms of the memory usage, as it will use more memory if there is memory available, but it can also work with less memory (although with decreased performance). Filters and calculation results are dropped 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 default preservation settings define.

Memory usage monitoring

QPR ProcessAnalyzer memory usage can be monitored in following sources:

  • Windows Task Manager shows how much memory is reserved to QPR ProcessAnalyzer server (i.e., IIS worker process, w3wp.exe).
  • User Settings dialog in the QPR ProcessAnalyzer UI shows how much memory is used by QPR ProcessAnalyzer (click details and see QPR ProcessAnalyzer memory usage).

Based on the memory usage, it may be difficult to identify how much there is unused memory in the server because some of the memory may be reserved to the w3wp.exe process but it's not in use. To see how much memory is actually in use, the administrator can run the garbage collection manually. It can be done in the Expression Designer by running the following commands:

GarbageCollection();
Sleep(2000);
GarbageCollection();
Sleep(2000);
GarbageCollection();
Sleep(2000);
"Memory consumption: " + Round((UsedProcessMemory / 1024 / 1024), 0) + "MB"

These commands runs the garbage collection three times and after that shows the QPR ProcessAnalyzer memory usage (same as in the User Settings dialog).

Best practices for memory management

Follow these best practices for managing and optimizing the QPR ProcessAnalyzer server memory usage:

  • Make sure that the total Estimated memory usage as displayed in the Models System Reports is less than the amount of memory available for the QPR ProcessAnalyzer server. The Estimated memory usage takes into account the estimated memory consumption needed for simultaneous user sessions, cached filters, calculation results, working memory and other on-time required computing resources. The actual memory consumption for each model immediately after it has been loaded into the memory is lower than the Estimated memory usage. Please make sure there is enough memory available after the models have been loaded so that the simultaneous usage does not result in running out of memory.
  • Model content can be optimized from the memory usage viewpoint. Usually, string type of data consumes most of the memory, and numbers, dates and booleans don't need that much memory. For strings, especially long texts and great number of unique texts consume lot of memory. Consider whether the information can be expressed using numbers, dates and booleans, and prefer them over strings.
  • Adjust the Drop Unused Filters After setting available for models (in the Model properties dialog) which determines the duration after which unused filter eventlogs are dropped from the memory. Lower values can be used when there isn't much memory available in the server. 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.
  • 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)

Objects stored in memory

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

Stored object Contents Unused objects dropped after Time to recreate 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 DropUnusedFiltersAfter 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, 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. Depends on how much there is data in the datatable. Depends on how much there is data in the datatable.