Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


 

Anchor
top
top
The XperienCentral Performance Dashboard provides detailed information about how the parts of XperienCentral's infrastructure are functioning. Because XperienCentral is a complex system, the interaction between many different sub-systems and configuration options has a direct impact on how it performs. Using the Performance Dashboard, system administrators, developers, and application managers can quickly identify problems and then make the necessary configuration changes to ensure that XperienCentral performs optimally. The Performance Dashboard measures the speed and response time of page requests and internal queries as well as other settings that affect how XperienCentral runs and rates the results according to the optimal expected results.

The status of how the various XperienCentral subsystems are performing is then shown using an easily identifiable color-coded system: 


Performance IndicatorDescription

The functionality/configuration setting is functioning within optimally expected parameters.

The functionality/configuration setting is functioning below its optimal level.

The functionality/configuration setting is having a pronounced, negative impact on XperienCentral's performance and should be immediately examined and addressed.

 

 



Note

Notes:

  • In a clustered environment, the statistics shown in the Performance Dashboard are only for the node/instance/server on which the Performance Dashboard is running, not the whole environment.
  • The Administrative Pages are also useful for closely examining the performance of processes and events within XperienCentral.

 


To open the Performance Dashboard, navigate to Configuration > Performance Dashboard. 


In This Topic

Table of Contents
maxLevel2
minLevel2
 


...

System Performance Indicators

...

IndicatorDescription
Debugging optionsSpecifies the status of the XperienCentral debug options. If any debug option is enabled, the status is red.
Log levelSpecifies the level of logging that is currently set for XperienCentral. Logging can be enabled for the following system functionality:
  • XperienCentral
  • Jackrabbit
  • Spring framework
  • Quartz
What you log for each and how many of these functionalities you enable logging for can directly affect XperienCentral performance.

...


Back to top

 


...

Anchor
page_response_time
page_response_time
Page Response Time Indicators

...

When a page is requested and caching is enabled, XperienCentral determines whether the page can be returned from the cache (see 1 in the figure below) and returns it; if the page cannot be returned from the cache, it is generated by the Page Generator and returned (see 2 in the figure below):

 

 




 
To enable monitoring for web pages and/or pages generated by the Page Generator pages, select "Monitoring enabled".

 


Note

Notes:

  • These options are not persisted — Monitoring is enabled for the current session only. If the Tomcat server is restarted, these checkboxes are cleared.
  • Enabling page response time monitoring can affect XperienCentral performance. Monitoring should not be constantly enabled.

...


When these monitoring settings are enabled, the pages returned by the Page Generator that took the longest to generate as well as the pages that took the longest time to load are listed. The pages that appear in the list are those that have been read since monitoring was enabled or since the last time that the list was cleared using the [Clear list] button.

...

To view the contents of a page in the list in a separate window, click its URL in the list. This makes it easy for you to quickly view the contents of the slowest pages. The page will display in a separate window.

 


Note

Not all pages in the list are viewable due to context-related factors. If the page cannot be displayed, a JavaScript error will be returned.

 


 


Back to top

 


...

Page Cache Ratio Indicators

The Page cache ratio tab shows the pages with the smallest cache ratio, that is pages that are more often being regenerated instead of being returned from the cache. The higher the number, the better this is for performance. The page cache ratio is always a number between 0 and 1 (between 0% and 100%).

To enable page cache ratio monitoring, select '"Monitoring enabled". The average cache ratio for the pages with the lowest cache ratio are listed. Ideally this number should always be 1 (100% of requests could be returned from the cache). The pages that appear in the list are those that have been read since monitoring was enabled or since the last time that the list was cleared using the [Clear list] button.

To view the contents of a the pages with the smallest cache ratios, click its URL in the list. This makes it easy for you to quickly view the contents of the pages. The page will display in a separate window. 


Note

Not all pages in the list are viewable due to context-related factors. If the page cannot be displayed, a JavaScript error will be returned.

 


To refresh the list, click [Refresh this page]. To clear the list, click [Clear list]. For information on improving cache ratio, see Lowering the Cache Ratio.

 


Back to top

 


...

Anchor
queries
queries
Queries Indicators

Use the Queries tab to monitor and examine the queries that have taken the most time (the slowest). To enable query monitoring, select "Monitoring enabled": 


 

 



Note

Notes:

  • The enabling of SQL query monitoring is not a persisted setting — Monitoring is enabled for the current session only. If the Tomcat server is restarted, the "Enable monitoring" checkbox is cleared.
  • Enabling SQL query monitoring directly affects XperienCentral performance. Monitoring should not be constantly enabled.

...

After query monitoring is enabled, the speed of all queries performed by XperienCentral will be monitored. In the "Slowest Queries" list, the slowest query monitored appears at the top of the list. The queries that appear in the list are those that have run since monitoring was enabled or since the last time that the list was cleared using the [Clear list] button.

 


 

 



To see the full query, click it in the list. In the "Details" box the full query appears. From here you can also copy the query and paste it in another application: 




To refresh the list to see the latest queries, click [Refresh this page]. To clear the list, click [Clear list]. 


Back to top

 


...

Improving System Performance

...

If caching is enabled in XperienCentral, a green indicator is shown and if it is disabled, a red indicator is shown. Caching allows XperienCentral to handle the load created by many page requests by using an intelligent mechanism that returns pages without having to regenerate them completely every time they are requested. In all cases, caching improves website performance and it is highly recommended that you enable it for your website.

To enable/disable caching, navigate to the Setup Tool. On the General tab, navigate to the "frontend_system_settings" section and select allow_cache:



 


For more information on caching in XperienCentral, see Caching.

...

The caching module of XperienCentral stores a timestamp in the timestamp database for each cached web page. This timestamp is needed in order to determine whether the web page needs to be regenerated or whether it can be retrieved from the cache. For high volume websites, the number of web page requests per second can be so high that even the relatively simple task of performing one SQL query to retrieve this timestamp from the database can cause a bottleneck. If this exceeds 500 milliseconds, it may indicate a performance issue.

To prevent timestamp retrieval from becoming a bottleneck, timestamps can be cached in memory for <n> milliseconds. Note that this also causes a delay of <n> milliseconds; during the <n> milliseconds, modified web pages will not be regenerated. It is recommended that you set timestamp caching to at least 5000 milliseconds (5 seconds).  If you set timestamp caching to fewer than 5000 milliseconds, this can cause database bottlenecks especially for websites that experience a large number of page requests.

Timestamp caching is configured in the XperienCentral Setup Tool. Navigate to the "frontend_system_settings" section of the General tab: 


Anchor
lowering_page_response_times
lowering_page_response_times
Lowering Page Response Times

...

To enable/disable the XperienCentral debug options that affect performance, navigate to the Setup Tool. On the General tab, navigate to "development_settings". Clear the checkbox for enable_debug_messages. In a production environment, the setting enable_view_resolve_cache should be selected. 


Setting the Log Level

The level at which you log messages has a direct effect on system performance. Each time a system event is logged, a small performance hit occurs. Logging messages of type SEVERE affects the system the least whereas logging at the INFO level can cause the system to slow down due to the sheer volume of messages that are written to the log. The effect that the logging level has on XperienCentral performance is indicated as follows.

...

For more information on logging events in XperienCentral, see the Log administrative page.

 


...

Creating Custom Performance Indicator Tabs

In addition to the four default tabs, you can develop and extend the XperienCentral Performance Dashboard using custom plugins. See Adding Custom Indicators to the Performance Dashboard.

 


Back to top