Tracing

This document covers the following topics:


About the Tracing Tools

The tracing tools can be used to test the performance of a web application. First, you record a performance trace (that is, your interaction with the server), and then you execute the recorded performance trace in order to determine the amount of time that is required for processing the server requests.

Recording a Performance Trace

Performance traces are recorded using the Trace Start/Stop command.

Start of instruction setTo record a performance trace

  1. In the ProjectExplorer view, select the project for which you want to record a performance trace.

  2. Invoke the context menu and from the Ajax Developer menu, choose Trace Start/Stop.

    The following editor appears.

    Record trace

    The Trace Directory text box indicates the directory in which the traces will be stored. The name of this directory is defined in the file cisconfig.xml.

    Each trace is written into a separate subdirectory of the trace directory. The name of the subdirectory is determined by your specification in the Trace Name text box.

    Note:
    Make sure that the trace directory is available at the specified location. Otherwise, traces will not be written.

  3. Enter the name of a subdirectory in the Trace Name text box.

  4. Choose the Start Recording button.

    Additional information is now shown in the editor.

    Record trace

  5. In the Next Request's Comment text box, enter a comment name for the current trace.

    Using comment names, you can subdivide the trace into several sections. The comment name is used in the names of the files that are created for your server requests (see below).

  6. Choose the Set button.

    The comment name that you specified is shown below the Next Request's Comment text box.

  7. Initiate an interaction with the server.

    For example, open the Layout Painter, and then return to the trace editor.

    All requests (interactions with the server) that you initiate are recorded.

  8. Choose the Stop Recording button.

    The files that have been created for your requests are shown in the dialog. The comment name that you specified is part of the file name.

    Record trace

    If you want to remove one or more files from the list, select the file(s) and choose the Remove Selected Files button.

    You can add further requests to this trace by repeating the above steps.

Executing a Performance Trace

Recorded performance traces are executed using the Trace Execute command.

Start of instruction setTo execute a performance trace

  1. In the ProjectExplorer view, select the project for which you want to execute a performance trace.

  2. Invoke the context menu and from the Ajax Developer menu, choose Trace Execute.

    The following editor appears.

    Execute trace

    The Trace Directory text box indicates the directory in which the tool looks for the recorded traces.

  3. Specify the following information:

    Trace Name

    Select the name of the subdirectory which contains the recorded traces for your server requests.

    Host to put load on

    Enter the URL of the host on which you want to execute the trace.

    Repeat trace ... times

    Enter the number of times that the trace is to be repeated.

    For all defined repetitions, the average process time (in milliseconds) will be shown in the request statistics (see below). The more repetitions you define, the more conclusive is the resulting average value.

    Wait ... ms between requests

    Enter the waiting time between the requests in milliseconds.

    Parallel trace threads

    Enter the number of parallel trace threads. This simulates the number of users that access the web application at the same time.

    Wait ... ms between thread start

    Often you do not want all threads to be started at the same time because this does not match the real scenario in a production environment. Instead, you would like to start the threads one after another with some waiting time in between. For the waiting time, you can specify a fixed value or a range of values. If you specify a range of values, a random number which is in the specified range is used for the waiting time.

  4. Choose the Execute button.

  5. Choose the Refresh View button to display the request statistics at the bottom of the dialog.

    Information on the requests is now shown in the Request Statistics section:

    Request statistics

    The first small table indicates the current number of unfinished and finished trace threads.

    The second table provides a statistical evaluation of the executed requests. The following information is provided for each request: the number of calls, the number of successful executions, the number of errors, the average process time for all calls (duration), the minimum process time for a call, and the maximum process time for a call. The times are given in milliseconds.

    In the case of an error, an additional table is shown which provides details on the error.

    You can choose the following button in the Request Statistics section to display the request statistics in PDF:

    PDF

    The trace result is stored in a CSV file. The path to this file is indicated at the bottom of the dialog.