In-memory Models Management: Difference between revisions
(29 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
Memory | This article only concerns the in-memory models in QPR ProcessAnalyzer. Memory management behavior determine, how long models and calculation results are kept in the memory, which balance between the performance and memory consumption. | ||
== | == Memory usage behavior== | ||
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). Loaded models reserve the space in the memory and they are not dropped there automatically (only when explicitly dropped by a user). The rest of the space is available for other cached objects, and they may be dropped if memory is becoming full. | |||
in the | |||
When models are loaded into memory, QPR ProcessAnalyzer (IIS worker process) memory consumption increases. When models are dropped, memory consumption doesn't decrease instantly, and this is because the memory allocated to QPR ProcessAnalyzer might not be released if there is sufficient memory in the server computer. When there is lack of memory, the reserved memory is freed if it's not actually 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 a model, 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. | |||
== Memory usage monitoring == | |||
QPR ProcessAnalyzer memory usage can be monitored in following sources: | |||
* Server Windows Task Manager shows how much memory is reserved to QPR ProcessAnalyzer (i.e., the 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 just be reserved to the w3wp.exe process but it's not currently in use by eventlogs. To see how much memory is actually in use, the administrator can run a manual ''garbage collection'' in the server. 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). | |||
== Set when to drop unused filters == | |||
Models have the '''Drop Unused Filters After''' setting available in the [[QPR_ProcessAnalyzer_Project_Workspace#Editing_Model_Settings|Model properties]] dialog, determining the duration after which unused filters 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. | |||
== 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: | |||
{| class="wikitable" | {| class="wikitable" | ||
!'''Stored | !'''Stored object''' | ||
! '''Contents''' | ! '''Contents''' | ||
! '''Unused objects dropped after''' | ! '''Unused objects dropped after''' | ||
! '''Time to | ! '''Time to recreate after dropping''' | ||
! '''Memory consumption''' | ! '''Memory consumption''' | ||
|- | |- | ||
||Models | ||Models (model eventlogs) | ||
||Models | ||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 [[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 43: | Line 51: | ||
||'''High''' | ||'''High''' | ||
|- | |- | ||
||Filters | ||Filters (filter eventlogs) | ||
||Filters contain all filtered data in | ||Filters contain all filtered data in model, which includes similar structures than the models. | ||
||Primarily defined by | ||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 51: | Line 61: | ||
||'''Medium''' | ||'''Medium''' | ||
|- | |- | ||
|| | ||Calculation results | ||
||Results of the | ||Results of the calculations made in dashboards. | ||
||Unused | ||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 69: | ||
||'''Low''' | ||'''Low''' | ||
|- | |- | ||
|| | ||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. | |||
| | |||
|} | |} | ||
If the QPR ProcessAnalyzer server doesn't have enough memory to store more objects, already stored | 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 21:35, 16 September 2024
This article only concerns the in-memory models in QPR ProcessAnalyzer. Memory management behavior determine, how long models and calculation results are kept in the memory, which balance between the performance and memory consumption.
Memory usage behavior
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). Loaded models reserve the space in the memory and they are not dropped there automatically (only when explicitly dropped by a user). The rest of the space is available for other cached objects, and they may be dropped if memory is becoming full.
When models are loaded into memory, QPR ProcessAnalyzer (IIS worker process) memory consumption increases. When models are dropped, memory consumption doesn't decrease instantly, and this is because the memory allocated to QPR ProcessAnalyzer might not be released if there is sufficient memory in the server computer. When there is lack of memory, the reserved memory is freed if it's not actually 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 a model, 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.
Memory usage monitoring
QPR ProcessAnalyzer memory usage can be monitored in following sources:
- Server Windows Task Manager shows how much memory is reserved to QPR ProcessAnalyzer (i.e., the 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 just be reserved to the w3wp.exe process but it's not currently in use by eventlogs. To see how much memory is actually in use, the administrator can run a manual garbage collection in the server. 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).
Set when to drop unused filters
Models have the Drop Unused Filters After setting available in the Model properties dialog, determining the duration after which unused filters 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 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. | 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.