Applies to ReadyAPI 2.8, last modified on October 18, 2019
To monitor server metrics, you need a LoadUI Pro license.

In this tutorial, we will create a monitor for the server on the same computer, where ReadyAPI is running (that is, the localhost server will be monitored). In this case, there is no need to configure the server in a special way. You just need to ensure that the user account that runs the load test belongs to any of the following user groups on the local machine:

  • Performance Monitor Users

  • Performance Log Users

  • Administrators

Follow the steps described further in the topic to create a server monitor.

Requirements

To monitor server metrics, you need a LoadUI Pro license. If you do not have it, you can either request it on our web site or start a trial.

1. Prepare the Server for Monitoring

Before collecting server metrics, you need to prepare it for monitoring. See Preparing Servers for Monitoring for information on steps to perform.

2. Add Server

To create a server monitor, switch to the Monitoring page, and click on the toolbar.

API load testing with ReadyAPI: Add Server for Monitoring

Click the image to enlarge it.

The Add server dialog will appear. In this dialog:

  • Enter the server name to the Server Name field. This is the name that will be used in LoadUI, it may differ from the actual server name.

  • Enter the server address to the Host Name field. You can enter either the IP address, or the host name. In this tutorial, we will type localhost.

  • Enter the monitor name to the Monitor Name field. This is the name that will be used in LoadUI, it may differ from the monitor type.

Now, select the default monitor for your server. In this tutorial, we select Windows.

API load testing with ReadyAPI: The Add Server Dialog

If needed, specify connection properties.

Windows monitors use your Windows user account to access the remote machine, so just click OK. For details about connection properties, see Monitor Reference.

The created server will be marked with the connected symbol () if LoadUI successfully connected to it. If it is marked with the disconnected symbol (), check the connection properties and server settings and click Test Connection.

API load testing with ReadyAPI: Connected Server and Monitor
The name of the monitor must be unique within the server.

3. Add More Monitors

To monitor other metrics from your server, for example, the metrics from your database or HTTP server, add other monitors:

  • Click . The Add monitor window is shown. Select a different monitor type:

    API load testing with ReadyAPI: The Add Monitor Dialog
  • Specify the monitor connection properties. For details about connection properties, see Monitor Reference.

4. Configure Runtime Statistics

When you add a server, the default metrics are added to the Server Monitoring Chart. To see metrics, add metrics or remove the default ones, click in the Server Monitoring Chart panel. The Configure Server Monitoring Chart window is shown. To add a metric to the graph, find it in the tree and select the respective check box:

API load testing with ReadyAPI: Configure Server Monitoring Chart

Click the image to enlarge it.

Statistics are grouped by the server they monitor. If you monitor multiple servers, you can disable those that you do not need at the moment. Right now, you only have one server, so disabling it will remove all graphs from the chart.

LoadUI gathers all statistics for created monitors. You can see them after the test run on the Statistics page.

5. Start the Load Test

Click to start the load test. LoadUI will start simulating user requests and gathering performance metrics from the server. You can see gathered metrics in the Server Monitoring Chart section.

API load testing with ReadyAPI: The Server Monitoring Chart Section

Click the image to enlarge it.

6. View Statistics After the Test Run

Switch to the Statistics page. On this page, click the or button to add a new statistics group. When selecting statistics to display, you can choose the statistics from your server in the Server Monitors list.

API load testing with ReadyAPI: The Add Statistics Dialog

Click the image to enlarge it.

For detailed information on test results, see Viewing Test Results.

See Also

Preparing Servers for Monitoring
Monitor Reference
Statistics Page

Highlight search results