System Health: Request Profiler

The Request Profiler (SM205070) form is an embedded tool that you can use to troubleshoot performance-related issues in MYOB Advanced or an MYOB Advanced Framework-based application.

You use the Request Profiler (SM205070) form to do the following:

• Monitor the time and memory needed for any URL request performed in MYOB Advanced
• Analyze the time needed for any SQL query of the selected URL request
• Obtain information about the exceptions that have occurred in the MYOB Advanced instance, and view its traces

Default Monitoring

By default, only expensive requests and important exceptions are monitored in the system—that is, the Default Logging (Expensive Requests and Requests with Important Exceptions) check box is selected on the Request Profiler (SM205070) form, and the following check boxes are cleared:

• Log Requests (Apply Filter)
• Log SQL (Apply Filter)
• Log Exceptions
• Log Events (Apply Filter)

If the default settings are specified, the logged information is displayed on the Requests, SQL, and Exceptions tabs; the Event Log tab remains empty.

You can instead change the settings in the Summary area of the Request Profiler (SM205070) form to configure the logging requirements more precisely.

Troubleshooting of a Particular Process

If a particular process, such as the release or import of a document, takes more time than usual, you can troubleshoot the process by turning on the logging of URL requests, SQL queries, exceptions, and warnings and errors; this is done directly on the form where the process is initiated.

To turn on the logging, you click Tools > Profiler on the form title bar and click Start Logging in the Profiler dialog box. The Request Profiler (SM205070) form starts logging URL requests, SQL queries, exceptions, and warnings and errors.

You can import the ZIP archive to another MYOB Advanced instance by clicking Import on the form toolbar of the Request Profiler (SM205070) form and then reviewing the logged information.

Analysis of URL Requests

In the Request Logging section of the Request Profiler (SM205070) form, you can turn on the monitoring of URL requests by selecting the Log Requests (Apply Filter) check box. If only specific URL requests should be monitored, you can specify additional filtering criteria by using the other settings of this section in addition to selecting the check box. For example, to monitor only the long URL requests that need more than 1000 milliseconds to run, enter 1000 in the Server Time Threshold box of the Request Logging section of the Summary area. To monitor URL requests with 500 or more SQL requests, enter 500 in the SQL Count Threshold box of this section.

On the Requests tab, you can see only the completed requests. To view the requests that are currently executing, you can open the Requests in Progress tab of the System Monitor (SM201530) form. For the requests in progress, the same information is available as the information for the completed request on the Requests tab of the Request Profiler (SM205070) form.

Also, you can see all performance metrics related to a request-response cycle in a single and familiar place, such as the Developer Tools of the browser. For example, in Google Chrome, by using the Chrome Developer Tools, you can view the timing of MYOB Advanced processes. On the Network tab of Chrome Developer Tools, after you select an MYOB Advanced form, the Timing tab of the panel contains the time-related data of the server, as shown in the following screenshot.

Analysis of SQL Queries

If in the Summary area of the Request Profiler (SM205070) form, the Log Requests (Apply Filter) check box is selected in the Request Logging section, then you can also turn on the monitoring of SQL queries within the monitored URL requests. To do this, you select the Log SQL (Apply Filter) check box in the SQL Logging section.

If only specific SQL queries should be monitored, you can specify additional requirements by using the filtering settings of this section. For example, if the Include Cached SQL Results check box is selected, the system will include in the log SQL queries that obtain results from a query cache (that is, not from the database). If a keyword (such as a method name) is specified in the Executed by Method box, the system will include in the log only the SQL queries for which the stack trace includes this keyword.

The system displays the list of the logged SQL queries on the SQL tab of the form. On this tab, you can review the logged SQL queries that comply with the specified filters. The same SQL query may be triggered by multiple URL requests with different parameters. The table displays aggregated information for each query.

When you click a link in the Statement ID column for an SQL query listed on this tab, the system opens the SQL Details dialog box with detailed information about each execution of the SQL query.

You can export all SQL queries from the SQL tab to an Excel file by clicking Export to Excel on the table toolbar.

You can also analyze SQL queries in depth on the SQL Analysis (SM405000) inquiry form. You can use this form to review all information about executed SQL queries, export data to an Excel file, and build pivot tables and diagrams based on this data. The All Records tab of the form displays all information about executed SQL queries. For each record in the table, you can view SQL details and stack traces on the side panels.

Analysis of Exceptions

By selecting the Log Exceptions check box in the Exception Logging section of the Request Profiler (SM205070) form, you turn on the logging of exceptions. The system displays the list of the logged exceptions on the Exceptions tab of the form. On this tab, you can review the list of exceptions that have occurred during the processing of requests.

When you click an exception on this tab and then click View Exception Details on the table toolbar, the system opens the View Exception Details dialog box with detailed information about the selected exception.

You can export all exceptions from the Exceptions tab to an Excel file by clicking Export to Excel on the table toolbar.

Analysis of Events

By selecting the Log Events (Apply Filter) check box in the Event Logging section of the Summary area of the Request Profiler (SM205070) form, you can turn on the logging of events. You can specify a specific severity level of events in the Log Level box. (By default, Warning is selected, but this setting is not applied unless the Log Events (Apply Filter) check box is selected.) You can filter the events that the system should log by category by selecting one option or multiple options in the Category box. The system displays the list of the logged events on the Event Log tab of the form. By using this tab, you can review the list of events that occurred during request processing.

When you click an event on the tab and then click View Event Details on the table toolbar, the system opens the View Event Details dialog box with detailed information about the selected event.

Cluster Mode

The Request Profiler (SM205070) form works in cluster mode. When you run the profiler on a cluster, it launches on all nodes of the cluster. The profiler settings apply to each cluster node.

If you need to identify a cluster node for the URL request on the Request Profiler (SM205070) form, use the Headers column (which is hidden by default) of the Requests tab. In cluster mode, the column contains the GUID or the identifier of the cluster node.