4.11. SICS Performance Monitoring
Performance Monitoring Overview #
This function allows for monitoring of selected User Interface button clicks, menu item clicks and table row double clicks. SICS will measure and log the time from when the user clicks a configured option, to when SICS has completed processing.
SICS API Server web service calls can be monitored as well. SICS will measure and log the time from when the SOAP request arrives, to when SICS API Server has completed processing and returns a SOAP response.
The performance monitoring configuration is global and applies to all users of SICS (Server).
However, changes to the performance monitoring configuration made by the administrator from one SICS workstation, will not take effect for other users / SICS API Server until they perform a full refresh or restart SICS (Server).
The performance monitoring does not apply to SICS Scheduler, SICS Search Server or SICS eMessaging Server.
All runtime monitors will be stored in the database, and cached in memory at runtime.
Whenever a user action begins in SICS, the cache is consulted, the lookup should be instant.
If monitoring is enabled, a timer is started. When the action is complete, the following will be logged, using log4j:
<timestamp> Performance - <monitor name> <db schema name> <SICS UserId> <milliseconds>
The SICS logging system (log4j) can be configured to send this to a variety of destinations, flat file, database, windows event log, etc.
Manage Performance Monitors #
If the user has read access to one or several of the cases “Server Performance Monitor”, “Window Performance Monitor” or “Performance Monitor Configuration”, the help menu of each SICS Window will contain the option “Advanced Performance Monitoring..”. Selecting the menu option will open the SICS Performance Monitoring window.
Manage Performance Monitors for the current window #
If the user has read access to the security use case “Window Performance Monitor”, the window will contain a tab labeled “Window”. That tab will show a tree viewer with the user interface components of the window from which the performance monitor window was opened. A blue font color means that there is defined a performance monitor for that component, furthermore a clock icon means that the performance monitor is active. If a performance monitor is active SICS will measure the time from when the user clicks that option, to when SICS has completed processing and output that information to the SICS log. On the right hand side detail information for the selected monitor is shown. It contains a system defined Technical identifier and a user defined identifier for the monitor. The user defined identifier is intended to give an understandable name for the action. It is recommended to avoid white spaces characters in identifiers, in order to facilitate machine processing of performance log output. For some components there will be a button labeled “Show in Window” available. It may be used to highlight where the component is in the SICS window. For buttons it will give the button focus (blue edge around button edges) and for menu items the popup menu will be displayed.
In order to define performance monitors for SICS create or edit windows, the following procedure must be used:
- Open the SICS edit window.
- Open the Performance Monitoring Window
- Locate the components for which performance monitors should be defined
- Close the SICS edit window.
- Make desired changes to SICS performance editors and save.
Manage Performance Monitors for SICS API Server #
If the user has read access to the security use case “Server Performance Monitor”, the window will contain a tab labeled “SICS API Server”. This tab has the same contents regardless what window it is opened from. The contents have the same layout and functionality as in the “Window” tab. This tab makes it possible to define performance monitors for SICS API Server operations. When a performance monitor is enabled for a SICS API Server operation, performance figures for that operation will be written to the server log files.
Manage Performance Monitors for SICS API Server #
If the user has read access to the security use case " Performance Monitor Configuration", the window will contain a tab labeled “All Monitors”. In view mode a list of currently active monitors is shown. This includes monitors from all windows in the system. In edit mode it displays both active and inactive monitors, with arrows that allow the user to activate or inactive monitors. In addition there is a check box to enable or disable the entire performance monitoring system.
