{"id":47683,"date":"2021-03-02T11:04:33","date_gmt":"2021-03-02T03:04:33","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/?page_id=47683"},"modified":"2024-08-13T16:31:43","modified_gmt":"2024-08-13T08:31:43","slug":"sentinel-performance-monitoring","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/troubleshooting-sentinel-issues\/sentinel-performance-monitoring\/","title":{"rendered":"Performance Monitoring"},"content":{"rendered":"\n<p class=\"left-bar\">This article applies to version 4.17 and later of IFS OI Sentinel. For more, see <a href=\"#Release_History\">Release History<\/a>.<\/p>\n<h2 class=\"page-subheading\">Performance Counters<\/h2>\n<p class=\"intro-text\">Performance counters allow you to observe the activity of the Sentinel system in order to understand how it is performing. A number of Sentinel Engine performance counters are available from the Windows Performance Monitor.<\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-perf-mon.png\" rel=\"lightbox-0\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-47685\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-perf-mon.png\" alt=\"\" width=\"487\" height=\"356\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-perf-mon.png 487w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-perf-mon-150x110.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-perf-mon-48x35.png 48w\" sizes=\"auto, (max-width: 487px) 100vw, 487px\" \/><\/a><\/p>\n<p class=\"intro-text\">The performance counters are:<\/p>\n<table style=\"border-collapse: collapse; width: 100%;\">\n<tbody class=\"intro-text\">\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Active Monitors<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Total number of active monitors configured<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Catching up Monitors<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Total number of monitors which are fetching data from the past (\"Catching up\")<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Events written per second<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Number of events which Sentinel has raised per second<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Lagging Monitors<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Total number of monitors which have taken longer to run than the scheduled period (e.g. a monitor which is scheduled for once a minute but had taken more than 1 minute to process all tests)<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Server Data Instance Queue Count<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Number of data requests which are pending<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Server Instance Queue Count<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Number of data dictionary requests which are pending<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Running Monitors<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Number of monitors which are currently running<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Scheduler Queue Size<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Number of monitors which are scheduled to run<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"width: 35.7292%;\"><strong>Total monitor pipeline queue count<\/strong><\/td>\n<td style=\"width: 64.2708%;\">Number of monitors which have a thread assigned for processing<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>&nbsp;<\/p>\n<p class=\"intro-text\">To enable the performance counters, the Debug key in the Engine group of the <strong>SentinelConfig.xml<\/strong> file needs to set to True:<\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-debug-config.png\" rel=\"lightbox-1\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-47688\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-debug-config.png\" alt=\"\" width=\"573\" height=\"93\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-debug-config.png 573w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-debug-config-150x24.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2021\/03\/sen-debug-config-48x8.png 48w\" sizes=\"auto, (max-width: 573px) 100vw, 573px\" \/><\/a><\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Performance Metrics<\/h2>\n<p class=\"intro-text\">In v4.17, a <strong>TestPerformanceMetrics<\/strong> table was added to the Sentinel database, which captures performance metrics for each monitor\/test.<\/p>\n<p class=\"intro-text\">Two new configuration settings have been added to the Sentinel Configuration file:<\/p>\n<ul class=\"intro-text\">\n<li><strong>MonitorPerformanceMetricsEnabled<\/strong>: This needs to be set to True for the metrics to be collected.<\/li>\n<li><strong>MonitorPerformanceMetricsPurgeTimeoutHours<\/strong>: Specifies how often to delete all the metrics from the table.<\/li>\n<\/ul>\n<p class=\"intro-text\">The table contains the following columns, which can be used to analyse performance issues:<\/p>\n<table>\n<tbody class=\"intro-text\">\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>Column<\/strong><\/td>\n<td><strong>Description<\/strong><\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>TestId<\/strong><\/td>\n<td>The unique identifier of the test being analysed.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>TestVersionId<\/strong><\/td>\n<td>The version of the test.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>MonitorVersionId<\/strong><\/td>\n<td>The version of the monitor.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>TestRunTime<\/strong><\/td>\n<td>Time, in milliseconds, taken to run the test.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>DataFetchTime<\/strong><\/td>\n<td>Time, in milliseconds, taken to fetch the data.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>EventWriteTime<\/strong><\/td>\n<td>Time, in milliseconds, taken to an event to be written to the database.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>TotalRunTime<\/strong><\/td>\n<td>Total time, in milliseconds, taken for the monitor to run.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>FetchSourceTime<\/strong><\/td>\n<td>Time, in milliseconds, for the data source to respond to the fetch request.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>PreConditionRunTime<\/strong><\/td>\n<td>Time, in milliseconds, taken to for the pre-condition to run.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>EntityCount<\/strong><\/td>\n<td>The number of entities being processed.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>TriggerTime<\/strong><\/td>\n<td>The timestamp that the test was triggered.<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td><strong>ProcessingStartTime<\/strong><\/td>\n<td>The timestamp that the test started being processed.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<hr \/>\n<h2 class=\"page-subheading\"><span id=\"Release_History\">Release History<\/span><\/h2>\n<ul class=\"intro-text\">\n<li>Performance Monitoring 4.17\u00a0 (this release)\n<ul class=\"intro-text\">\n<li>Added TestPerformanceMetrics table to the Sentinel database<\/li>\n<\/ul>\n<\/li>\n<li>Performance Counters (initial release)<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>This page lists the Sentinel Engine performance counters that are available from the Windows Performance Monitor.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/troubleshooting-sentinel-issues\/sentinel-performance-monitoring\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":67943,"parent":58772,"menu_order":8,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[10],"tags":[],"class_list":["post-47683","page","type-page","status-publish","has-post-thumbnail","hentry","category-troubleshooting","Product-sen"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/47683","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=47683"}],"version-history":[{"count":15,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/47683\/revisions"}],"predecessor-version":[{"id":68367,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/47683\/revisions\/68367"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/58772"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/67943"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=47683"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=47683"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=47683"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}