Analyzing License Usage

Applies to ReadyAPI 3.5, last modified on December 29, 2020

The TestEngine license limits the maximum number of concurrently running test jobs. If this limit is exceeded, TestEngine puts the test jobs in a queue. This topic describes how to learn the number of queued and sent test jobs, how much time jobs spent in a queue before starting, and so on.

The following statistics are used to analyze the TestEngine usage:

  • Peak usage — the maximum number of running and queued test jobs for the specified time period.

  • Test jobs — the total number of running and queued test jobs for the specified time period.

  • Current test jobs — the number of running and queued test jobs at the current moment.

  • Wait time — the maximum and average time the test jobs were in a queue during the specified time period.

Get peak usage statistics

Peak usage statistics show how many tests were running simultaneously. TestEngine groups the statistics by hours.

Using API

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/peak[?from=date][&to=date]

from

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine peak usage statistics after this date and time will be retrieved.

Tip: Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

to

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine peak usage statistics before this date and time will be retrieved.

Tip: Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

Authentication

The request must be authenticated by a TestEngine user.

Example

Using Web UI

  1. Go to the home page of TestEngine:

    http://<testengine-host>:<port>/

    For example, if TestEngine is installed on your local machine, and you run it on the default port, use the following link:

  2. Go to Statistics:

    Peak usage statistics

    Click the image to enlarge it.

The top graph shows the peak usage statistics for the specified period of time. To select another time period, use the controls in the top-left corner:

TestEngine Statistics: Select time period

Click the image to enlarge it.

Get total usage statistics

The total usage statistics show the total number of running or queued test jobs for the specified period of time.

Using API

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/count[?from=date][&to=date]

from

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine usage statistics after this date and time will be retrieved.

Tip: Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

to

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine usage statistics before this date and time will be retrieved.

Tip: Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

Authentication

The request must be authenticated by a TestEngine user.

Example

Using Web UI

  1. Go to the home page of TestEngine:

    http://<testengine-host>:<port>/

    For example, if TestEngine is installed on your local machine and you run it on the default port, use the following link:

  2. Go to Statistics:

    Test jobs statistics

    Click the image to enlarge it.

The bottom graph shows the total number of the run and queued test jobs for the specified period of time. To select another time period, use the controls in the top-left corner:

TestEngine Statistics: Select time period

Click the image to enlarge it.

Get current usage

To learn how many tests are running or in a queue at the moment, do the following:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/current

Authentication

The request must be authenticated by a TestEngine user.

Example

Get waiting time

To get information on how long test jobs were in a queue (in milliseconds), run the following command:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/wait[?from=date][&to=date]

from

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, TestEngine returns the waiting time of the test jobs that were sent after this date and time.

Tip: Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

to

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, TestEngine returns the waiting time of the test jobs that were sent before this date and time.

Tip: Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

Authentication

The request must be authenticated by a TestEngine user.

Example

See Also

Activating TestEngine License
Deactivating TestEngine License

Highlight search results